Workspace Policy - Get

Referência

Serviço:: API Management

Versão da API:: 2024-05-01

Obtenha a configuração de política no nível da API.

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

Com parâmetros opcionais:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/policies/policy?format={format}&api-version=2024-05-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
policyId	path	True	PolicyIdName	O identificador da Política.
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 uma UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificador de workspace. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
format	query		PolicyExportFormat	Formato de exportação de política.

Respostas

Nome	Tipo	Description
200 OK	PolicyContract	Informações da Política de Workspace. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Nome

Tipo

Description

200 OK

PolicyContract

Informações da Política de Workspace.

Cabeçalhos

ETag: string

Other Status Codes

ErrorResponse

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

ApiManagementGetWorkspacePolicy

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policies/policy",
  "type": "Microsoft.ApiManagement/service/workspaces/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    - Position the <base> element within a section element to inherit all policies from the corresponding section element in the enclosing scope.\r\n    - Remove the <base> element to prevent inheriting policies from the corresponding section element in the enclosing scope.\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    <quota-by-key calls=\"5\" bandwidth=\"2\" renewal-period=\"&#x9;P3Y6M4DT12H30M5S\" counter-key=\"ba\" />\r\n    <base />\r\n  </inbound>\r\n  <backend>\r\n    <base />\r\n  </backend>\r\n  <outbound>\r\n    <log-to-eventhub logger-id=\"apimService1\" partition-key=\"@(context.Subscription.Id)\">\r\n@{\r\n\tRandom Random = new Random();\r\n\t\t\t\tconst string Chars = \"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz \";                \r\n                return string.Join(\",\", DateTime.UtcNow, new string(\r\n                    Enumerable.Repeat(Chars, Random.Next(2150400))\r\n                              .Select(s =&gt; s[Random.Next(s.Length)])\r\n                              .ToArray()));\r\n          }                           \r\n                        </log-to-eventhub>\r\n    <base />\r\n  </outbound>\r\n</policies>"
  }
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
PolicyContentFormat	Formato do policyContent.
PolicyContract	Detalhes do Contrato de Política.
PolicyExportFormat	Formato de exportação de política.
PolicyIdName	O identificador da Política.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

PolicyContentFormat

Enumeração

Formato do policyContent.

Valor	Description
rawxml	O conteúdo está embutido e o tipo de conteúdo é um documento de política não codificado em XML.
rawxml-link	O documento de política não é codificado em XML e está hospedado em um ponto de extremidade HTTP acessível no serviço de Gerenciamento de API.
xml	O conteúdo está embutido e o tipo de conteúdo é um documento XML.
xml-link	O documento XML de política é hospedado em um ponto de extremidade HTTP acessível do serviço de Gerenciamento de API.

PolicyContract

Objeto

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	PolicyContentFormat	xml	Formato do policyContent.
properties.value	string		Conteúdo da Política conforme definido pelo formato.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PolicyExportFormat

Enumeração

Formato de exportação de política.

Valor	Description
rawxml	O conteúdo está embutido e o tipo de conteúdo é um documento de política não codificado em XML.
xml	O conteúdo está embutido e o tipo de conteúdo é um documento XML.

PolicyIdName

Enumeração

O identificador da Política.

Valor	Description
policy

Compartilhar via

Workspace Policy - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

ApiManagementGetWorkspacePolicy

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PolicyContentFormat

PolicyContract

PolicyExportFormat

PolicyIdName

Recursos adicionais