Network Security Perimeter Configurations - List

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-10-01

Pobiera listę konfiguracji NSP dla konta.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Nazwa konta usług Cognitive Services.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	NetworkSecurityPerimeterConfigurationList	Pomyślnie pobrano listę konfiguracji.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Przykłady

ListNetworkSecurityPerimeterConfigurations

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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"
                ]
              }
            }
          ]
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
NetworkSecurityPerimeter	Informacje o połączonym obwodzie zabezpieczeń sieci
NetworkSecurityPerimeterAccessRule	Reguła dostępu obwodowego zabezpieczeń sieci
NetworkSecurityPerimeterAccessRuleProperties	Właściwości reguły obwodowej zabezpieczeń sieci
NetworkSecurityPerimeterConfiguration	Konfiguracja NSP dla konta usług Cognitive Services.
NetworkSecurityPerimeterConfigurationAssociationInfo	Informacje o skojarzeniu konfiguracji obwodowej zabezpieczeń sieci
NetworkSecurityPerimeterConfigurationList	Lista konfiguracji NSP dla konta usług Cognitive Services.
NetworkSecurityPerimeterConfigurationProperties	Właściwości konfiguracji NSP.
NetworkSecurityPerimeterProfileInfo	Informacje o profilu obwodowym zabezpieczeń sieci
NspAccessRuleDirection	Kierunek reguły dostępu
ProvisioningIssue
ProvisioningIssueProperties	Właściwości problemu z aprowizowaniem
Subscriptions	Subskrypcje dla reguł ruchu przychodzącego

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

NetworkSecurityPerimeter

Objekt

Informacje o połączonym obwodzie zabezpieczeń sieci

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu
location	string	Lokalizacja zasobu
perimeterGuid	string	Identyfikator GUID zasobu

NetworkSecurityPerimeterAccessRule

Objekt

Reguła dostępu obwodowego zabezpieczeń sieci

Nazwa	Typ	Opis
name	string	Nazwa reguły dostępu obwodowego zabezpieczeń sieci
properties	NetworkSecurityPerimeterAccessRuleProperties	Właściwości reguły dostępu obwodowego zabezpieczeń sieci

NetworkSecurityPerimeterAccessRuleProperties

Objekt

Właściwości reguły obwodowej zabezpieczeń sieci

Nazwa	Typ	Opis
addressPrefixes	string[]	Prefiksy adresów dla reguł ruchu przychodzącego
direction	NspAccessRuleDirection	Kierunek reguły dostępu
fullyQualifiedDomainNames	string[]	W pełni kwalifikowana nazwa domeny dla reguł ruchu wychodzącego
networkSecurityPerimeters	NetworkSecurityPerimeter[]	NetworkSecurityPerimeters dla reguł ruchu przychodzącego
subscriptions	Subscriptions[]	Subskrypcje dla reguł ruchu przychodzącego

NetworkSecurityPerimeterConfiguration

Objekt

Konfiguracja NSP dla konta usług Cognitive Services.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties	NetworkSecurityPerimeterConfigurationProperties	Właściwości konfiguracji NSP.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationAssociationInfo

Objekt

Informacje o skojarzeniu konfiguracji obwodowej zabezpieczeń sieci

Nazwa	Typ	Opis
accessMode	string	Tryb dostępu skojarzenia zasobu
name	string	Nazwa skojarzenia zasobu

NetworkSecurityPerimeterConfigurationList

Objekt

Lista konfiguracji NSP dla konta usług Cognitive Services.

Nazwa	Typ	Opis
nextLink	string	Łącze, aby pobrać następną stronę wyników.
value	NetworkSecurityPerimeterConfiguration[]	Tablica wyników listy konfiguracji NSP dla konta usług Cognitive Services.

NetworkSecurityPerimeterConfigurationProperties

Objekt

Właściwości konfiguracji NSP.

Nazwa	Typ	Opis
networkSecurityPerimeter	NetworkSecurityPerimeter	Informacje o połączonym obwodzie zabezpieczeń sieci
profile	NetworkSecurityPerimeterProfileInfo	Informacje o profilu obwodowym zabezpieczeń sieci
provisioningIssues	ProvisioningIssue[]	Lista problemów z aprowizowaniem
provisioningState	string	Stan aprowizacji konfiguracji NetworkSecurityPerimeter
resourceAssociation	NetworkSecurityPerimeterConfigurationAssociationInfo	Informacje o skojarzeniu konfiguracji obwodowej zabezpieczeń sieci

NetworkSecurityPerimeterProfileInfo

Objekt

Informacje o profilu obwodowym zabezpieczeń sieci

Nazwa	Typ	Opis
accessRules	NetworkSecurityPerimeterAccessRule[]	Reguła dostępu obwodowego zabezpieczeń sieci
accessRulesVersion	integer (int64)	Wersja reguł dostępu profilu zasobu
diagnosticSettingsVersion	integer (int64)	Bieżąca wersja ustawień diagnostycznych
enabledLogCategories	string[]	Lista kategorii dzienników z włączoną obsługą
name	string	Nazwa profilu zasobu

NspAccessRuleDirection

Wyliczanie

Kierunek reguły dostępu

Wartość	Opis
Inbound
Outbound

ProvisioningIssue

Objekt

Nazwa	Typ	Opis
name	string	Nazwa problemu z aprowizowaniem NSP
properties	ProvisioningIssueProperties	Właściwości problemu z aprowizowaniem

ProvisioningIssueProperties

Objekt

Właściwości problemu z aprowizowaniem

Nazwa	Typ	Opis
description	string	Opis problemu
issueType	string	Typ problemu
severity	string	Ważność problemu
suggestedAccessRules	NetworkSecurityPerimeterAccessRule[]	Opcjonalna tablica, sugerowane reguły dostępu
suggestedResourceIds	string[] (arm-id)	Identyfikatory zasobów, które mogą być skojarzone z tym samym obwodem w celu rozwiązania problemu.

Subscriptions

Objekt

Subskrypcje dla reguł ruchu przychodzącego

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator subskrypcji