Sdílet prostřednictvím

Network Security Perimeter Configurations - List By Service

  • Reference
Služba:
Search Management
Verze rozhraní API:
2024-06-01-preview

Získá seznam konfigurací zabezpečení sítě pro vyhledávací službu.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
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

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

Vzor regulárního výrazu: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$
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

Name Typ Description
200 OK

NetworkSecurityPerimeterConfigurationListResult

Seznam konfigurací se úspěšně načetl.
Other Status Codes

CloudError

Během provozu 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

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

List NSP configs by search service

Ukázkový požadavek

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/networkSecurityPerimeterConfigurations?api-version=2024-06-01-preview

Ukázková odpověď

Stavový kód:
200 
{
  "value": [
    {
      "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

Name 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.
NetworkSecurityPerimeterConfigurationListResult

Seznam konfigurací 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í.
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 pro konfiguraci hraniční sítě zabezpečení sítě.
NSPProvisioningIssue

Objekt popisující všechny problémy se zřizováním bezpečnostních perimetrů sítě pro vyhledávací službu.
NSPProvisioningIssueProperties

Vlastnosti popisující případné problémy se zřizováním bezpečnostních perimetrů sítě pro vyhledávací službu.

CloudError

Obsahuje informace o chybě rozhraní API.

Name 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 pokazilo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message).

CloudErrorBody

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

Name Typ Description
code

string

Kód chyby, který popisuje chybovou podmínku přesněji než stavový kód HTTP. Dá se použít ke zpracování konkrétních případů chyb prostřednictvím kódu programu.
details

CloudErrorBody[]

Obsahuje vnořené chyby, které s touto chybou souvisejí.
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

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

Name Typ Description
id

string

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
name

string

Název prostředku
properties.networkSecurityPerimeter

NSPConfigPerimeter

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

NSPConfigProfile

Profil pro konfiguraci hraniční sítě zabezpečení sítě.
properties.provisioningIssues

NSPProvisioningIssue[]

Objekt popisující všechny problémy se zřizováním bezpečnostních perimetrů sítě pro vyhledávací službu.
properties.provisioningState

string

properties.resourceAssociation

NSPConfigAssociation

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

string

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

NetworkSecurityPerimeterConfigurationListResult

Seznam konfigurací hraniční sítě pro server.

Name Typ Description
nextLink

string

Odkaz na načtení další stránky výsledků
value

NetworkSecurityPerimeterConfiguration[]

Pole výsledků

NSPConfigAccessRule

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

Name Typ Description
name

string

properties

NSPConfigAccessRuleProperties

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

NSPConfigAccessRuleProperties

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

Name 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

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

Name Typ Description
accessMode

string

name

string

NSPConfigNetworkSecurityPerimeterRule

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

Name Typ Description
id

string

location

string

perimeterGuid

string

NSPConfigPerimeter

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

Name Typ Description
id

string

location

string

perimeterGuid

string

NSPConfigProfile

Profil pro konfiguraci hraniční sítě zabezpečení sítě.

Name Typ Description
accessRules

NSPConfigAccessRule[]

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

string

name

string

NSPProvisioningIssue

Objekt popisující všechny problémy se zřizováním bezpečnostních perimetrů sítě pro vyhledávací službu.

Name Typ Description
name

string

properties

NSPProvisioningIssueProperties

Vlastnosti popisující případné problémy se zřizováním bezpečnostních perimetrů sítě pro vyhledávací službu.

NSPProvisioningIssueProperties

Vlastnosti popisující případné problémy se zřizováním bezpečnostních perimetrů sítě pro vyhledávací službu.

Name Typ Description
description

string

issueType

string

severity

string

suggestedAccessRules

string[]

suggestedResourceIds

string[]