Network Security Perimeter Configurations - Get

Serviço:
Search Management
Versão da API:
2025-02-01-preview

Obtém uma configuração de perímetro de segurança de rede.

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

Parâmetros de URI

Nome Em Obrigatório Tipo 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]*$

O nome da configuração de segurança de rede.
resourceGroupName
 path True

string

O nome do grupo de recursos na assinatura atual. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
searchServiceName
 path True

string

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

O nome do serviço Azure AI Search associado ao grupo de recursos especificado.
subscriptionId
 path True

string

O identificador exclusivo de uma assinatura do Microsoft Azure. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
api-version
 query True

string

A versão da API a ser usada para cada solicitação.

Respostas

Nome Tipo Description
200 OK

NetworkSecurityPerimeterConfiguration

Recuperou a configuração com êxito.
Other Status Codes

CloudError

Ocorreu um erro inesperado durante a operação.

Segurança

azure_auth

Especifica um fluxo de concessão implícito, conforme suportado na plataforma Microsoft Identity.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Get an NSP config by name

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
            ]
          }
        }
      ]
    }
  }
}

Definições

Nome Description
CloudError

Contém informações sobre um erro de API.
CloudErrorBody

Descreve um erro de API específico com um código de erro e uma mensagem.
NetworkSecurityPerimeterConfiguration

Configuração de perímetro de segurança de rede para um servidor.
NSPConfigAccessRule

Uma regra de acesso para uma configuração de perímetro de segurança de rede.
NSPConfigAccessRuleProperties

As propriedades das regras de acesso em uma configuração de perímetro de segurança de rede.
NSPConfigAssociation

A associação de recursos para o perímetro de segurança de rede.
NSPConfigNetworkSecurityPerimeterRule

As propriedades de perímetro de segurança de rede presentes em uma regra de configuração.
NSPConfigPerimeter

O perímetro de uma configuração de perímetro de segurança de rede.
NSPConfigProfile

O perfil de uma configuração de perímetro de segurança de rede.
NSPProvisioningIssue

Um objeto para descrever quaisquer problemas com o provisionamento de perímetros de segurança de rede para um serviço de pesquisa.
NSPProvisioningIssueProperties

As propriedades para descrever quaisquer problemas com o provisionamento de perímetros de segurança de rede para um serviço de pesquisa.

CloudError

Objeto

Contém informações sobre um erro de API.

Nome Tipo Description
error

CloudErrorBody

Descreve um erro de API específico com um código de erro e uma mensagem.
message

string

Uma breve descrição do erro que indica o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

Objeto

Descreve um erro de API específico com um código de erro e uma mensagem.

Nome Tipo Description
code

string

Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
details

CloudErrorBody[]

Contém erros aninhados relacionados a esse erro.
message

string

Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target

string

O destino do erro específico (por exemplo, o nome da propriedade em erro).

NetworkSecurityPerimeterConfiguration

Objeto

Configuração de perímetro de segurança de rede para um servidor.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

O nome do recurso
properties.networkSecurityPerimeter

NSPConfigPerimeter

O perímetro de uma configuração de perímetro de segurança de rede.
properties.profile

NSPConfigProfile

O perfil de uma configuração de perímetro de segurança de rede.
properties.provisioningIssues

NSPProvisioningIssue[]

Um objeto para descrever quaisquer problemas com o provisionamento de perímetros de segurança de rede para um serviço de pesquisa.
properties.provisioningState

string

properties.resourceAssociation

NSPConfigAssociation

A associação de recursos para o perímetro de segurança de rede.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

NSPConfigAccessRule

Objeto

Uma regra de acesso para uma configuração de perímetro de segurança de rede.

Nome Tipo Description
name

string

properties

NSPConfigAccessRuleProperties

As propriedades das regras de acesso em uma configuração de perímetro de segurança de rede.

NSPConfigAccessRuleProperties

Objeto

As propriedades das regras de acesso em uma configuração de perímetro de segurança de rede.

Nome Tipo Description
addressPrefixes

string[]

direction

string

fullyQualifiedDomainNames

string[]

networkSecurityPerimeters

NSPConfigNetworkSecurityPerimeterRule[]

As propriedades de perímetro de segurança de rede presentes em uma regra de configuração.
subscriptions

string[]

NSPConfigAssociation

Objeto

A associação de recursos para o perímetro de segurança de rede.

Nome Tipo Description
accessMode

string

name

string

NSPConfigNetworkSecurityPerimeterRule

Objeto

As propriedades de perímetro de segurança de rede presentes em uma regra de configuração.

Nome Tipo Description
id

string

location

string

perimeterGuid

string

NSPConfigPerimeter

Objeto

O perímetro de uma configuração de perímetro de segurança de rede.

Nome Tipo Description
id

string

location

string

perimeterGuid

string

NSPConfigProfile

Objeto

O perfil de uma configuração de perímetro de segurança de rede.

Nome Tipo Description
accessRules

NSPConfigAccessRule[]

Uma regra de acesso para uma configuração de perímetro de segurança de rede.
accessRulesVersion

string

name

string

NSPProvisioningIssue

Objeto

Um objeto para descrever quaisquer problemas com o provisionamento de perímetros de segurança de rede para um serviço de pesquisa.

Nome Tipo Description
name

string

properties

NSPProvisioningIssueProperties

As propriedades para descrever quaisquer problemas com o provisionamento de perímetros de segurança de rede para um serviço de pesquisa.

NSPProvisioningIssueProperties

Objeto

As propriedades para descrever quaisquer problemas com o provisionamento de perímetros de segurança de rede para um serviço de pesquisa.

Nome Tipo Description
description

string

issueType

string

severity

string

suggestedAccessRules

string[]

suggestedResourceIds

string[]