Network Security Perimeter Configurations - List

サービス:

Azure AI Services

API バージョン:

2024-10-01

アカウントの NSP 構成の一覧を取得します。

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

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Cognitive Services アカウントの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
subscriptionId	path	True	string minLength: 1	ターゲット サブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	NetworkSecurityPerimeterConfigurationList	構成の一覧が正常に取得されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

例

ListNetworkSecurityPerimeterConfigurations

要求のサンプル

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

応答のサンプル

状態コード:

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

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
NetworkSecurityPerimeter	リンクされたネットワーク セキュリティ境界に関する情報
NetworkSecurityPerimeterAccessRule	ネットワーク セキュリティ境界アクセス規則
NetworkSecurityPerimeterAccessRuleProperties	ネットワーク セキュリティ境界規則のプロパティ
NetworkSecurityPerimeterConfiguration	Cognitive Services アカウントの NSP 構成。
NetworkSecurityPerimeterConfigurationAssociationInfo	ネットワーク セキュリティ境界構成の関連付け情報
NetworkSecurityPerimeterConfigurationList	Cognitive Services アカウントの NSP 構成の一覧。
NetworkSecurityPerimeterConfigurationProperties	NSP 構成のプロパティ。
NetworkSecurityPerimeterProfileInfo	ネットワーク セキュリティ境界プロファイル情報
NspAccessRuleDirection	アクセス規則の方向
ProvisioningIssue
ProvisioningIssueProperties	プロビジョニングの問題のプロパティ
Subscriptions	受信規則のサブスクリプション

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

NetworkSecurityPerimeter

Object

リンクされたネットワーク セキュリティ境界に関する情報

名前	型	説明
id	string (arm-id)	リソースの完全修飾識別子
location	string	リソースの場所
perimeterGuid	string	リソースの GUID

NetworkSecurityPerimeterAccessRule

Object

ネットワーク セキュリティ境界アクセス規則

名前	型	説明
name	string	ネットワーク セキュリティ境界アクセス規則名
properties	NetworkSecurityPerimeterAccessRuleProperties	ネットワーク セキュリティ境界アクセス規則のプロパティ

NetworkSecurityPerimeterAccessRuleProperties

Object

ネットワーク セキュリティ境界規則のプロパティ

名前	型	説明
addressPrefixes	string[]	受信規則のアドレス プレフィックス
direction	NspAccessRuleDirection	アクセス規則の方向
fullyQualifiedDomainNames	string[]	送信規則の完全修飾ドメイン名
networkSecurityPerimeters	NetworkSecurityPerimeter[]	受信規則の NetworkSecurityPerimeters
subscriptions	Subscriptions[]	受信規則のサブスクリプション

NetworkSecurityPerimeterConfiguration

Object

Cognitive Services アカウントの NSP 構成。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties	NetworkSecurityPerimeterConfigurationProperties	NSP 構成プロパティ。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationAssociationInfo

Object

ネットワーク セキュリティ境界構成の関連付け情報

名前	型	説明
accessMode	string	リソース関連付けのアクセス モード
name	string	リソースの関連付けの名前

NetworkSecurityPerimeterConfigurationList

Object

Cognitive Services アカウントの NSP 構成の一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	NetworkSecurityPerimeterConfiguration[]	Cognitive Services アカウントの NSP 構成リスト結果の配列。

NetworkSecurityPerimeterConfigurationProperties

Object

NSP 構成のプロパティ。

名前	型	説明
networkSecurityPerimeter	NetworkSecurityPerimeter	リンクされたネットワーク セキュリティ境界に関する情報
profile	NetworkSecurityPerimeterProfileInfo	ネットワーク セキュリティ境界プロファイル情報
provisioningIssues	ProvisioningIssue[]	プロビジョニングの問題の一覧
provisioningState	string	NetworkSecurityPerimeter 構成のプロビジョニング状態
resourceAssociation	NetworkSecurityPerimeterConfigurationAssociationInfo	ネットワーク セキュリティ境界構成の関連付け情報

NetworkSecurityPerimeterProfileInfo

Object

ネットワーク セキュリティ境界プロファイル情報

名前	型	説明
accessRules	NetworkSecurityPerimeterAccessRule[]	ネットワーク セキュリティ境界アクセス規則
accessRulesVersion	integer (int64)	リソース プロファイルのアクセス 規則のバージョン
diagnosticSettingsVersion	integer (int64)	現在の診断設定のバージョン
enabledLogCategories	string[]	有効なログ カテゴリの一覧
name	string	リソース プロファイルの名前

NspAccessRuleDirection

列挙

アクセス規則の方向

値	説明
Inbound
Outbound

ProvisioningIssue

Object

名前	型	説明
name	string	NSP プロビジョニングの問題の名前
properties	ProvisioningIssueProperties	プロビジョニングの問題のプロパティ

ProvisioningIssueProperties

Object

プロビジョニングの問題のプロパティ

名前	型	説明
description	string	問題の説明
issueType	string	問題の種類
severity	string	問題の重大度
suggestedAccessRules	NetworkSecurityPerimeterAccessRule[]	省略可能な配列、推奨されるアクセス規則
suggestedResourceIds	string[] (arm-id)	問題を修復するために同じ境界に関連付けることができるリソースの ID。

Subscriptions

Object

受信規則のサブスクリプション

名前	型	説明
id	string	サブスクリプションの完全修飾識別子