Network Security Perimeter Configurations - Get

Tjänst:: Search Management

API-version:: 2025-02-01-preview

Hämtar en nätverkssäkerhetsperimeterkonfiguration.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
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]*$	Namnet på nätverkssäkerhetskonfigurationen.
resourceGroupName	path	True	string	Namnet på resursgruppen i den aktuella prenumerationen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Namnet på azure AI Search-tjänsten som är associerad med den angivna resursgruppen.
subscriptionId	path	True	string	Den unika identifieraren för en Microsoft Azure-prenumeration. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
api-version	query	True	string	DEN API-version som ska användas för varje begäran.

Svar

Name	Typ	Description
200 OK	NetworkSecurityPerimeterConfiguration	Konfigurationen har hämtats.
Other Status Codes	CloudError	Ett oväntat fel uppstod under åtgärden.

Säkerhet

azure_auth

Anger ett implicit beviljandeflöde som stöds på Microsoft Identity-plattformen.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get an NSP config by name

Exempelbegäran

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations/00000001-2222-3333-4444-111144444444.assoc1?api-version=2025-02-01-preview

Exempelsvar

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

Definitioner

Name	Description
CloudError	Innehåller information om ett API-fel.
CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
NetworkSecurityPerimeterConfiguration	Nätverkssäkerhetsperimeterkonfiguration för en server.
NSPConfigAccessRule	En åtkomstregel för en nätverkssäkerhetsperimeterkonfiguration.
NSPConfigAccessRuleProperties	Egenskaperna för åtkomstreglerna i en nätverkssäkerhetsperimeterkonfiguration.
NSPConfigAssociation	Resursassociationen för nätverkssäkerhetsperimetern.
NSPConfigNetworkSecurityPerimeterRule	Egenskaperna för nätverkssäkerhetsperimetern som finns i en konfigurationsregel.
NSPConfigPerimeter	Perimetern för en nätverkssäkerhetsperimeterkonfiguration.
NSPConfigProfile	Profilen för en nätverkssäkerhetsperimeterkonfiguration.
NSPProvisioningIssue	Ett objekt som beskriver eventuella problem med att etablera nätverkssäkerhetsperimeter till en söktjänst.
NSPProvisioningIssueProperties	Egenskaperna för att beskriva eventuella problem med etablering av nätverkssäkerhetsperimeter till en söktjänst.

CloudError

Objekt

Innehåller information om ett API-fel.

Name	Typ	Description
error	CloudErrorBody	Beskriver ett visst API-fel med en felkod och ett meddelande.
message	string	En kort beskrivning av felet som antyder vad som gick fel (mer information/felsökningsinformation finns i egenskapen "error.message").

CloudErrorBody

Objekt

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name	Typ	Description
code	string	En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.
details	CloudErrorBody[]	Innehåller kapslade fel som är relaterade till det här felet.
message	string	Ett meddelande som beskriver felet i detalj och ger felsökningsinformation.
target	string	Målet för det specifika felet (till exempel namnet på egenskapen i fel).

NetworkSecurityPerimeterConfiguration

Objekt

Nätverkssäkerhetsperimeterkonfiguration för en server.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.networkSecurityPerimeter	NSPConfigPerimeter	Perimetern för en nätverkssäkerhetsperimeterkonfiguration.
properties.profile	NSPConfigProfile	Profilen för en nätverkssäkerhetsperimeterkonfiguration.
properties.provisioningIssues	NSPProvisioningIssue[]	Ett objekt som beskriver eventuella problem med att etablera nätverkssäkerhetsperimeter till en söktjänst.
properties.provisioningState	string
properties.resourceAssociation	NSPConfigAssociation	Resursassociationen för nätverkssäkerhetsperimetern.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

NSPConfigAccessRule

Objekt

En åtkomstregel för en nätverkssäkerhetsperimeterkonfiguration.

Name	Typ	Description
name	string
properties	NSPConfigAccessRuleProperties	Egenskaperna för åtkomstreglerna i en nätverkssäkerhetsperimeterkonfiguration.

NSPConfigAccessRuleProperties

Objekt

Egenskaperna för åtkomstreglerna i en nätverkssäkerhetsperimeterkonfiguration.

Name	Typ	Description
addressPrefixes	string[]
direction	string
fullyQualifiedDomainNames	string[]
networkSecurityPerimeters	NSPConfigNetworkSecurityPerimeterRule[]	Egenskaperna för nätverkssäkerhetsperimetern som finns i en konfigurationsregel.
subscriptions	string[]

NSPConfigAssociation

Objekt

Resursassociationen för nätverkssäkerhetsperimetern.

Name	Typ	Description
accessMode	string
name	string

NSPConfigNetworkSecurityPerimeterRule

Objekt

Egenskaperna för nätverkssäkerhetsperimetern som finns i en konfigurationsregel.

Name	Typ	Description
id	string
location	string
perimeterGuid	string

NSPConfigPerimeter

Objekt

Perimetern för en nätverkssäkerhetsperimeterkonfiguration.

Name	Typ	Description
id	string
location	string
perimeterGuid	string

NSPConfigProfile

Objekt

Profilen för en nätverkssäkerhetsperimeterkonfiguration.

Name	Typ	Description
accessRules	NSPConfigAccessRule[]	En åtkomstregel för en nätverkssäkerhetsperimeterkonfiguration.
accessRulesVersion	string
name	string

NSPProvisioningIssue

Objekt

Ett objekt som beskriver eventuella problem med att etablera nätverkssäkerhetsperimeter till en söktjänst.

Name	Typ	Description
name	string
properties	NSPProvisioningIssueProperties	Egenskaperna för att beskriva eventuella problem med etablering av nätverkssäkerhetsperimeter till en söktjänst.

NSPProvisioningIssueProperties

Objekt

Egenskaperna för att beskriva eventuella problem med etablering av nätverkssäkerhetsperimeter till en söktjänst.

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