Network Security Perimeter Configurations - Get

Service:
Search Management
API-versie:
2025-02-01-preview

Hiermee haalt u een perimeterconfiguratie voor netwerkbeveiliging op.

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

URI-parameters

Name In Vereist Type 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]*$

De naam van de netwerkbeveiligingsconfiguratie.
resourceGroupName
 path True

string

De naam van de resourcegroep binnen het huidige abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
searchServiceName
 path True

string

pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$

De naam van de Azure AI Search-service die is gekoppeld aan de opgegeven resourcegroep.
subscriptionId
 path True

string

De unieke id voor een Microsoft Azure-abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
api-version
 query True

string

De API-versie die voor elke aanvraag moet worden gebruikt.

Antwoorden

Name Type Description
200 OK

NetworkSecurityPerimeterConfiguration

De configuratie is opgehaald.
Other Status Codes

CloudError

Er is een onverwachte fout opgetreden tijdens de bewerking.

Beveiliging

azure_auth

Hiermee geeft u een impliciete toekenningsstroom op, zoals ondersteund op het Microsoft Identity-platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

Get an NSP config by name

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
CloudError

Bevat informatie over een API-fout.
CloudErrorBody

Beschrijft een bepaalde API-fout met een foutcode en een bericht.
NetworkSecurityPerimeterConfiguration

Perimeterconfiguratie voor netwerkbeveiliging voor een server.
NSPConfigAccessRule

Een toegangsregel voor een netwerkbeveiligingsperimeterconfiguratie.
NSPConfigAccessRuleProperties

De eigenschappen voor de toegangsregels in een netwerkbeveiligingsperimeterconfiguratie.
NSPConfigAssociation

De resourcekoppeling voor de netwerkbeveiligingsperimeter.
NSPConfigNetworkSecurityPerimeterRule

De netwerkbeveiligingsperimetereigenschappen die aanwezig zijn in een configuratieregel.
NSPConfigPerimeter

De perimeter voor een netwerkbeveiligingsperimeterconfiguratie.
NSPConfigProfile

Het profiel voor een netwerkbeveiligingsperimeterconfiguratie.
NSPProvisioningIssue

Een object voor het beschrijven van problemen met het inrichten van netwerkbeveiligingsperimeter voor een zoekservice.
NSPProvisioningIssueProperties

De eigenschappen voor het beschrijven van problemen met het inrichten van netwerkbeveiligingsperimeter voor een zoekservice.

CloudError

Object

Bevat informatie over een API-fout.

Name Type Description
error

CloudErrorBody

Beschrijft een bepaalde API-fout met een foutcode en een bericht.
message

string

Een korte beschrijving van de fout die aangeeft wat er fout is gegaan (voor informatie over details/foutopsporing raadpleegt u de eigenschap 'error.message').

CloudErrorBody

Object

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

Name Type Description
code

string

Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt om programmatisch specifieke foutcases af te handelen.
details

CloudErrorBody[]

Bevat geneste fouten die betrekking hebben op deze fout.
message

string

Een bericht met een gedetailleerde beschrijving van de fout en informatie over foutopsporing.
target

string

Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

NetworkSecurityPerimeterConfiguration

Object

Perimeterconfiguratie voor netwerkbeveiliging voor een server.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

De naam van de resource
properties.networkSecurityPerimeter

NSPConfigPerimeter

De perimeter voor een netwerkbeveiligingsperimeterconfiguratie.
properties.profile

NSPConfigProfile

Het profiel voor een netwerkbeveiligingsperimeterconfiguratie.
properties.provisioningIssues

NSPProvisioningIssue[]

Een object voor het beschrijven van problemen met het inrichten van netwerkbeveiligingsperimeter voor een zoekservice.
properties.provisioningState

string

properties.resourceAssociation

NSPConfigAssociation

De resourcekoppeling voor de netwerkbeveiligingsperimeter.
type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

NSPConfigAccessRule

Object

Een toegangsregel voor een netwerkbeveiligingsperimeterconfiguratie.

Name Type Description
name

string

properties

NSPConfigAccessRuleProperties

De eigenschappen voor de toegangsregels in een netwerkbeveiligingsperimeterconfiguratie.

NSPConfigAccessRuleProperties

Object

De eigenschappen voor de toegangsregels in een netwerkbeveiligingsperimeterconfiguratie.

Name Type Description
addressPrefixes

string[]

direction

string

fullyQualifiedDomainNames

string[]

networkSecurityPerimeters

NSPConfigNetworkSecurityPerimeterRule[]

De netwerkbeveiligingsperimetereigenschappen die aanwezig zijn in een configuratieregel.
subscriptions

string[]

NSPConfigAssociation

Object

De resourcekoppeling voor de netwerkbeveiligingsperimeter.

Name Type Description
accessMode

string

name

string

NSPConfigNetworkSecurityPerimeterRule

Object

De netwerkbeveiligingsperimetereigenschappen die aanwezig zijn in een configuratieregel.

Name Type Description
id

string

location

string

perimeterGuid

string

NSPConfigPerimeter

Object

De perimeter voor een netwerkbeveiligingsperimeterconfiguratie.

Name Type Description
id

string

location

string

perimeterGuid

string

NSPConfigProfile

Object

Het profiel voor een netwerkbeveiligingsperimeterconfiguratie.

Name Type Description
accessRules

NSPConfigAccessRule[]

Een toegangsregel voor een netwerkbeveiligingsperimeterconfiguratie.
accessRulesVersion

string

name

string

NSPProvisioningIssue

Object

Een object voor het beschrijven van problemen met het inrichten van netwerkbeveiligingsperimeter voor een zoekservice.

Name Type Description
name

string

properties

NSPProvisioningIssueProperties

De eigenschappen voor het beschrijven van problemen met het inrichten van netwerkbeveiligingsperimeter voor een zoekservice.

NSPProvisioningIssueProperties

Object

De eigenschappen voor het beschrijven van problemen met het inrichten van netwerkbeveiligingsperimeter voor een zoekservice.

Name Type Description
description

string

issueType

string

severity

string

suggestedAccessRules

string[]

suggestedResourceIds

string[]