Workspace Policy Fragment - Create Or Update

Referência

Serviço:: API Management

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

Cria ou atualiza um fragmento de política.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
id	path	True	string minLength: 1 maxLength: 80 pattern: (^[\w]+$)\|(^[\w][\w\-]+[\w]$)	Um identificador de recurso.
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.

Cabeçalho do Pedido

Name	Necessá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 do Pedido

Name	Necessário	Tipo	Description
properties.value	True	string	Conteúdo do fragmento de política.
properties.description		string minLength: 0 maxLength: 1000	Descrição do fragmento de política.
properties.format		PolicyFragmentContentFormat	Formato do conteúdo do fragmento de política.

Respostas

Name	Tipo	Description
200 OK	PolicyFragmentContract	O fragmento de política foi atualizado com êxito. Cabeçalhos ETag: string location: string Azure-AsyncOperation: string
201 Created	PolicyFragmentContract	O fragmento de política foi criado com êxito. Cabeçalhos ETag: string location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Name

Tipo

Description

200 OK

PolicyFragmentContract

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

Cabeçalhos

ETag: string
location: string
Azure-AsyncOperation: string

201 Created

PolicyFragmentContract

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

Cabeçalhos

ETag: string
location: string
Azure-AsyncOperation: 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

ApiManagementCreateWorkspacePolicyFragment

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:: 200

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1",
  "type": "Microsoft.ApiManagement/service/workspaces/policyFragments",
  "name": "policyFragment1",
  "properties": {
    "format": "xml",
    "description": "A policy fragment example",
    "value": "<json-to-xml apply=\"always\" consider-accept-header=\"false\" />",
    "provisioningState": "InProgress"
  }
}

Código de estado:: 201

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=200
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/policyFragments/policyFragment1",
  "type": "Microsoft.ApiManagement/service/workspaces/policyFragments",
  "name": "policyFragment1",
  "properties": {
    "format": "xml",
    "description": "A policy fragment example",
    "value": "<json-to-xml apply=\"always\" consider-accept-header=\"false\" />",
    "provisioningState": "InProgress"
  }
}

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
PolicyFragmentContentFormat	Formato do conteúdo do fragmento de política.
PolicyFragmentContract	Detalhes do contrato de fragmento de 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.

PolicyFragmentContentFormat

Enumeração

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

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

PolicyFragmentContract

Object

Detalhes do contrato de fragmento de política.

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.description	string minLength: 0 maxLength: 1000		Descrição do fragmento de política.
properties.format	PolicyFragmentContentFormat	xml	Formato do conteúdo do fragmento de política.
properties.provisioningState	string		O estado de provisionamento
properties.value	string		Conteúdo do fragmento de política.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

Partilhar via

Workspace Policy Fragment - Create Or Update

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ApiManagementCreateWorkspacePolicyFragment

Pedido de amostra

Resposta da amostra

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PolicyFragmentContentFormat

PolicyFragmentContract

Recursos adicionais