Workspace Policy - Get

Serviço:: API Management

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

Obtenha a configuração da 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 do URI

Name	Em	Necessá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 um UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
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íticas.

Respostas

Name	Tipo	Description
200 OK	PolicyContract	Informações sobre a política do espaço de trabalho. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Name

Tipo

Description

200 OK

PolicyContract

Informações sobre a política do espaço de trabalho.

Cabeçalhos

ETag: string

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

ApiManagementGetWorkspacePolicy

Pedido de amostra

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 da amostra

Código de estado:: 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

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
PolicyContentFormat	Formato da políticaContent.
PolicyContract	Detalhes do contrato da apólice.
PolicyExportFormat	Formato de exportação de políticas.
PolicyIdName	O identificador da 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.

PolicyContentFormat

Enumeração

Formato da políticaContent.

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

PolicyContract

Object

Detalhes do contrato da apólice.

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.format	PolicyContentFormat	xml	Formato da políticaContent.
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íticas.

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

PolicyIdName

Enumeração

O identificador da Política.

Valor	Description
policy

Partilhar via

Workspace Policy - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ApiManagementGetWorkspacePolicy

Pedido de amostra

Resposta da amostra

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PolicyContentFormat

PolicyContract

PolicyExportFormat

PolicyIdName