Policy - List By Service
Lista todas as definições de política global do serviço de Gerenciamento de API.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies?api-version=2022-08-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. |
service
|
path | True |
string |
O nome do serviço Gerenciamento de API. Padrão Regex: |
subscription
|
path | True |
string |
A ID da assinatura de destino. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Retorna uma matriz de Contratos de Política. |
|
Other Status Codes |
Resposta de erro que descreve por que a operação falhou. |
Segurança
azure_auth
Fluxo OAuth2 do Azure Active Directory.
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
ApiManagementListPolicies
Solicitação de exemplo
Resposta de exemplo
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy",
"type": "Microsoft.ApiManagement/service/policies",
"name": "policy",
"properties": {
"value": "<!--\r\n IMPORTANT:\r\n - Policy elements can appear only within the <inbound>, <outbound>, <backend> section elements.\r\n - Only the <forward-request> policy element can appear within the <backend> section element.\r\n - To apply a policy to the incoming request (before it is forwarded to the backend service), place a corresponding policy element within the <inbound> section element.\r\n - To apply a policy to the outgoing response (before it is sent back to the caller), place a corresponding policy element within the <outbound> section element.\r\n - To add a policy position the cursor at the desired insertion point and click on the round button associated with the policy.\r\n - To remove a policy, delete the corresponding policy statement from the policy document.\r\n - Policies are applied in the order of their appearance, from the top down.\r\n-->\r\n<policies>\r\n <inbound />\r\n <backend>\r\n <forward-request />\r\n </backend>\r\n <outbound />\r\n</policies>"
}
}
],
"count": 1,
"nextLink": ""
}
Definições
Nome | Description |
---|---|
Error |
Contrato de campo de erro. |
Error |
Resposta de erro. |
Policy |
A resposta da operação de política de lista. |
Policy |
Formato da policyContent. |
Policy |
Detalhes do contrato de política. |
ErrorFieldContract
Contrato de campo de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código de erro no nível da propriedade. |
message |
string |
Representação legível por humanos do erro no nível da propriedade. |
target |
string |
Nome da propriedade. |
ErrorResponse
Resposta de erro.
Nome | Tipo | Description |
---|---|---|
error.code |
string |
Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta. |
error.details |
A lista de campos inválidos enviados na solicitação, em caso de erro de validação. |
|
error.message |
string |
Representação legível ao olho humano do erro. |
PolicyCollection
A resposta da operação de política de lista.
Nome | Tipo | Description |
---|---|---|
count |
integer |
Número total de contagem de registros. |
nextLink |
string |
Próximo link da página, se houver. |
value |
Valor do contrato de política. |
PolicyContentFormat
Formato da policyContent.
Nome | Tipo | Description |
---|---|---|
rawxml |
string |
O conteúdo está embutido e o Tipo de conteúdo é um documento de política não codificado em XML. |
rawxml-link |
string |
O documento de política não é codificado em XML e está hospedado em um ponto de extremidade HTTP acessível do serviço Gerenciamento de API. |
xml |
string |
O conteúdo está embutido e o Tipo de conteúdo é um documento XML. |
xml-link |
string |
O documento XML de política é hospedado em um ponto de extremidade HTTP acessível a partir do serviço Gerenciamento de API. |
PolicyContract
Detalhes do contrato de política.
Nome | Tipo | Valor padrão | 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.format | xml |
Formato da policyContent. |
|
properties.value |
string |
Conteúdo da Política conforme definido pelo formato. |
|
type |
string |
Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |