Stimmen Sie die Netzwerksicherheitsperimeterkonfiguration für den Azure AI Search-Ressourcenanbieter ab. Dadurch wird eine manuelle Neusynchronisierung mit Netzwerksicherheitsperimeterkonfigurationen ausgelöst, indem sichergestellt wird, dass der Suchdienst die neueste Konfiguration aufweist.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/networkSecurityPerimeterConfigurations/{nspConfigName}/reconcile?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 innerhalb des aktuellen Abonnements. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
|
|
searchServiceName
|
path |
True
|
string
|
Der Name der Azure AI-Suchdienst der angegebenen Ressourcengruppe zugeordnet.
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 |
|
202 Accepted
|
|
Abgleichen des Konfigurationsvorgangs für den Netzwerksicherheitsperimeter wurde akzeptiert.
Header
Location: string
|
|
Other Status Codes
|
CloudError
|
Während des Vorgangs ist ein unerwarteter Fehler aufgetreten.
|
Sicherheit
azure_auth
Gibt einen impliziten Gewährungsflow an, der auf der 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
Reconcile NSP Config
Beispielanforderung
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1/reconcile?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_reconcile.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",
)
client.network_security_perimeter_configurations.begin_reconcile(
resource_group_name="rg1",
search_service_name="mysearchservice",
nsp_config_name="00000001-2222-3333-4444-111144444444.assoc1",
).result()
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/NetworkSecurityPerimeterConfigurationsReconcile.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/NetworkSecurityPerimeterConfigurationsReconcile.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 := armsearch.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewNetworkSecurityPerimeterConfigurationsClient().BeginReconcile(ctx, "rg1", "mysearchservice", "00000001-2222-3333-4444-111144444444.assoc1", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
}
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 Reconcile network security perimeter configuration for the Azure AI Search resource provider. This triggers a manual resync with network security perimeter configurations by ensuring the search service carries the latest configuration.
*
* @summary Reconcile network security perimeter configuration for the Azure AI Search resource provider. This triggers a manual resync with network security perimeter configurations by ensuring the search service carries the latest configuration.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/NetworkSecurityPerimeterConfigurationsReconcile.json
*/
async function reconcileNspConfig() {
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.beginReconcileAndWait(
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/NetworkSecurityPerimeterConfigurationsReconcile.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 = "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
await networkSecurityPerimeterConfiguration.ReconcileAsync(WaitUntil.Completed);
Console.WriteLine($"Succeeded");
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
Location: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/locations/westus/AsyncOperationResults/11111111-1111-1111-1111-111111111111
Definitionen
| Name |
Beschreibung |
|
CloudError
|
Enthält Informationen zu einem API-Fehler.
|
|
CloudErrorBody
|
Beschreibt einen bestimmten API-Fehler mit einem Fehlercode und einer Meldung.
|
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 schief gelaufen ist (ausführliche Informationen zum Debuggen 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 detailliert beschreibt und Debuginformationen bereitstellt.
|
|
target
|
string
|
Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).
|