Network Security Perimeter Configurations - Get

Szolgáltatás:: Search Management

API-verzió:: 2024-03-01-preview

Lekéri a hálózati biztonsági szegélykonfigurációt.

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

URI-paraméterek

Név	In	Kötelező	Típus	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]*$	A hálózati biztonsági konfiguráció neve.
resourceGroupName	path	True	string	Az aktuális előfizetésen belüli erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	A megadott erőforráscsoporthoz társított Azure AI Search szolgáltatás neve.
subscriptionId	path	True	string	A Microsoft Azure-előfizetés egyedi azonosítója. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
api-version	query	True	string	Az egyes kérésekhez használandó API-verzió.

Válaszok

Név	Típus	Description
200 OK	NetworkSecurityPerimeterConfiguration	Sikeresen lekérte a konfigurációt.
Other Status Codes	CloudError	Váratlan hiba történt a művelet során.

Biztonság

azure_auth

Implicit engedélyezési folyamatot határoz meg a Microsoft Identity platformon támogatott módon.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Név	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Get an NSP config by name

Mintakérelem

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

Mintaválasz

Állapotkód:: 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"
            ]
          }
        }
      ]
    }
  }
}

Definíciók

Név	Description
CloudError	Api-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
NetworkSecurityPerimeterConfiguration	Kiszolgáló hálózati biztonsági szegélykonfigurációja.
NSPConfigAccessRule	Hozzáférési szabály egy hálózati biztonsági szegélykonfigurációhoz.
NSPConfigAccessRuleProperties	A hálózati biztonsági szegélykonfiguráció hozzáférési szabályainak tulajdonságai.
NSPConfigAssociation	A hálózati biztonsági szegély erőforrás-társítása.
NSPConfigNetworkSecurityPerimeterRule	A konfigurációs szabályban található hálózati biztonsági szegélytulajdonságok.
NSPConfigPerimeter	A hálózati biztonsági szegélykonfiguráció szegélye.
NSPConfigProfile	A hálózati biztonsági szegélykonfiguráció profilja.
NSPProvisioningIssue	Egy objektum, amely leírja a keresési szolgáltatás hálózati biztonsági szegélyeinek kiépítésével kapcsolatos problémákat.
NSPProvisioningIssueProperties	A keresési szolgáltatás hálózati biztonsági szegélyeinek kiépítésével kapcsolatos problémákat leíró tulajdonságok.

CloudError

Tárgy

Api-hibával kapcsolatos információkat tartalmaz.

Név	Típus	Description
error	CloudErrorBody	Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.
message	string	A hiba rövid leírása, amely arra utal, hogy mi történt (a részletekért/hibakeresési információkért tekintse meg a "error.message" tulajdonságot).

CloudErrorBody

Tárgy

Egy adott API-hibát ír le egy hibakóddal és egy üzenettel.

Név	Típus	Description
code	string	Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaeseteket programozott módon is kezelhet.
details	CloudErrorBody[]	Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
message	string	A hibát részletesen leíró és hibakeresési információkat tartalmazó üzenet.
target	string	Az adott hiba célja (például a hiba tulajdonságának neve).

NetworkSecurityPerimeterConfiguration

Tárgy

Kiszolgáló hálózati biztonsági szegélykonfigurációja.

Név	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.networkSecurityPerimeter	NSPConfigPerimeter	A hálózati biztonsági szegélykonfiguráció szegélye.
properties.profile	NSPConfigProfile	A hálózati biztonsági szegélykonfiguráció profilja.
properties.provisioningIssues	NSPProvisioningIssue[]	Egy objektum, amely leírja a keresési szolgáltatás hálózati biztonsági szegélyeinek kiépítésével kapcsolatos problémákat.
properties.provisioningState	string
properties.resourceAssociation	NSPConfigAssociation	A hálózati biztonsági szegély erőforrás-társítása.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

NSPConfigAccessRule

Tárgy

Hozzáférési szabály egy hálózati biztonsági szegélykonfigurációhoz.

Név	Típus	Description
name	string
properties	NSPConfigAccessRuleProperties	A hálózati biztonsági szegélykonfiguráció hozzáférési szabályainak tulajdonságai.

NSPConfigAccessRuleProperties

Tárgy

A hálózati biztonsági szegélykonfiguráció hozzáférési szabályainak tulajdonságai.

Név	Típus	Description
addressPrefixes	string[]
direction	string
fullyQualifiedDomainNames	string[]
networkSecurityPerimeters	NSPConfigNetworkSecurityPerimeterRule[]	A konfigurációs szabályban található hálózati biztonsági szegélytulajdonságok.
subscriptions	string[]

NSPConfigAssociation

Tárgy

A hálózati biztonsági szegély erőforrás-társítása.

Név	Típus	Description
accessMode	string
name	string

NSPConfigNetworkSecurityPerimeterRule

Tárgy

A konfigurációs szabályban található hálózati biztonsági szegélytulajdonságok.

Név	Típus	Description
id	string
location	string
perimeterGuid	string

NSPConfigPerimeter

Tárgy

A hálózati biztonsági szegélykonfiguráció szegélye.

Név	Típus	Description
id	string
location	string
perimeterGuid	string

NSPConfigProfile

Tárgy

A hálózati biztonsági szegélykonfiguráció profilja.

Név	Típus	Description
accessRules	NSPConfigAccessRule[]	Hozzáférési szabály egy hálózati biztonsági szegélykonfigurációhoz.
accessRulesVersion	string
name	string

NSPProvisioningIssue

Tárgy

Egy objektum, amely leírja a keresési szolgáltatás hálózati biztonsági szegélyeinek kiépítésével kapcsolatos problémákat.

Név	Típus	Description
name	string
properties	NSPProvisioningIssueProperties	A keresési szolgáltatás hálózati biztonsági szegélyeinek kiépítésével kapcsolatos problémákat leíró tulajdonságok.

NSPProvisioningIssueProperties

Tárgy

A keresési szolgáltatás hálózati biztonsági szegélyeinek kiépítésével kapcsolatos problémákat leíró tulajdonságok.

Név	Típus	Description
description	string
issueType	string
severity	string
suggestedAccessRules	string[]
suggestedResourceIds	string[]