Network Security Perimeter Configurations - Reconcile

Dienst:: AI Foundry

API-Version:: 2025-06-01

Stimmen Sie die NSP-Konfiguration für ein Konto ab.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations/{nspConfigurationName}/reconcile?api-version=2025-06-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string minLength: 2 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$	Der Name des Cognitive Services-Kontos.
nspConfigurationName	path	True	string pattern: ^.*$	Der Name der NSP-Konfiguration.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name

Typ

Beschreibung

200 OK

NetworkSecurityPerimeterConfiguration

Die NSP-Konfiguration wurde erfolgreich abgeglichen.

202 Accepted

Anforderung zum Abgleich der NSP-Konfiguration akzeptiert.

Header

location: string

Other Status Codes

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

ReconcileNetworkSecurityPerimeterConfigurations

Beispielanforderung

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations/NSPConfigurationName/reconcile?api-version=2025-06-01


/**
 * Samples for NetworkSecurityPerimeterConfigurations Reconcile.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/
     * ReconcileNetworkSecurityPerimeterConfigurations.json
     */
    /**
     * Sample code: ReconcileNetworkSecurityPerimeterConfigurations.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void reconcileNetworkSecurityPerimeterConfigurations(
        com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.networkSecurityPerimeterConfigurations().reconcile("resourceGroupName", "accountName",
            "NSPConfigurationName", 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python reconcile_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.begin_reconcile(
        resource_group_name="resourceGroupName",
        account_name="accountName",
        nsp_configuration_name="NSPConfigurationName",
    ).result()
    print(response)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ReconcileNetworkSecurityPerimeterConfigurations.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 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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1004eed4202d64b48157c084fe2830760f8190f4/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ReconcileNetworkSecurityPerimeterConfigurations.json
func ExampleNetworkSecurityPerimeterConfigurationsClient_BeginReconcile() {
	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)
	}
	poller, err := clientFactory.NewNetworkSecurityPerimeterConfigurationsClient().BeginReconcile(ctx, "resourceGroupName", "accountName", "NSPConfigurationName", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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 = 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/config1"),
	// 	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

const { CognitiveServicesManagementClient } = require("@azure/arm-cognitiveservices");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Reconcile the NSP configuration for an account.
 *
 * @summary Reconcile the NSP configuration for an account.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ReconcileNetworkSecurityPerimeterConfigurations.json
 */
async function reconcileNetworkSecurityPerimeterConfigurations() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["COGNITIVESERVICES_RESOURCE_GROUP"] || "resourceGroupName";
  const accountName = "accountName";
  const nspConfigurationName = "NSPConfigurationName";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const result = await client.networkSecurityPerimeterConfigurations.beginReconcileAndWait(
    resourceGroupName,
    accountName,
    nspConfigurationName,
  );
  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.CognitiveServices;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2025-06-01/examples/ReconcileNetworkSecurityPerimeterConfigurations.json
// this example is just showing the usage of "NetworkSecurityPerimeterConfigurations_Reconcile" 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 = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "resourceGroupName";
string accountName = "accountName";
string nspConfigurationName = "NSPConfigurationName";
ResourceIdentifier networkSecurityPerimeterConfigurationResourceId = NetworkSecurityPerimeterConfigurationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, nspConfigurationName);
NetworkSecurityPerimeterConfigurationResource networkSecurityPerimeterConfiguration = client.GetNetworkSecurityPerimeterConfigurationResource(networkSecurityPerimeterConfigurationResourceId);

// invoke the operation
ArmOperation<NetworkSecurityPerimeterConfigurationResource> lro = await networkSecurityPerimeterConfiguration.ReconcileAsync(WaitUntil.Completed);
NetworkSecurityPerimeterConfigurationResource result = lro.Value;

// 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/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations/config1",
  "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"
            ]
          }
        }
      ]
    }
  }
}

Statuscode:: 202

azure-asyncoperation: http://azure.async.operation/status

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
NetworkSecurityPerimeter	Informationen über einen verknüpften Netzwerksicherheitsperimeter
NetworkSecurityPerimeterAccessRule	Perimeterzugriffsregel für die Netzwerksicherheit
NetworkSecurityPerimeterAccessRuleProperties	Die Eigenschaften der Perimeterregel für die Netzwerksicherheit
NetworkSecurityPerimeterConfiguration	NSP-Konfiguration für ein Cognitive Services-Konto.
NetworkSecurityPerimeterConfigurationAssociationInfo	Informationen zur Netzwerksicherheits-Perimeterkonfigurationszuordnung
NetworkSecurityPerimeterConfigurationProperties	Die Eigenschaften einer NSP-Konfiguration.
NetworkSecurityPerimeterProfileInfo	Informationen zum Netzwerksicherheitsperimeterprofil
NspAccessRuleDirection	Regel für die Zugriffsrichtung
ProvisioningIssue
ProvisioningIssueProperties	Eigenschaften des Bereitstellungsproblems
Subscriptions	Abonnements für eingehende Regeln

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

NetworkSecurityPerimeter

Objekt

Informationen über einen verknüpften Netzwerksicherheitsperimeter

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierter Bezeichner der Ressource
location	string	Standort der Ressource
perimeterGuid	string	GUID der Ressource

NetworkSecurityPerimeterAccessRule

Objekt

Perimeterzugriffsregel für die Netzwerksicherheit

Name	Typ	Beschreibung
name	string	Name der Netzwerksicherheits-Perimeterzugriffsregel
properties	NetworkSecurityPerimeterAccessRuleProperties	Eigenschaften der Umkreiszugriffsregel für die Netzwerksicherheit

NetworkSecurityPerimeterAccessRuleProperties

Objekt

Die Eigenschaften der Perimeterregel für die Netzwerksicherheit

Name	Typ	Beschreibung
addressPrefixes	string[]	Adresspräfixe für eingehende Regeln
direction	NspAccessRuleDirection	Regel für die Zugriffsrichtung
fullyQualifiedDomainNames	string[]	Vollqualifizierter Domänenname für ausgehende Regeln
networkSecurityPerimeters	NetworkSecurityPerimeter[]	NetworkSecurityPerimeters für eingehende Regeln
subscriptions	Subscriptions[]	Abonnements für eingehende Regeln

NetworkSecurityPerimeterConfiguration

Objekt

NSP-Konfiguration für ein Cognitive Services-Konto.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties	NetworkSecurityPerimeterConfigurationProperties	NSP-Konfigurationseigenschaften.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

NetworkSecurityPerimeterConfigurationAssociationInfo

Objekt

Informationen zur Netzwerksicherheits-Perimeterkonfigurationszuordnung

Name	Typ	Beschreibung
accessMode	string	Zugriffsmodus der Ressourcenzuordnung
name	string	Name der Ressourcenzuordnung

NetworkSecurityPerimeterConfigurationProperties

Objekt

Die Eigenschaften einer NSP-Konfiguration.

Name	Typ	Beschreibung
networkSecurityPerimeter	NetworkSecurityPerimeter	Informationen über einen verknüpften Netzwerksicherheitsperimeter
profile	NetworkSecurityPerimeterProfileInfo	Informationen zum Netzwerksicherheitsperimeterprofil
provisioningIssues	ProvisioningIssue[]	Liste der Bereitstellungsprobleme
provisioningState	string	Bereitstellungsstatus der NetworkSecurityPerimeter-Konfiguration
resourceAssociation	NetworkSecurityPerimeterConfigurationAssociationInfo	Informationen zur Netzwerksicherheits-Perimeterkonfigurationszuordnung

NetworkSecurityPerimeterProfileInfo

Objekt

Informationen zum Netzwerksicherheitsperimeterprofil

Name	Typ	Beschreibung
accessRules	NetworkSecurityPerimeterAccessRule[]	Perimeterzugriffsregel für die Netzwerksicherheit
accessRulesVersion	integer (int64)	Version der Zugriffsregeln des Ressourcenprofils
diagnosticSettingsVersion	integer (int64)	Aktuelle Version der Diagnoseeinstellungen
enabledLogCategories	string[]	Liste der aktivierten Protokollkategorien
name	string	Name des Ressourcenprofils

NspAccessRuleDirection

Enumeration

Regel für die Zugriffsrichtung

Wert	Beschreibung
Inbound
Outbound

ProvisioningIssue

Objekt

Name	Typ	Beschreibung
name	string	Name des Problems bei der NSP-Bereitstellung
properties	ProvisioningIssueProperties	Eigenschaften des Bereitstellungsproblems

ProvisioningIssueProperties

Objekt

Eigenschaften des Bereitstellungsproblems

Name	Typ	Beschreibung
description	string	Beschreibung des Problems
issueType	string	Art des Problems
severity	string	Schweregrad des Problems
suggestedAccessRules	NetworkSecurityPerimeterAccessRule[]	Optionales Array, vorgeschlagene Zugriffsregeln
suggestedResourceIds	string[] (arm-id)	IDs von Ressourcen, die demselben Umkreis zugeordnet werden können, um das Problem zu beheben.

Subscriptions

Objekt

Abonnements für eingehende Regeln

Name	Typ	Beschreibung
id	string	Vollständig qualifizierte Kennung des Abonnements