Network Security Perimeter Configurations - Get

Služba:
Search Management
Verze rozhraní API:
2024-03-01-preview

Získá konfiguraci hraniční sítě.

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

Parametry identifikátoru URI

Název V Vyžadováno 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]*$

Název konfigurace zabezpečení sítě.
resourceGroupName
 path True

string

Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
searchServiceName
 path True

string

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

Název služby Azure AI Search přidružené k zadané skupině prostředků.
subscriptionId
 path True

string

Jedinečný identifikátor předplatného Microsoft Azure. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.
api-version
 query True

string

Verze rozhraní API, která se má použít pro každý požadavek.

Odpovědi

Název Typ Description
200 OK

NetworkSecurityPerimeterConfiguration

Konfigurace se úspěšně načetla.
Other Status Codes

CloudError

Během operace došlo k neočekávané chybě.

Zabezpečení

azure_auth

Určuje implicitní tok udělení, který se podporuje na platformě Microsoft Identity Platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Název Description
user_impersonation zosobnění uživatelského účtu

Příklady

Get an NSP config by name

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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"
            ]
          }
        }
      ]
    }
  }
}

Definice

Název Description
CloudError

Obsahuje informace o chybě rozhraní API.
CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
NetworkSecurityPerimeterConfiguration

Konfigurace hraniční sítě pro server
NSPConfigAccessRule

Pravidlo přístupu pro konfiguraci hraniční sítě.
NSPConfigAccessRuleProperties

Vlastnosti pravidel přístupu v konfiguraci hraniční sítě zabezpečení sítě.
NSPConfigAssociation

Přidružení prostředků pro hraniční síť zabezpečení sítě.
NSPConfigNetworkSecurityPerimeterRule

Vlastnosti hraniční sítě, které jsou přítomné v pravidle konfigurace.
NSPConfigPerimeter

Hraniční síť pro konfiguraci hraniční sítě.
NSPConfigProfile

Profil konfigurace hraniční sítě.
NSPProvisioningIssue

Objekt, který popisuje všechny problémy se zřizováním hraničních sítí pro vyhledávací službu.
NSPProvisioningIssueProperties

Vlastnosti, které popisují všechny problémy se zřizováním hraničních sítí pro vyhledávací službu.

CloudError

Objekt

Obsahuje informace o chybě rozhraní API.

Název Typ Description
error

CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.
message

string

Stručný popis chyby, která naznačuje, co se nepovedlo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message).

CloudErrorBody

Objekt

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Název Typ Description
code

string

Kód chyby, který popisuje chybový stav přesněji než stavový kód HTTP. Dá se použít k programovému zpracování konkrétních případů chyb.
details

CloudErrorBody[]

Obsahuje vnořené chyby, které souvisejí s touto chybou.
message

string

Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.
target

string

Cíl konkrétní chyby (například název vlastnosti v chybě).

NetworkSecurityPerimeterConfiguration

Objekt

Konfigurace hraniční sítě pro server

Název Typ Description
id

string

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Název prostředku
properties.networkSecurityPerimeter

NSPConfigPerimeter

Hraniční síť pro konfiguraci hraniční sítě.
properties.profile

NSPConfigProfile

Profil konfigurace hraniční sítě.
properties.provisioningIssues

NSPProvisioningIssue[]

Objekt, který popisuje všechny problémy se zřizováním hraničních sítí pro vyhledávací službu.
properties.provisioningState

string

properties.resourceAssociation

NSPConfigAssociation

Přidružení prostředků pro hraniční síť zabezpečení sítě.
type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

NSPConfigAccessRule

Objekt

Pravidlo přístupu pro konfiguraci hraniční sítě.

Název Typ Description
name

string

properties

NSPConfigAccessRuleProperties

Vlastnosti pravidel přístupu v konfiguraci hraniční sítě zabezpečení sítě.

NSPConfigAccessRuleProperties

Objekt

Vlastnosti pravidel přístupu v konfiguraci hraniční sítě zabezpečení sítě.

Název Typ Description
addressPrefixes

string[]

direction

string

fullyQualifiedDomainNames

string[]

networkSecurityPerimeters

NSPConfigNetworkSecurityPerimeterRule[]

Vlastnosti hraniční sítě, které jsou přítomné v pravidle konfigurace.
subscriptions

string[]

NSPConfigAssociation

Objekt

Přidružení prostředků pro hraniční síť zabezpečení sítě.

Název Typ Description
accessMode

string

name

string

NSPConfigNetworkSecurityPerimeterRule

Objekt

Vlastnosti hraniční sítě, které jsou přítomné v pravidle konfigurace.

Název Typ Description
id

string

location

string

perimeterGuid

string

NSPConfigPerimeter

Objekt

Hraniční síť pro konfiguraci hraniční sítě.

Název Typ Description
id

string

location

string

perimeterGuid

string

NSPConfigProfile

Objekt

Profil konfigurace hraniční sítě.

Název Typ Description
accessRules

NSPConfigAccessRule[]

Pravidlo přístupu pro konfiguraci hraniční sítě.
accessRulesVersion

string

name

string

NSPProvisioningIssue

Objekt

Objekt, který popisuje všechny problémy se zřizováním hraničních sítí pro vyhledávací službu.

Název Typ Description
name

string

properties

NSPProvisioningIssueProperties

Vlastnosti, které popisují všechny problémy se zřizováním hraničních sítí pro vyhledávací službu.

NSPProvisioningIssueProperties

Objekt

Vlastnosti, které popisují všechny problémy se zřizováním hraničních sítí pro vyhledávací službu.

Název Typ Description
description

string

issueType

string

severity

string

suggestedAccessRules

string[]

suggestedResourceIds

string[]