Network Security Perimeter Configurations - List

Service:

Azure AI Services

API-versie:

2024-10-01

Hiermee haalt u een lijst met NSP-configuraties voor een account op.

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

URI-parameters

Name	In	Vereist	Type	Description
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	De naam van het Cognitive Services-account.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	NetworkSecurityPerimeterConfigurationList	De lijst met configuraties is opgehaald.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Voorbeelden

ListNetworkSecurityPerimeterConfigurations

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
NetworkSecurityPerimeter	Informatie over een gekoppelde netwerkbeveiligingsperimeter
NetworkSecurityPerimeterAccessRule	Netwerkbeveiligingsregel voor perimetertoegang
NetworkSecurityPerimeterAccessRuleProperties	De eigenschappen van de perimeterregel voor netwerkbeveiliging
NetworkSecurityPerimeterConfiguration	NSP-configuratie voor een Cognitive Services-account.
NetworkSecurityPerimeterConfigurationAssociationInfo	Informatie over de netwerkbeveiligingsperimeterconfiguratiekoppeling
NetworkSecurityPerimeterConfigurationList	Een lijst met NSP-configuraties voor een Cognitive Services-account.
NetworkSecurityPerimeterConfigurationProperties	De eigenschappen van een NSP-configuratie.
NetworkSecurityPerimeterProfileInfo	Netwerkbeveiligingsperimeterprofielgegevens
NspAccessRuleDirection	Richting van toegangsregel
ProvisioningIssue
ProvisioningIssueProperties	Eigenschappen van inrichtingsprobleem
Subscriptions	Abonnementen voor binnenkomende regels

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

NetworkSecurityPerimeter

Object

Informatie over een gekoppelde netwerkbeveiligingsperimeter

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde id van de resource
location	string	Locatie van de resource
perimeterGuid	string	Guid van de resource

NetworkSecurityPerimeterAccessRule

Object

Netwerkbeveiligingsregel voor perimetertoegang

Name	Type	Description
name	string	Naam van netwerkbeveiligingsperimetertoegangsregel
properties	NetworkSecurityPerimeterAccessRuleProperties	Eigenschappen van netwerkbeveiligingsregel voor perimetertoegang

NetworkSecurityPerimeterAccessRuleProperties

Object

De eigenschappen van de perimeterregel voor netwerkbeveiliging

Name	Type	Description
addressPrefixes	string[]	Adresvoorvoegsels voor binnenkomende regels
direction	NspAccessRuleDirection	Richting van toegangsregel
fullyQualifiedDomainNames	string[]	Volledig gekwalificeerde domeinnaam voor uitgaande regels
networkSecurityPerimeters	NetworkSecurityPerimeter[]	NetworkSecurityPerimeters voor binnenkomende regels
subscriptions	Subscriptions[]	Abonnementen voor binnenkomende regels

NetworkSecurityPerimeterConfiguration

Object

NSP-configuratie voor een Cognitive Services-account.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties	NetworkSecurityPerimeterConfigurationProperties	NSP-configuratie-eigenschappen.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

NetworkSecurityPerimeterConfigurationAssociationInfo

Object

Informatie over de netwerkbeveiligingsperimeterconfiguratiekoppeling

Name	Type	Description
accessMode	string	Toegangsmodus van de resourcekoppeling
name	string	Naam van de resourcekoppeling

NetworkSecurityPerimeterConfigurationList

Object

Een lijst met NSP-configuraties voor een Cognitive Services-account.

Name	Type	Description
nextLink	string	Koppeling om de volgende pagina met resultaten op te halen.
value	NetworkSecurityPerimeterConfiguration[]	Matrix van NSP-configuraties Lijstresultaat voor een Cognitive Services-account.

NetworkSecurityPerimeterConfigurationProperties

Object

De eigenschappen van een NSP-configuratie.

Name	Type	Description
networkSecurityPerimeter	NetworkSecurityPerimeter	Informatie over een gekoppelde netwerkbeveiligingsperimeter
profile	NetworkSecurityPerimeterProfileInfo	Netwerkbeveiligingsperimeterprofielgegevens
provisioningIssues	ProvisioningIssue[]	Lijst met inrichtingsproblemen
provisioningState	string	Inrichtingsstatus van de configuratie van NetworkSecurityPerimeter
resourceAssociation	NetworkSecurityPerimeterConfigurationAssociationInfo	Informatie over de netwerkbeveiligingsperimeterconfiguratiekoppeling

NetworkSecurityPerimeterProfileInfo

Object

Netwerkbeveiligingsperimeterprofielgegevens

Name	Type	Description
accessRules	NetworkSecurityPerimeterAccessRule[]	Netwerkbeveiligingsregel voor perimetertoegang
accessRulesVersion	integer (int64)	Versie van toegangsregels van het resourceprofiel
diagnosticSettingsVersion	integer (int64)	Huidige versie van diagnostische instellingen
enabledLogCategories	string[]	Lijst met ingeschakelde logboekcategorieën
name	string	Naam van het resourceprofiel

NspAccessRuleDirection

Inventarisatie

Richting van toegangsregel

Waarde	Description
Inbound
Outbound

ProvisioningIssue

Object

Name	Type	Description
name	string	Naam van het probleem met het inrichten van NSP's
properties	ProvisioningIssueProperties	Eigenschappen van inrichtingsprobleem

ProvisioningIssueProperties

Object

Eigenschappen van inrichtingsprobleem

Name	Type	Description
description	string	Beschrijving van het probleem
issueType	string	Type probleem
severity	string	Ernst van het probleem
suggestedAccessRules	NetworkSecurityPerimeterAccessRule[]	Optionele matrix, voorgestelde toegangsregels
suggestedResourceIds	string[] (arm-id)	Id's van resources die aan dezelfde perimeter kunnen worden gekoppeld om het probleem op te lossen.

Subscriptions

Object

Abonnementen voor binnenkomende regels

Name	Type	Description
id	string	Volledig gekwalificeerde id van abonnement