Network Security Perimeter Configurations - Get

Referência

Serviço:: Search Management

Versão da API:: 2024-03-01-preview

Obtém uma configuração de perímetro de segurança de rede.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
nspConfigName	path	True	string	O nome da configuração de segurança de rede. Padrão Regex: `^[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	O nome do grupo de recursos dentro da assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
searchServiceName	path	True	string	O nome do serviço Pesquisa de IA do Azure associado ao grupo de recursos especificado. Padrão Regex: `^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$`
subscriptionId	path	True	string	O identificador exclusivo de uma assinatura do Microsoft Azure. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
api-version	query	True	string	A versão da API a ser usada para cada solicitação.

Respostas

Nome	Tipo	Description
200 OK	NetworkSecurityPerimeterConfiguration	A configuração foi recuperada com êxito.
Other Status Codes	CloudError	Erro inesperado durante operação.

Segurança

azure_auth

Especifica um fluxo de concessão implícito, conforme suportado na plataforma do Microsoft Identity.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get an NSP config by name

Solicitação de exemplo

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1?api-version=2024-03-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-03-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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-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-03-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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Search;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/NetworkSecurityPerimeterConfigurationsGet.json
// this example is just showing the usage of "NetworkSecurityPerimeterConfigurations_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this NetworkSecurityPerimeterConfigurationResource created on azure
// for more information of creating NetworkSecurityPerimeterConfigurationResource, please refer to the document of NetworkSecurityPerimeterConfigurationResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
string nspConfigName = "00000001-2222-3333-4444-111144444444.assoc1";
ResourceIdentifier networkSecurityPerimeterConfigurationResourceId = NetworkSecurityPerimeterConfigurationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName, nspConfigName);
NetworkSecurityPerimeterConfigurationResource networkSecurityPerimeterConfiguration = client.GetNetworkSecurityPerimeterConfigurationResource(networkSecurityPerimeterConfigurationResourceId);

// invoke the operation
NetworkSecurityPerimeterConfigurationResource result = await networkSecurityPerimeterConfiguration.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
NetworkSecurityPerimeterConfigurationData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Resposta de exemplo

Código de status:: 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"
            ]
          }
        }
      ]
    }
  }
}

Definições

Nome	Description
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
NetworkSecurityPerimeterConfiguration	Configuração de perímetro de segurança de rede para um servidor.
NSPConfigAccessRule	Uma regra de acesso para uma configuração de perímetro de segurança de rede.
NSPConfigAccessRuleProperties	As propriedades das regras de acesso em uma configuração de perímetro de segurança de rede.
NSPConfigAssociation	A associação de recursos para o perímetro de segurança de rede.
NSPConfigNetworkSecurityPerimeterRule	As propriedades de perímetro de segurança de rede presentes em uma regra de configuração.
NSPConfigPerimeter	O perímetro de uma configuração de perímetro de segurança de rede.
NSPConfigProfile	O perfil para uma configuração de perímetro de segurança de rede.
NSPProvisioningIssue	Um objeto para descrever quaisquer problemas com o provisionamento de perímetros de segurança de rede para um serviço de pesquisa.
NSPProvisioningIssueProperties	As propriedades para descrever quaisquer problemas com o provisionamento de perímetros de segurança de rede para um serviço de pesquisa.

CloudError

Contém informações sobre um erro de API.

Nome	Tipo	Description
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
message	string	Uma breve descrição do erro que indica o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

Descreve um erro de API específico com um código de erro e uma mensagem.

Nome	Tipo	Description
code	string	Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados a esse erro.
message	string	Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

NetworkSecurityPerimeterConfiguration

Configuração de perímetro de segurança de rede para um servidor.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.networkSecurityPerimeter	NSPConfigPerimeter	O perímetro de uma configuração de perímetro de segurança de rede.
properties.profile	NSPConfigProfile	O perfil para uma configuração de perímetro de segurança de rede.
properties.provisioningIssues	NSPProvisioningIssue[]	Um objeto para descrever quaisquer problemas com o provisionamento de perímetros de segurança de rede para um serviço de pesquisa.
properties.provisioningState	string
properties.resourceAssociation	NSPConfigAssociation	A associação de recursos para o perímetro de segurança de rede.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

NSPConfigAccessRule

Uma regra de acesso para uma configuração de perímetro de segurança de rede.

Nome	Tipo	Description
name	string
properties	NSPConfigAccessRuleProperties	As propriedades das regras de acesso em uma configuração de perímetro de segurança de rede.

NSPConfigAccessRuleProperties

As propriedades das regras de acesso em uma configuração de perímetro de segurança de rede.

Nome	Tipo	Description
addressPrefixes	string[]
direction	string
fullyQualifiedDomainNames	string[]
networkSecurityPerimeters	NSPConfigNetworkSecurityPerimeterRule[]	As propriedades de perímetro de segurança de rede presentes em uma regra de configuração.
subscriptions	string[]

NSPConfigAssociation

A associação de recursos para o perímetro de segurança de rede.

Nome	Tipo	Description
accessMode	string
name	string

NSPConfigNetworkSecurityPerimeterRule

As propriedades de perímetro de segurança de rede presentes em uma regra de configuração.

Nome	Tipo	Description
id	string
location	string
perimeterGuid	string

NSPConfigPerimeter

O perímetro de uma configuração de perímetro de segurança de rede.

Nome	Tipo	Description
id	string
location	string
perimeterGuid	string

NSPConfigProfile

O perfil para uma configuração de perímetro de segurança de rede.

Nome	Tipo	Description
accessRules	NSPConfigAccessRule[]	Uma regra de acesso para uma configuração de perímetro de segurança de rede.
accessRulesVersion	string
name	string

NSPProvisioningIssue

Um objeto para descrever quaisquer problemas com o provisionamento de perímetros de segurança de rede para um serviço de pesquisa.

Nome	Tipo	Description
name	string
properties	NSPProvisioningIssueProperties	As propriedades para descrever quaisquer problemas com o provisionamento de perímetros de segurança de rede para um serviço de pesquisa.

NSPProvisioningIssueProperties

As propriedades para descrever quaisquer problemas com o provisionamento de perímetros de segurança de rede para um serviço de pesquisa.

Nome	Tipo	Description
description	string
issueType	string
severity	string
suggestedAccessRules	string[]
suggestedResourceIds	string[]

Compartilhar via

Network Security Perimeter Configurations - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Get an NSP config by name

Solicitação de exemplo

Resposta de exemplo

Definições

CloudError

CloudErrorBody

NetworkSecurityPerimeterConfiguration

NSPConfigAccessRule

NSPConfigAccessRuleProperties

NSPConfigAssociation

NSPConfigNetworkSecurityPerimeterRule

NSPConfigPerimeter

NSPConfigProfile

NSPProvisioningIssue

NSPProvisioningIssueProperties

Recursos adicionais