Network Security Perimeter Configurations - Get

サービス:

Search Management

API バージョン:

2024-03-01-preview

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

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

URI パラメーター

名前	/	必須	型	説明
nspConfigName	path	True	string	ネットワーク セキュリティ構成名。 正規表現パターン: ^[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	現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
searchServiceName	path	True	string	指定したリソース グループに関連付けられている Azure AI Search Serviceの名前。 正規表現パターン: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
subscriptionId	path	True	string	Microsoft Azure サブスクリプションの一意識別子。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
api-version	query	True	string	要求ごとに使用する API バージョン。

応答

名前	型	説明
200 OK	NetworkSecurityPerimeterConfiguration	構成が正常に取得されました。
Other Status Codes	CloudError	この操作の実行中に予期しないエラーが発生しました。

セキュリティ

azure_auth

Microsoft ID プラットフォームでサポートされている暗黙的な許可フローを指定します。

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

スコープ

名前	説明
user_impersonation	ユーザー アカウントの借用

例

Get an NSP config by name

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1?api-version=2024-03-01-preview

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python network_security_perimeter_configurations_get.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 = SearchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.network_security_perimeter_configurations.get(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
        nsp_config_name="00000001-2222-3333-4444-111144444444.assoc1",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/NetworkSecurityPerimeterConfigurationsGet.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 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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/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("<subscription-id>", 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.NetworkSecurityPerimeterConfiguration = armsearch.NetworkSecurityPerimeterConfiguration{
	// 	Name: to.Ptr("00000001-2222-3333-4444-111144444444.assoc1"),
	// 	Type: to.Ptr("Microsoft.Search/searchServices/networkSecurityPerimeterConfigurations"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1"),
	// 	Properties: &armsearch.NetworkSecurityPerimeterConfigurationProperties{
	// 		NetworkSecurityPerimeter: &armsearch.NSPConfigPerimeter{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/networkRG/providers/Microsoft.Network/networkSecurityPerimeters/perimeter1"),
	// 			Location: to.Ptr("westus"),
	// 		},
	// 		Profile: &armsearch.NSPConfigProfile{
	// 			Name: to.Ptr("profile1"),
	// 			AccessRules: []*armsearch.NSPConfigAccessRule{
	// 				{
	// 					Name: to.Ptr("rule1"),
	// 					Properties: &armsearch.NSPConfigAccessRuleProperties{
	// 						AddressPrefixes: []*string{
	// 							to.Ptr("148.0.0.0/8"),
	// 							to.Ptr("152.4.6.0/24")},
	// 							Direction: to.Ptr("Inbound"),
	// 						},
	// 				}},
	// 				AccessRulesVersion: to.Ptr("0"),
	// 			},
	// 			ProvisioningState: to.Ptr("Succeeded"),
	// 			ResourceAssociation: &armsearch.NSPConfigAssociation{
	// 				Name: to.Ptr("assoc1"),
	// 				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 { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a network security perimeter configuration.
 *
 * @summary Gets a network security perimeter configuration.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/NetworkSecurityPerimeterConfigurationsGet.json
 */
async function getAnNspConfigByName() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const nspConfigName = "00000001-2222-3333-4444-111144444444.assoc1";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.networkSecurityPerimeterConfigurations.get(
    resourceGroupName,
    searchServiceName,
    nspConfigName,
  );
  console.log(result);
}

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.Search;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/NetworkSecurityPerimeterConfigurationsGet.json
// this example is just showing the usage of "NetworkSecurityPerimeterConfigurations_Get" 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 NetworkSecurityPerimeterConfigurationResource created on azure
// for more information of creating NetworkSecurityPerimeterConfigurationResource, please refer to the document of NetworkSecurityPerimeterConfigurationResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
string nspConfigName = "00000001-2222-3333-4444-111144444444.assoc1";
ResourceIdentifier networkSecurityPerimeterConfigurationResourceId = NetworkSecurityPerimeterConfigurationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName, nspConfigName);
NetworkSecurityPerimeterConfigurationResource networkSecurityPerimeterConfiguration = client.GetNetworkSecurityPerimeterConfigurationResource(networkSecurityPerimeterConfigurationResourceId);

// invoke the operation
NetworkSecurityPerimeterConfigurationResource result = await networkSecurityPerimeterConfiguration.GetAsync();

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

状態コード:

200

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

定義

名前	説明
CloudError	API エラーに関する情報が含まれています。
CloudErrorBody	エラー コードとメッセージを含む特定の API エラーについて説明します。
NetworkSecurityPerimeterConfiguration	サーバーのネットワーク セキュリティ境界の構成。
NSPConfigAccessRule	ネットワーク セキュリティ境界構成のアクセス規則。
NSPConfigAccessRuleProperties	ネットワーク セキュリティ境界構成のアクセス規則のプロパティ。
NSPConfigAssociation	ネットワーク セキュリティ境界のリソースの関連付け。
NSPConfigNetworkSecurityPerimeterRule	構成規則に存在するネットワーク セキュリティ境界プロパティ。
NSPConfigPerimeter	ネットワーク セキュリティ境界構成の境界。
NSPConfigProfile	ネットワーク セキュリティ境界構成のプロファイル。
NSPProvisioningIssue	検索サービスへのネットワーク セキュリティ境界のプロビジョニングに関する問題を記述するオブジェクト。
NSPProvisioningIssueProperties	検索サービスへのネットワーク セキュリティ境界のプロビジョニングに関する問題を説明するプロパティ。

CloudError

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

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

CloudErrorBody

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

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

NetworkSecurityPerimeterConfiguration

サーバーのネットワーク セキュリティ境界の構成。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.networkSecurityPerimeter	NSPConfigPerimeter	ネットワーク セキュリティ境界構成の境界。
properties.profile	NSPConfigProfile	ネットワーク セキュリティ境界構成のプロファイル。
properties.provisioningIssues	NSPProvisioningIssue[]	検索サービスへのネットワーク セキュリティ境界のプロビジョニングに関する問題を記述するオブジェクト。
properties.provisioningState	string
properties.resourceAssociation	NSPConfigAssociation	ネットワーク セキュリティ境界のリソースの関連付け。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

NSPConfigAccessRule

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

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

NSPConfigAccessRuleProperties

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

名前	型	説明
addressPrefixes	string[]
direction	string
fullyQualifiedDomainNames	string[]
networkSecurityPerimeters	NSPConfigNetworkSecurityPerimeterRule[]	構成規則に存在するネットワーク セキュリティ境界プロパティ。
subscriptions	string[]

NSPConfigAssociation

ネットワーク セキュリティ境界のリソースの関連付け。

名前	型	説明
accessMode	string
name	string

NSPConfigNetworkSecurityPerimeterRule

構成規則に存在するネットワーク セキュリティ境界プロパティ。

名前	型	説明
id	string
location	string
perimeterGuid	string

NSPConfigPerimeter

ネットワーク セキュリティ境界構成の境界。

名前	型	説明
id	string
location	string
perimeterGuid	string

NSPConfigProfile

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

名前	型	説明
accessRules	NSPConfigAccessRule[]	ネットワーク セキュリティ境界構成のアクセス規則。
accessRulesVersion	string
name	string

NSPProvisioningIssue

検索サービスへのネットワーク セキュリティ境界のプロビジョニングに関する問題を記述するオブジェクト。

名前	型	説明
name	string
properties	NSPProvisioningIssueProperties	検索サービスへのネットワーク セキュリティ境界のプロビジョニングに関する問題を説明するプロパティ。

NSPProvisioningIssueProperties

検索サービスへのネットワーク セキュリティ境界のプロビジョニングに関する問題を説明するプロパティ。

名前	型	説明
description	string
issueType	string
severity	string
suggestedAccessRules	string[]
suggestedResourceIds	string[]