Network Security Perimeter Configurations - Get

Başvuru

Hizmet:: Search Management

API Sürümü:: 2024-06-01-preview

Ağ güvenlik çevresi yapılandırmasını alır.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/networkSecurityPerimeterConfigurations/{nspConfigName}?api-version=2024-06-01-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
nspConfigName	path	True	string	Ağ güvenliği yapılandırma adı. Normal ifade deseni: `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\.[a-z][a-z0-9]*$`
resourceGroupName	path	True	string	Geçerli abonelik içindeki kaynak grubunun adı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz.
searchServiceName	path	True	string	Belirtilen kaynak grubuyla ilişkili Azure AI Search hizmetinin adı. Normal ifade deseni: `^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$`
subscriptionId	path	True	string	Microsoft Azure aboneliğinin benzersiz tanımlayıcısı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz.
api-version	query	True	string	Her istek için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	NetworkSecurityPerimeterConfiguration	Yapılandırma başarıyla alındı.
Other Status Codes	CloudError	İşlem sırasında beklenmeyen bir hata oluştu.

Güvenlik

azure_auth

Microsoft Identity platformunda desteklendiği gibi örtük bir izin akışı belirtir.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Get an NSP config by name

Örnek isteği

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1?api-version=2024-06-01-preview

from azure.identity import DefaultAzureCredential

from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python network_security_perimeter_configurations_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SearchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.network_security_perimeter_configurations.get(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
        nsp_config_name="00000001-2222-3333-4444-111144444444.assoc1",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-06-01-preview/examples/NetworkSecurityPerimeterConfigurationsGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f6f50c6388fd5836fa142384641b8353a99874ef/specification/search/resource-manager/Microsoft.Search/preview/2024-06-01-preview/examples/NetworkSecurityPerimeterConfigurationsGet.json
func ExampleNetworkSecurityPerimeterConfigurationsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewNetworkSecurityPerimeterConfigurationsClient().Get(ctx, "rg1", "mysearchservice", "00000001-2222-3333-4444-111144444444.assoc1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.NetworkSecurityPerimeterConfiguration = armsearch.NetworkSecurityPerimeterConfiguration{
	// 	Name: to.Ptr("00000001-2222-3333-4444-111144444444.assoc1"),
	// 	Type: to.Ptr("Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1"),
	// 	Properties: &armsearch.NetworkSecurityPerimeterConfigurationProperties{
	// 		NetworkSecurityPerimeter: &armsearch.NSPConfigPerimeter{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1"),
	// 			Location: to.Ptr("westus"),
	// 		},
	// 		Profile: &armsearch.NSPConfigProfile{
	// 			Name: to.Ptr("profile1"),
	// 			AccessRules: []*armsearch.NSPConfigAccessRule{
	// 				{
	// 					Name: to.Ptr("rule1"),
	// 					Properties: &armsearch.NSPConfigAccessRuleProperties{
	// 						AddressPrefixes: []*string{
	// 							to.Ptr("148.0.0.0/8"),
	// 							to.Ptr("152.4.6.0/24")},
	// 							Direction: to.Ptr("Inbound"),
	// 						},
	// 				}},
	// 				AccessRulesVersion: to.Ptr("0"),
	// 			},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			ResourceAssociation: &armsearch.NSPConfigAssociation{
	// 				Name: to.Ptr("assoc1"),
	// 				AccessMode: to.Ptr("Enforced"),
	// 			},
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a network security perimeter configuration.
 *
 * @summary Gets a network security perimeter configuration.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-06-01-preview/examples/NetworkSecurityPerimeterConfigurationsGet.json
 */
async function getAnNspConfigByName() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const nspConfigName = "00000001-2222-3333-4444-111144444444.assoc1";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.networkSecurityPerimeterConfigurations.get(
    resourceGroupName,
    searchServiceName,
    nspConfigName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Örnek yanıt

Durum kodu:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1",
  "name": "00000001-2222-3333-4444-111144444444.assoc1",
  "type": "Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations",
  "properties": {
    "provisioningState": "Accepted",
    "networkSecurityPerimeter": {
      "id": "/subscriptions/subid/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1",
      "location": "westus"
    },
    "resourceAssociation": {
      "name": "assoc1",
      "accessMode": "Enforced"
    },
    "profile": {
      "name": "profile1",
      "accessRulesVersion": "0",
      "accessRules": [
        {
          "name": "rule1",
          "properties": {
            "direction": "Inbound",
            "addressPrefixes": [
              "148.0.0.0/8",
              "152.4.6.0/24"
            ]
          }
        }
      ]
    }
  }
}

Tanımlar

Name	Description
CloudError	API hatası hakkında bilgi içerir.
CloudErrorBody	Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
NetworkSecurityPerimeterConfiguration	Bir sunucu için ağ güvenliği çevre yapılandırması.
NSPConfigAccessRule	Ağ güvenliği çevre yapılandırması için erişim kuralı.
NSPConfigAccessRuleProperties	Ağ güvenlik çevre yapılandırmasındaki erişim kurallarının özellikleri.
NSPConfigAssociation	Ağ güvenlik çevresi için kaynak ilişkisi.
NSPConfigNetworkSecurityPerimeterRule	Yapılandırma kuralında bulunan ağ güvenlik çevresi özellikleri.
NSPConfigPerimeter	Ağ güvenliği çevre yapılandırması için çevre.
NSPConfigProfile	Ağ güvenlik çevre yapılandırması için profil.
NSPProvisioningIssue	Bir arama hizmetine ağ güvenlik çevreleri sağlamayla ilgili sorunları açıklayan bir nesne.
NSPProvisioningIssueProperties	Bir arama hizmetine ağ güvenlik çevreleri sağlamayla ilgili sorunları açıklayan özellikler.

CloudError

API hatası hakkında bilgi içerir.

Name	Tür	Description
error	CloudErrorBody	Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
message	string	Neyin yanlış gittiğini gösteren hatanın kısa bir açıklaması (ayrıntılar/hata ayıklama bilgileri için 'error.message' özelliğine bakın).

CloudErrorBody

Hata kodu ve ileti içeren belirli bir API hatası açıklanır.

Name	Tür	Description
code	string	Http durum kodundan daha kesin bir şekilde hata koşulunu açıklayan bir hata kodu. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
details	CloudErrorBody[]	Bu hatayla ilgili iç içe hatalar içerir.
message	string	Hatayı ayrıntılı olarak açıklayan ve hata ayıklama bilgileri sağlayan bir ileti.
target	string	Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı).