Network Security Perimeter Configurations - Get

Služba:

Search Management

Verze rozhraní API:

2024-03-01-preview

Získá konfiguraci hraniční sítě zabezpečení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
nspConfigName	path	True	string	Název konfigurace zabezpečení sítě. Vzor regulárního výrazu: ^[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	Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.
searchServiceName	path	True	string	Název Azure AI Search přidružený k zadané skupině prostředků. Vzor regulárního výrazu: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
subscriptionId	path	True	string	Jedinečný identifikátor předplatného Microsoft Azure. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.
api-version	query	True	string	Verze rozhraní API, která se má použít pro každý požadavek.

Odpovědi

Name	Typ	Description
200 OK	NetworkSecurityPerimeterConfiguration	Konfigurace se úspěšně načetla.
Other Status Codes	CloudError	Během provozu došlo k neočekávané chybě.

Zabezpečení

azure_auth

Určuje implicitní tok udělení, který se podporuje na platformě Microsoft Identity Platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get an NSP config by name

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
CloudError	Obsahuje informace o chybě rozhraní API.
CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
NetworkSecurityPerimeterConfiguration	Konfigurace hraniční sítě pro server.
NSPConfigAccessRule	Pravidlo přístupu pro konfiguraci hraniční sítě.
NSPConfigAccessRuleProperties	Vlastnosti pravidel přístupu v konfiguraci hraniční sítě zabezpečení sítě.
NSPConfigAssociation	Přidružení prostředků pro hraniční síť zabezpečení.
NSPConfigNetworkSecurityPerimeterRule	Vlastnosti hraniční sítě, které jsou přítomné v pravidle konfigurace.
NSPConfigPerimeter	Hraniční síť pro konfiguraci hraniční sítě.
NSPConfigProfile	Profil pro konfiguraci hraniční sítě zabezpečení sítě.
NSPProvisioningIssue	Objekt popisující všechny problémy se zřizováním bezpečnostních perimetrů sítě pro vyhledávací službu.
NSPProvisioningIssueProperties	Vlastnosti popisující případné problémy se zřizováním bezpečnostních perimetrů sítě pro vyhledávací službu.

CloudError

Obsahuje informace o chybě rozhraní API.

Name	Typ	Description
error	CloudErrorBody	Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
message	string	Stručný popis chyby, který naznačuje, co se pokazilo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message).

CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Name	Typ	Description
code	string	Kód chyby, který popisuje chybovou podmínku přesněji než stavový kód HTTP. Dá se použít ke zpracování konkrétních případů chyb prostřednictvím kódu programu.
details	CloudErrorBody[]	Obsahuje vnořené chyby, které s touto chybou souvisejí.
message	string	Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.
target	string	Cíl konkrétní chyby (například název vlastnosti v chybě).

NetworkSecurityPerimeterConfiguration

Konfigurace hraniční sítě pro server.

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
name	string	Název prostředku
properties.networkSecurityPerimeter	NSPConfigPerimeter	Hraniční síť pro konfiguraci hraniční sítě.
properties.profile	NSPConfigProfile	Profil pro konfiguraci hraniční sítě zabezpečení sítě.
properties.provisioningIssues	NSPProvisioningIssue[]	Objekt popisující všechny problémy se zřizováním bezpečnostních perimetrů sítě pro vyhledávací službu.
properties.provisioningState	string
properties.resourceAssociation	NSPConfigAssociation	Přidružení prostředků pro hraniční síť zabezpečení.
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

NSPConfigAccessRule

Pravidlo přístupu pro konfiguraci hraniční sítě.

Name	Typ	Description
name	string
properties	NSPConfigAccessRuleProperties	Vlastnosti pravidel přístupu v konfiguraci hraniční sítě zabezpečení sítě.

NSPConfigAccessRuleProperties

Vlastnosti pravidel přístupu v konfiguraci hraniční sítě zabezpečení sítě.

Name	Typ	Description
addressPrefixes	string[]
direction	string
fullyQualifiedDomainNames	string[]
networkSecurityPerimeters	NSPConfigNetworkSecurityPerimeterRule[]	Vlastnosti hraniční sítě, které jsou přítomné v pravidle konfigurace.
subscriptions	string[]

NSPConfigAssociation

Přidružení prostředků pro hraniční síť zabezpečení.

Name	Typ	Description
accessMode	string
name	string

NSPConfigNetworkSecurityPerimeterRule

Vlastnosti hraniční sítě, které jsou přítomné v pravidle konfigurace.

Name	Typ	Description
id	string
location	string
perimeterGuid	string

NSPConfigPerimeter

Hraniční síť pro konfiguraci hraniční sítě.

Name	Typ	Description
id	string
location	string
perimeterGuid	string

NSPConfigProfile

Profil pro konfiguraci hraniční sítě zabezpečení sítě.

Name	Typ	Description
accessRules	NSPConfigAccessRule[]	Pravidlo přístupu pro konfiguraci hraniční sítě.
accessRulesVersion	string
name	string

NSPProvisioningIssue

Objekt popisující všechny problémy se zřizováním bezpečnostních perimetrů sítě pro vyhledávací službu.

Name	Typ	Description
name	string
properties	NSPProvisioningIssueProperties	Vlastnosti popisující případné problémy se zřizováním bezpečnostních perimetrů sítě pro vyhledávací službu.

NSPProvisioningIssueProperties

Vlastnosti popisující případné problémy se zřizováním bezpečnostních perimetrů sítě pro vyhledávací službu.

Name	Typ	Description
description	string
issueType	string
severity	string
suggestedAccessRules	string[]
suggestedResourceIds	string[]