Network Security Perimeter Configurations - Get

サービス:: Search Management

API バージョン:: 2025-05-01

ネットワークセキュリティ境界構成を取得します。

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

URI パラメーター

名前	/	必須	型	説明
nspConfigName	path	True	string minLength: 38 maxLength: 100 pattern: ^[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 minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字が区別されます。
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	指定したリソースグループに関連付けられている Azure AI Search サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	NetworkSecurityPerimeterConfiguration	Azure 操作は正常に完了しました。
Other Status Codes	CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Get an NSP config by name

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1?api-version=2025-05-01

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/v2"
)

// Generated from example definition: 2025-05-01/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("00000000-0000-0000-0000-000000000000", 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 = armsearch.NetworkSecurityPerimeterConfigurationsClientGetResponse{
	// 	NetworkSecurityPerimeterConfiguration: &armsearch.NetworkSecurityPerimeterConfiguration{
	// 		Name: to.Ptr("00000001-2222-3333-4444-111144444444.assoc1"),
	// 		Type: to.Ptr("Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations"),
	// 		ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1"),
	// 		Properties: &armsearch.NetworkSecurityPerimeterConfigurationProperties{
	// 			NetworkSecurityPerimeter: &armsearch.NetworkSecurityPerimeter{
	// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1"),
	// 				Location: to.Ptr("westus"),
	// 			},
	// 			Profile: &armsearch.NetworkSecurityProfile{
	// 				Name: to.Ptr("profile1"),
	// 				AccessRules: []*armsearch.AccessRule{
	// 					{
	// 						Name: to.Ptr("rule1"),
	// 						Properties: &armsearch.AccessRuleProperties{
	// 							AddressPrefixes: []*string{
	// 								to.Ptr("148.0.0.0/8"),
	// 								to.Ptr("152.4.6.0/24"),
	// 							},
	// 							Direction: to.Ptr(armsearch.AccessRuleDirectionInbound),
	// 						},
	// 					},
	// 				},
	// 				AccessRulesVersion: to.Ptr[int32](0),
	// 			},
	// 			ProvisioningState: to.Ptr(armsearch.NetworkSecurityPerimeterConfigurationProvisioningStateAccepted),
	// 			ResourceAssociation: &armsearch.ResourceAssociation{
	// 				Name: to.Ptr("assoc1"),
	// 				AccessMode: to.Ptr(armsearch.ResourceAssociationAccessModeEnforced),
	// 			},
	// 		},
	// 	},
	// }
}

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

応答のサンプル

状態コード:: 200

{
  "name": "00000001-2222-3333-4444-111144444444.assoc1",
  "type": "Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1",
  "properties": {
    "networkSecurityPerimeter": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1",
      "location": "westus"
    },
    "profile": {
      "name": "profile1",
      "accessRules": [
        {
          "name": "rule1",
          "properties": {
            "addressPrefixes": [
              "148.0.0.0/8",
              "152.4.6.0/24"
            ],
            "direction": "Inbound"
          }
        }
      ],
      "accessRulesVersion": 0
    },
    "provisioningState": "Accepted",
    "resourceAssociation": {
      "name": "assoc1",
      "accessMode": "Enforced"
    }
  }
}

定義

名前	説明
AccessRule	ネットワークセキュリティ境界構成プロファイルのアクセス規則
AccessRuleDirection	アクセス規則の方向
AccessRuleProperties	アクセス規則のプロパティ
CloudError	API エラーに関する情報が含まれています。
CloudErrorBody	エラーコードとメッセージを含む特定の API エラーについて説明します。
createdByType	リソースを作成した ID の種類。
IssueType	問題の種類
NetworkSecurityPerimeter	ネットワークセキュリティ境界 (NSP) に関する情報
NetworkSecurityPerimeterConfiguration	ネットワークセキュリティ境界 (NSP) 構成リソース
NetworkSecurityPerimeterConfigurationProperties	ネットワークセキュリティ構成プロパティ。
NetworkSecurityPerimeterConfigurationProvisioningState	作成または更新されるネットワークセキュリティ境界構成のプロビジョニング状態。
NetworkSecurityProfile	ネットワークセキュリティ境界構成プロファイル
ProvisioningIssue	ネットワークセキュリティ境界構成のプロビジョニングの問題について説明します
ProvisioningIssueProperties	ネットワークセキュリティ境界 (NSP) 構成のプロビジョニングの問題の詳細。リソースプロバイダーは、検出された個別の問題ごとに個別のプロビジョニングの問題要素を生成し、意味のある独特の説明と、適切な suggestedResourceIds と suggestedAccessRules を含める必要があります
ResourceAssociation	リソースの関連付けに関する情報
ResourceAssociationAccessMode	リソース関連付けのアクセスモード
Severity	問題の重大度。
Subscriptions	受信規則のサブスクリプション
systemData	リソースの作成と最後の変更に関連するメタデータ。

AccessRule

Object

ネットワークセキュリティ境界構成プロファイルのアクセス規則

名前	型	説明
name	string	アクセス規則の名前
properties	AccessRuleProperties	アクセス規則のプロパティ

AccessRuleDirection

列挙

アクセス規則の方向

値	説明
Inbound	セキュリティで保護されたリソースへの受信ネットワークトラフィックに適用されます。
Outbound	セキュリティで保護されたリソースからの送信ネットワークトラフィックに適用されます

AccessRuleProperties

Object

アクセス規則のプロパティ

名前	型	説明
addressPrefixes	string[]	受信規則の CIDR 形式のアドレスプレフィックス
direction	AccessRuleDirection	アクセス規則の方向
emailAddresses	string[]	送信規則の電子メールアドレス
fullyQualifiedDomainNames	string[]	送信規則の完全修飾ドメイン名 (FQDN)
networkSecurityPerimeters	NetworkSecurityPerimeter[]	受信規則のネットワークセキュリティ境界
phoneNumbers	string[]	送信ルールの電話番号
subscriptions	Subscriptions[]	受信規則のサブスクリプション

CloudError

Object

API エラーに関する情報が含まれています。

名前	型	説明
error	CloudErrorBody	エラーコードとメッセージを含む特定の API エラーについて説明します。
message	string	問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。

CloudErrorBody

Object

エラーコードとメッセージを含む特定の API エラーについて説明します。

名前	型	説明
code	string	HTTP 状態コードよりも正確にエラー状態を記述するエラーコード。特定のエラーケースをプログラムで処理するために使用できます。
details	CloudErrorBody[]	このエラーに関連する入れ子になったエラーが含まれています。
message	string	エラーの詳細を説明し、デバッグ情報を提供するメッセージ。
target	string	特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

IssueType

列挙

問題の種類

値	説明
Unknown	不明な問題の種類
ConfigurationPropagationFailure	ネットワークセキュリティ境界 (NSP) 構成の適用中にエラーが発生しました。
MissingPerimeterConfiguration	ネットワーク接続の問題は、ネットワークセキュリティ境界 (NSP) に新しいリソースを追加するか、アクセス規則を変更することによって対処できるリソースで発生しています。
MissingIdentityConfiguration	マネージド ID がリソースに関連付けされていません。リソースは引き続き、ネットワークセキュリティ境界 (NSP) からの受信トラフィックまたは受信アクセス規則に一致することを検証できますが、NSP のメンバーとして送信アクセスを実行することはできません。

NetworkSecurityPerimeter

Object

ネットワークセキュリティ境界 (NSP) に関する情報

名前	型	説明
id	string (arm-id)	NSP リソースの完全修飾 Azure リソース ID
location	string	ネットワークセキュリティ境界の場所
perimeterGuid	string (uuid)	ネットワークセキュリティ境界のユニバーサル一意 ID (UUID)

NetworkSecurityPerimeterConfiguration

Object

ネットワークセキュリティ境界 (NSP) 構成リソース

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties	NetworkSecurityPerimeterConfigurationProperties	ネットワークセキュリティ構成プロパティ。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationProperties

Object

ネットワークセキュリティ構成プロパティ。

名前	型	説明
networkSecurityPerimeter	NetworkSecurityPerimeter	ネットワークセキュリティ境界 (NSP) に関する情報
profile	NetworkSecurityProfile	ネットワークセキュリティ境界構成プロファイル
provisioningIssues	ProvisioningIssue[]	プロビジョニングの問題の一覧 (存在する場合)
provisioningState	NetworkSecurityPerimeterConfigurationProvisioningState	作成または更新されるネットワークセキュリティ境界構成のプロビジョニング状態。
resourceAssociation	ResourceAssociation	リソースの関連付けに関する情報

NetworkSecurityPerimeterConfigurationProvisioningState

列挙

作成または更新されるネットワークセキュリティ境界構成のプロビジョニング状態。

値	説明
Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

NetworkSecurityProfile

Object

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

名前	型	説明
accessRules	AccessRule[]	アクセス規則の一覧
accessRulesVersion	integer (int32)	現在のアクセス規則のバージョン
diagnosticSettingsVersion	integer (int32)	現在の診断設定のバージョン
enabledLogCategories	string[]	有効になっているログカテゴリの一覧
name	string	プロファイルの名前

ProvisioningIssue

Object

ネットワークセキュリティ境界構成のプロビジョニングの問題について説明します

名前	型	説明
name	string	問題の名前
properties	ProvisioningIssueProperties	ネットワークセキュリティ境界 (NSP) 構成のプロビジョニングの問題の詳細。リソースプロバイダーは、検出された個別の問題ごとに個別のプロビジョニングの問題要素を生成し、意味のある独特の説明と、適切な suggestedResourceIds と suggestedAccessRules を含める必要があります

ProvisioningIssueProperties

Object

ネットワークセキュリティ境界 (NSP) 構成のプロビジョニングの問題の詳細。リソースプロバイダーは、検出された個別の問題ごとに個別のプロビジョニングの問題要素を生成し、意味のある独特の説明と、適切な suggestedResourceIds と suggestedAccessRules を含める必要があります

名前	型	説明
description	string	問題の説明
issueType	IssueType	問題の種類
severity	Severity	問題の重大度。
suggestedAccessRules	AccessRule[]	ネットワークセキュリティプロファイル (NSP) に追加して問題を修復できるアクセス規則。
suggestedResourceIds	string[] (arm-id)	問題を修復するためにネットワークセキュリティ境界 (NSP) に関連付けることができる、推奨されるリソースの完全修飾リソース ID。

ResourceAssociation

Object

リソースの関連付けに関する情報

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

ResourceAssociationAccessMode

列挙

リソース関連付けのアクセスモード

値	説明
Enforced	強制アクセスモード - アクセスチェックに失敗したリソースへのトラフィックがブロックされる
Learning	学習アクセスモード - リソースへのトラフィックは分析に対して有効になっていますが、ブロックされません
Audit	アクセスモードの監査 - アクセスチェックに失敗したリソースへのトラフィックはログに記録されますが、ブロックされません

Severity

列挙

問題の重大度。

値	説明
Warning
Error

Subscriptions

Object

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

名前	型	説明
id	string (arm-id)	サブスクリプションの完全修飾 Azure リソース ID ('/subscriptions/00000000-0000-0000-0000-0000000000000')

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。