Partilhar via

Policy Restriction - List By Service

  • Referência
Serviço:
API Management
Versão da API:
2024-05-01

Obtém todas as restrições de política dos serviços de Gerenciamento de API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyRestrictions?api-version=2024-05-01

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

O nome do serviço de Gerenciamento de API.
subscriptionId
 path True

string (uuid)

A ID da assinatura de destino. O valor deve ser um UUID.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Respostas

Name Tipo Description
200 OK

PolicyRestrictionCollection

Retorna uma matriz de Restrições de política.
Other Status Codes

ErrorResponse

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

ApiManagementListPolicyRestrictions

Pedido de amostra

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions?api-version=2024-05-01

Resposta da amostra

Código de estado:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1",
      "type": "Microsoft.ApiManagement/service/policyRestrictions",
      "name": "policyRestriction1",
      "properties": {
        "scope": "Sample Path to the policy document.",
        "requireBase": "true"
      }
    }
  ],
  "nextLink": ""
}

Definições

Name Description
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
PolicyRestrictionCollection

A resposta da operação get policy stricts.
PolicyRestrictionContract

Detalhes do contrato de restrição de política.
PolicyRestrictionRequireBase

Indica se a política base deve ser imposta para o documento de política.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

PolicyRestrictionCollection

Object

A resposta da operação get policy stricts.

Name Tipo Description
nextLink

string

Link da próxima página, se houver.
value

PolicyRestrictionContract[]

Detalhes do contrato de restrição de política.

PolicyRestrictionContract

Object

Detalhes do contrato de restrição de política.

Name Tipo Default value Description
id

string

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

string

O nome do recurso
properties.requireBase

PolicyRestrictionRequireBase

false

Indica se a política base deve ser imposta para o documento de política.
properties.scope

string

Caminho para o documento de política.
type

string

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

PolicyRestrictionRequireBase

Enumeração

Indica se a política base deve ser imposta para o documento de política.

Valor Description
false

A política não requer ter uma política de base
true

A política é necessária para ter uma política de base