Compartilhar via


Policy Fragment - Create Or Update

Criar ou atualizar um fragmento de política.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments/{id}?api-version=2022-08-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
id
path True

string

Um identificador de recurso.

Padrão Regex: (^[\w]+$)|(^[\w][\w\-]+[\w]$)

resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName
path True

string

O nome do serviço Gerenciamento de API.

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

subscriptionId
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.

Cabeçalho da solicitação

Nome Obrigatório Tipo 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

Nome Obrigatório Tipo Description
properties.value True

string

Conteúdo do fragmento de política.

properties.description

string

Descrição do fragmento de política.

properties.format

PolicyFragmentContentFormat

Formato do conteúdo do fragmento de política.

Respostas

Nome Tipo Description
200 OK

PolicyFragmentContract

O fragmento de política foi atualizado com êxito.

Cabeçalhos

ETag: string

201 Created

PolicyFragmentContract

O fragmento de política foi criado com êxito.

Cabeçalhos

ETag: string

202 Accepted

A solicitação para criar ou atualizar o fragmento de política foi aceita. O cabeçalho location contém a URL em que o status da operação de execução prolongada pode ser verificado.

Cabeçalhos

location: 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

ApiManagementCreatePolicy

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2022-08-01

{
  "properties": {
    "format": "xml",
    "description": "A policy fragment example",
    "value": "<fragment><json-to-xml apply=\"always\" consider-accept-header=\"false\" /></fragment>"
  }
}

Resposta de exemplo

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1",
  "type": "Microsoft.ApiManagement/service/policyFragments",
  "name": "policyFragment1",
  "properties": {
    "format": "xml",
    "description": "A policy fragment example",
    "value": "<json-to-xml apply=\"always\" consider-accept-header=\"false\" />"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1",
  "type": "Microsoft.ApiManagement/service/policyFragments",
  "name": "policyFragment1",
  "properties": {
    "format": "xml",
    "description": "A policy fragment example",
    "value": "<json-to-xml apply=\"always\" consider-accept-header=\"false\" />"
  }
}
location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201

Definições

Nome Description
ErrorFieldContract

Contrato de Campo de Erro.

ErrorResponse

Resposta de erro.

PolicyFragmentContentFormat

Formato do conteúdo do fragmento de política.

PolicyFragmentContract

Detalhes do contrato do fragmento 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

ErrorFieldContract[]

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.

PolicyFragmentContentFormat

Formato do conteúdo do fragmento de política.

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.

xml

string

O conteúdo está embutido e o Tipo de conteúdo é um documento XML.

PolicyFragmentContract

Detalhes do contrato do fragmento 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.description

string

Descrição do fragmento de política.

properties.format

PolicyFragmentContentFormat

xml

Formato do conteúdo do fragmento de política.

properties.value

string

Conteúdo do fragmento de política.

type

string

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