Network Security Perimeter Configurations - Get

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 minLength: 38 maxLength: 100 pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\.[a-z][a-z0-9]*$	Der Name der Netzwerksicherheitskonfiguration.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Der Name des Azure AI Search-Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.
subscriptionId	path	True	string	Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
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	Unerwarteter Fehler während des Vorgangs.

Sicherheit

azure_auth

Gibt einen impliziten Genehmigungsfluss 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

Get an NSP config by name

Beispielanforderung

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

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	Netzwerksicherheitsperimeterkonfiguration für einen Server.
NSPConfigAccessRule	Eine Zugriffsregel für eine Netzwerksicherheitsperimeterkonfiguration.
NSPConfigAccessRuleProperties	Die Eigenschaften für die Zugriffsregeln in einer Netzwerksicherheitsperimeterkonfiguration.
NSPConfigAssociation	Die Ressourcenzuordnung für den Netzwerksicherheitsperimeter.
NSPConfigNetworkSecurityPerimeterRule	Die Netzwerksicherheitsperimetereigenschaften, die in einer Konfigurationsregel vorhanden sind.
NSPConfigPerimeter	Der Umkreis für eine Netzwerksicherheitsperimeterkonfiguration.
NSPConfigProfile	Das Profil für eine Netzwerksicherheitsperimeterkonfiguration.
NSPProvisioningIssue	Ein Objekt, das Alle Probleme mit der Bereitstellung von Netzwerksicherheitsperimetern für einen Suchdienst beschreibt.
NSPProvisioningIssueProperties	Die Eigenschaften zum Beschreiben von Problemen mit der Bereitstellung von Netzwerksicherheitsperimetern für einen Suchdienst.

CloudError

Objekt

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, der darauf hinweist, was schief gelaufen ist (details/Debugginginformationen beziehen sich auf die Eigenschaft "error.message").

CloudErrorBody

Objekt

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-Statuscode. Kann verwendet werden, um bestimmte Fehlerfälle programmgesteuert zu behandeln.
details	CloudErrorBody[]	Enthält geschachtelte Fehler, die mit diesem Fehler zusammenhängen.
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).

NetworkSecurityPerimeterConfiguration

Objekt

Netzwerksicherheitsperimeterkonfiguration für einen Server.

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.networkSecurityPerimeter	NSPConfigPerimeter	Der Umkreis für eine Netzwerksicherheitsperimeterkonfiguration.
properties.profile	NSPConfigProfile	Das Profil für eine Netzwerksicherheitsperimeterkonfiguration.
properties.provisioningIssues	NSPProvisioningIssue[]	Ein Objekt, das Alle Probleme mit der Bereitstellung von Netzwerksicherheitsperimetern für einen Suchdienst beschreibt.
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

Objekt

Eine Zugriffsregel für eine Netzwerksicherheitsperimeterkonfiguration.

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

NSPConfigAccessRuleProperties

Objekt

Die Eigenschaften für die Zugriffsregeln in einer Netzwerksicherheitsperimeterkonfiguration.

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

NSPConfigAssociation

Objekt

Die Ressourcenzuordnung für den Netzwerksicherheitsperimeter.

Name	Typ	Beschreibung
accessMode	string
name	string

NSPConfigNetworkSecurityPerimeterRule

Objekt

Die Netzwerksicherheitsperimetereigenschaften, die in einer Konfigurationsregel vorhanden sind.

Name	Typ	Beschreibung
id	string
location	string
perimeterGuid	string

NSPConfigPerimeter

Objekt

Der Umkreis für eine Netzwerksicherheitsperimeterkonfiguration.

Name	Typ	Beschreibung
id	string
location	string
perimeterGuid	string

NSPConfigProfile

Objekt

Das Profil für eine Netzwerksicherheitsperimeterkonfiguration.

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

NSPProvisioningIssue

Objekt

Ein Objekt, das Alle Probleme mit der Bereitstellung von Netzwerksicherheitsperimetern für einen Suchdienst beschreibt.

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

NSPProvisioningIssueProperties

Objekt

Die Eigenschaften zum Beschreiben von Problemen mit der Bereitstellung von Netzwerksicherheitsperimetern für einen Suchdienst.

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