Network Security Perimeter Configurations - List

Serviço:

Azure AI Services

Versão da API:

2024-10-01

Obtém uma lista de configurações de NSP para uma conta.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations?api-version=2024-10-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	O nome da conta dos Serviços Cognitivos.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	NetworkSecurityPerimeterConfigurationList	Recuperou com êxito a lista de configurações.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Exemplos

ListNetworkSecurityPerimeterConfigurations

Solicitação de exemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations?api-version=2024-10-01

Java

/**
 * Samples for NetworkSecurityPerimeterConfigurations List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * ListNetworkSecurityPerimeterConfigurations.json
     */
    /**
     * Sample code: ListNetworkSecurityPerimeterConfigurations.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void listNetworkSecurityPerimeterConfigurations(
        com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.networkSecurityPerimeterConfigurations().list("resourceGroupName", "accountName",
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python list_network_security_perimeter_configurations.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 = CognitiveServicesManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.network_security_perimeter_configurations.list(
        resource_group_name="resourceGroupName",
        account_name="accountName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListNetworkSecurityPerimeterConfigurations.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

Go

package armcognitiveservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cognitiveservices/armcognitiveservices"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListNetworkSecurityPerimeterConfigurations.json
func ExampleNetworkSecurityPerimeterConfigurationsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcognitiveservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewNetworkSecurityPerimeterConfigurationsClient().NewListPager("resourceGroupName", "accountName", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.NetworkSecurityPerimeterConfigurationList = armcognitiveservices.NetworkSecurityPerimeterConfigurationList{
		// 	Value: []*armcognitiveservices.NetworkSecurityPerimeterConfiguration{
		// 		{
		// 			Name: to.Ptr("networkSecurityPerimeterConfigurationName"),
		// 			Type: to.Ptr("Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations"),
		// 			Properties: &armcognitiveservices.NetworkSecurityPerimeterConfigurationProperties{
		// 				NetworkSecurityPerimeter: &armcognitiveservices.NetworkSecurityPerimeter{
		// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter"),
		// 					Location: to.Ptr("East US"),
		// 					PerimeterGUID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				},
		// 				Profile: &armcognitiveservices.NetworkSecurityPerimeterProfileInfo{
		// 					Name: to.Ptr("profileName"),
		// 					AccessRules: []*armcognitiveservices.NetworkSecurityPerimeterAccessRule{
		// 						{
		// 							Name: to.Ptr("ruleName"),
		// 							Properties: &armcognitiveservices.NetworkSecurityPerimeterAccessRuleProperties{
		// 								AddressPrefixes: []*string{
		// 									to.Ptr("148.0.0.0/8"),
		// 									to.Ptr("152.4.6.0/24")},
		// 									Direction: to.Ptr(armcognitiveservices.NspAccessRuleDirectionInbound),
		// 								},
		// 						}},
		// 						AccessRulesVersion: to.Ptr[int64](1),
		// 					},
		// 					ProvisioningState: to.Ptr("Succeeded"),
		// 					ResourceAssociation: &armcognitiveservices.NetworkSecurityPerimeterConfigurationAssociationInfo{
		// 						Name: to.Ptr("associationName"),
		// 						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

JavaScript

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

/**
 * This sample demonstrates how to Gets a list of NSP configurations for an account.
 *
 * @summary Gets a list of NSP configurations for an account.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListNetworkSecurityPerimeterConfigurations.json
 */
async function listNetworkSecurityPerimeterConfigurations() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "resourceGroupName";
  const accountName = "accountName";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.networkSecurityPerimeterConfigurations.list(
    resourceGroupName,
    accountName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

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

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListNetworkSecurityPerimeterConfigurations.json
// this example is just showing the usage of "NetworkSecurityPerimeterConfigurations_List" 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 CognitiveServicesAccountResource created on azure
// for more information of creating CognitiveServicesAccountResource, please refer to the document of CognitiveServicesAccountResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "resourceGroupName";
string accountName = "accountName";
ResourceIdentifier cognitiveServicesAccountResourceId = CognitiveServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
CognitiveServicesAccountResource cognitiveServicesAccount = client.GetCognitiveServicesAccountResource(cognitiveServicesAccountResourceId);

// get the collection of this NetworkSecurityPerimeterConfigurationResource
NetworkSecurityPerimeterConfigurationCollection collection = cognitiveServicesAccount.GetNetworkSecurityPerimeterConfigurations();

// invoke the operation and iterate over the result
await foreach (NetworkSecurityPerimeterConfigurationResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations",
      "name": "networkSecurityPerimeterConfigurationName",
      "type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations",
      "properties": {
        "provisioningState": "Succeeded",
        "networkSecurityPerimeter": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter",
          "perimeterGuid": "00000000-0000-0000-0000-000000000000",
          "location": "East US"
        },
        "resourceAssociation": {
          "name": "associationName",
          "accessMode": "Enforced"
        },
        "profile": {
          "name": "profileName",
          "accessRulesVersion": 1,
          "accessRules": [
            {
              "name": "ruleName",
              "properties": {
                "direction": "Inbound",
                "addressPrefixes": [
                  "148.0.0.0/8",
                  "152.4.6.0/24"
                ]
              }
            }
          ]
        }
      }
    }
  ]
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
NetworkSecurityPerimeter	Informações sobre um perímetro de segurança de rede vinculado
NetworkSecurityPerimeterAccessRule	Regra de acesso de perímetro de segurança de rede
NetworkSecurityPerimeterAccessRuleProperties	As propriedades da regra de perímetro de segurança de rede
NetworkSecurityPerimeterConfiguration	Configuração de NSP para uma conta dos Serviços Cognitivos.
NetworkSecurityPerimeterConfigurationAssociationInfo	Informações da Associação de Configuração de Perímetro de Segurança de Rede
NetworkSecurityPerimeterConfigurationList	Uma lista de configurações de NSP para uma conta dos Serviços Cognitivos.
NetworkSecurityPerimeterConfigurationProperties	As propriedades de uma configuração NSP.
NetworkSecurityPerimeterProfileInfo	Informações de perfil de perímetro de segurança de rede
NspAccessRuleDirection	Direção da regra de acesso
ProvisioningIssue
ProvisioningIssueProperties	Propriedades do problema de provisionamento
Subscriptions	Assinaturas para regras de entrada

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

NetworkSecurityPerimeter

Objeto

Informações sobre um perímetro de segurança de rede vinculado

Nome	Tipo	Description
id	string (arm-id)	Identificador totalmente qualificado do recurso
location	string	Local do recurso
perimeterGuid	string	Guid do recurso

NetworkSecurityPerimeterAccessRule

Objeto

Regra de acesso de perímetro de segurança de rede

Nome	Tipo	Description
name	string	Nome da regra de acesso do perímetro de segurança de rede
properties	NetworkSecurityPerimeterAccessRuleProperties	Propriedades da regra de acesso de perímetro de segurança de rede

NetworkSecurityPerimeterAccessRuleProperties

Objeto

As propriedades da regra de perímetro de segurança de rede

Nome	Tipo	Description
addressPrefixes	string[]	Prefixos de endereço para regras de entrada
direction	NspAccessRuleDirection	Direção da regra de acesso
fullyQualifiedDomainNames	string[]	Nome de domínio totalmente qualificado para regras de saída
networkSecurityPerimeters	NetworkSecurityPerimeter[]	NetworkSecurityPerimeters para regras de entrada
subscriptions	Subscriptions[]	Assinaturas para regras de entrada

NetworkSecurityPerimeterConfiguration

Objeto

Configuração de NSP para uma conta dos Serviços Cognitivos.

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	NetworkSecurityPerimeterConfigurationProperties	Propriedades de Configuração do NSP.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationAssociationInfo

Objeto

Informações da Associação de Configuração de Perímetro de Segurança de Rede

Nome	Tipo	Description
accessMode	string	Modo de Acesso da associação de recursos
name	string	Nome da associação de recursos

NetworkSecurityPerimeterConfigurationList

Objeto

Uma lista de configurações de NSP para uma conta dos Serviços Cognitivos.

Nome	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	NetworkSecurityPerimeterConfiguration[]	Matriz de configurações NSP Listar Resultado de uma conta dos Serviços Cognitivos.

NetworkSecurityPerimeterConfigurationProperties

Objeto

As propriedades de uma configuração NSP.

Nome	Tipo	Description
networkSecurityPerimeter	NetworkSecurityPerimeter	Informações sobre um perímetro de segurança de rede vinculado
profile	NetworkSecurityPerimeterProfileInfo	Informações de perfil de perímetro de segurança de rede
provisioningIssues	ProvisioningIssue[]	Lista de problemas de provisionamento
provisioningState	string	Estado de provisionamento da configuração de NetworkSecurityPerimeter
resourceAssociation	NetworkSecurityPerimeterConfigurationAssociationInfo	Informações da Associação de Configuração de Perímetro de Segurança de Rede

NetworkSecurityPerimeterProfileInfo

Objeto

Informações de perfil de perímetro de segurança de rede

Nome	Tipo	Description
accessRules	NetworkSecurityPerimeterAccessRule[]	Regra de acesso de perímetro de segurança de rede
accessRulesVersion	integer (int64)	Versão de regras de acesso do perfil de recurso
diagnosticSettingsVersion	integer (int64)	Versão atual das configurações de diagnóstico
enabledLogCategories	string[]	Lista de categorias de log habilitadas
name	string	Nome do perfil de recurso

NspAccessRuleDirection

Enumeração

Direção da regra de acesso

Valor	Description
Inbound
Outbound

ProvisioningIssue

Objeto

Nome	Tipo	Description
name	string	Nome do problema de provisionamento NSP
properties	ProvisioningIssueProperties	Propriedades do problema de provisionamento

ProvisioningIssueProperties

Objeto

Propriedades do problema de provisionamento

Nome	Tipo	Description
description	string	Descrição do problema
issueType	string	Tipo de problema
severity	string	Gravidade do problema
suggestedAccessRules	NetworkSecurityPerimeterAccessRule[]	Matriz opcional, regras de acesso sugeridas
suggestedResourceIds	string[] (arm-id)	IDs de recursos que podem ser associados ao mesmo perímetro para corrigir o problema.

Subscriptions

Objeto

Assinaturas para regras de entrada

Nome	Tipo	Description
id	string	Identificador totalmente qualificado da assinatura