Policy - Create Or Update

Cria ou atualiza a configuração de política global do serviço de Gerenciamento de API.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/policy?api-version=2020-12-01

Parâmetros de URI

Name In Required Type Description
policyId
path True

O identificador da política.

resourceGroupName
path True
  • string

O nome do grupo de recursos.

serviceName
path True
  • string

O nome do serviço de gerenciamento de API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

credenciais de assinatura que identificam exclusivamente Microsoft Azure assinatura. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão da API a ser usada com a solicitação do cliente.

Cabeçalho da solicitação

Name Required Type Description
If-Match
  • string

ETag da entidade. Não é necessário ao criar uma entidade, mas é necessário ao atualizar uma entidade.

Corpo da solicitação

Name Required Type Description
properties.value True
  • string

Conteúdo da política, conforme definido pelo formato.

properties.format

Formato do policyContent.

Respostas

Name Type Description
200 OK

A configuração de política global do serviço de gerenciamento de API foi atualizada com êxito.

Headers

  • ETag: string
201 Created

A configuração de política global foi criada com êxito.

Headers

  • ETag: string
Other Status Codes

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

Segurança

azure_auth

Azure Active Directory Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementCreatePolicy

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy?api-version=2020-12-01
{
  "properties": {
    "format": "xml",
    "value": "<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>"
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy",
  "type": "Microsoft.ApiManagement/service/policies",
  "name": "policy",
  "properties": {
    "value": "<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy",
  "type": "Microsoft.ApiManagement/service/policies",
  "name": "policy",
  "properties": {
    "value": "<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>"
  }
}

Definições

ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta de erro.

PolicyContentFormat

Formato do policyContent.

PolicyContract

Detalhes do contrato de política.

PolicyIdName

O identificador da política.

ErrorFieldContract

Contrato de campo de erro.

Name Type Description
code
  • string

Código de erro no nível da propriedade.

message
  • string

Representação legível do erro no nível da propriedade.

target
  • string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Name Type 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 enviar em solicitação, no caso de erro de validação.

error.message
  • string

Representação legível ao olho humano do erro.

PolicyContentFormat

Formato do policyContent.

Name Type Description
rawxml
  • string

O conteúdo é 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 é hospedado em um ponto de extremidade http acessível do serviço de gerenciamento de API.

xml
  • string

O conteúdo é 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 do serviço de gerenciamento de API.

PolicyContract

Detalhes do contrato de política.

Name Type Description
id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.format

Formato do policyContent.

properties.value
  • string

Conteúdo da política, conforme definido pelo formato.

type
  • string

Tipo de recurso para o recurso de gerenciamento de API.

PolicyIdName

O identificador da política.

Name Type Description
policy
  • string