Network Security Perimeter Configurations - Get

Referenz

Dienst:: Search Management

API-Version:: 2024-03-01-preview

Ruft eine Netzwerksicherheitsperimeterkonfiguration ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
nspConfigName	path	True	string	Der Name der Netzwerksicherheitskonfiguration. RegEx-Muster: `^[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	Der Name der Ressourcengruppe im aktuellen Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
searchServiceName	path	True	string	Der Name der Azure KI-Suchdienst, die der angegebenen Ressourcengruppe zugeordnet ist. RegEx-Muster: `^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$`
subscriptionId	path	True	string	Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
api-version	query	True	string	Die API-Version, die für jede Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	NetworkSecurityPerimeterConfiguration	Die Konfiguration wurde erfolgreich abgerufen.
Other Status Codes	CloudError	Während des Vorgangs ist ein unerwarteter Fehler aufgetreten.

Sicherheit

azure_auth

Gibt einen impliziten Gewährungsflow an, der von Microsoft Identity Platform unterstützt wird.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get an NSP config by name

Beispielanforderung

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

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

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

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

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
CloudError	Enthält Informationen zu einem API-Fehler.
CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
NetworkSecurityPerimeterConfiguration	Konfiguration des Netzwerksicherheitsperimeters für einen Server.
NSPConfigAccessRule	Eine Zugriffsregel für eine Konfiguration des Netzwerksicherheitsperimeters.
NSPConfigAccessRuleProperties	Die Eigenschaften für die Zugriffsregeln in einer Netzwerksicherheitsperimeterkonfiguration.
NSPConfigAssociation	Die Ressourcenzuordnung für den Netzwerksicherheitsperimeter.
NSPConfigNetworkSecurityPerimeterRule	Die Eigenschaften des Netzwerksicherheitsperimeters, die in einer Konfigurationsregel vorhanden sind.
NSPConfigPerimeter	Der Umkreis für eine Konfiguration des Netzwerksicherheitsperimeters.
NSPConfigProfile	Das Profil für eine Netzwerksicherheitsperimeterkonfiguration.
NSPProvisioningIssue	Ein Objekt zum Beschreiben von Problemen mit der Bereitstellung von Netzwerksicherheitsperimetern für einen Suchdienst.
NSPProvisioningIssueProperties	Die Eigenschaften zur Beschreibung von Problemen bei der Bereitstellung von Netzwerksicherheitsperimetern für einen Suchdienst.

CloudError

Enthält Informationen zu einem API-Fehler.

Name	Typ	Beschreibung
error	CloudErrorBody	Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
message	string	Eine kurze Beschreibung des Fehlers, die darauf hinweist, was falsch gelaufen ist (details/Debuginformationen finden Sie in der Eigenschaft "error.message").

CloudErrorBody

Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.

Name	Typ	Beschreibung
code	string	Ein Fehlercode, der die Fehlerbedingung genauer beschreibt als ein HTTP-status Code. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details	CloudErrorBody[]	Enthält geschachtelte Fehler, die sich auf diesen Fehler beziehen.
message	string	Eine Meldung, die den Fehler ausführlich beschreibt und Debuginformationen bereitstellt.
target	string	Das Ziel des bestimmten Fehlers (z. B. der Name der -Eigenschaft im Fehler).

NetworkSecurityPerimeterConfiguration

Konfiguration des Netzwerksicherheitsperimeters für einen Server.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.networkSecurityPerimeter	NSPConfigPerimeter	Der Umkreis für eine Konfiguration des Netzwerksicherheitsperimeters.
properties.profile	NSPConfigProfile	Das Profil für eine Netzwerksicherheitsperimeterkonfiguration.
properties.provisioningIssues	NSPProvisioningIssue[]	Ein Objekt zum Beschreiben von Problemen mit der Bereitstellung von Netzwerksicherheitsperimetern für einen Suchdienst.
properties.provisioningState	string
properties.resourceAssociation	NSPConfigAssociation	Die Ressourcenzuordnung für den Netzwerksicherheitsperimeter.
type	string	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

NSPConfigAccessRule

Eine Zugriffsregel für eine Konfiguration des Netzwerksicherheitsperimeters.

Name	Typ	Beschreibung
name	string
properties	NSPConfigAccessRuleProperties	Die Eigenschaften für die Zugriffsregeln in einer Netzwerksicherheitsperimeterkonfiguration.

NSPConfigAccessRuleProperties

Die Eigenschaften für die Zugriffsregeln in einer Netzwerksicherheitsperimeterkonfiguration.

Name	Typ	Beschreibung
addressPrefixes	string[]
direction	string
fullyQualifiedDomainNames	string[]
networkSecurityPerimeters	NSPConfigNetworkSecurityPerimeterRule[]	Die Eigenschaften des Netzwerksicherheitsperimeters, die in einer Konfigurationsregel vorhanden sind.
subscriptions	string[]

NSPConfigAssociation

Die Ressourcenzuordnung für den Netzwerksicherheitsperimeter.

Name	Typ	Beschreibung
accessMode	string
name	string

NSPConfigNetworkSecurityPerimeterRule

Die Eigenschaften des Netzwerksicherheitsperimeters, die in einer Konfigurationsregel vorhanden sind.

Name	Typ	Beschreibung
id	string
location	string
perimeterGuid	string

NSPConfigPerimeter

Der Umkreis für eine Konfiguration des Netzwerksicherheitsperimeters.

Name	Typ	Beschreibung
id	string
location	string
perimeterGuid	string

NSPConfigProfile

Das Profil für eine Netzwerksicherheitsperimeterkonfiguration.

Name	Typ	Beschreibung
accessRules	NSPConfigAccessRule[]	Eine Zugriffsregel für eine Konfiguration des Netzwerksicherheitsperimeters.
accessRulesVersion	string
name	string

NSPProvisioningIssue

Ein Objekt zum Beschreiben von Problemen mit der Bereitstellung von Netzwerksicherheitsperimetern für einen Suchdienst.

Name	Typ	Beschreibung
name	string
properties	NSPProvisioningIssueProperties	Die Eigenschaften zur Beschreibung von Problemen bei der Bereitstellung von Netzwerksicherheitsperimetern für einen Suchdienst.

NSPProvisioningIssueProperties

Die Eigenschaften zur Beschreibung von Problemen bei der Bereitstellung von Netzwerksicherheitsperimetern für einen Suchdienst.

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

Freigeben über

Network Security Perimeter Configurations - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Get an NSP config by name

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudError

CloudErrorBody

NetworkSecurityPerimeterConfiguration

NSPConfigAccessRule

NSPConfigAccessRuleProperties

NSPConfigAssociation

NSPConfigNetworkSecurityPerimeterRule

NSPConfigPerimeter

NSPConfigProfile

NSPProvisioningIssue

NSPProvisioningIssueProperties

Zusätzliche Ressourcen