Partilhar via

Api Operation - Update

  • Referência
Serviço:
API Management
Versão da API:
2021-08-01

Atualizações os detalhes da operação na API especificada pelo identificador.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}?api-version=2021-08-01

Parâmetros do URI

Name Em Necessário Tipo Description
apiId
 path True

string

Identificador de revisão da API. Tem de ser exclusivo na instância de serviço do Gestão de API atual. A revisão não atual tem ; rev=n como um sufixo em que n é o número de revisão.

Padrão Regex: ^[^*#&+:<>?]+$
operationId
 path True

string

Identificador de operação numa API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
resourceGroupName
 path True

string

O nome do grupo de recursos.
serviceName
 path True

string

O nome do serviço Gestão de API.

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

string

Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version
 query True

string

Versão da API a utilizar com o pedido de cliente.

Cabeçalho do Pedido

Name Necessário Tipo Description
If-Match True

string

ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.

Corpo do Pedido

Name Tipo Description
properties.description

string

Descrição da operação. Pode incluir etiquetas de formatação HTML.
properties.displayName

string

Nome da Operação.
properties.method

string

Um Método de Operação HTTP Válido. Métodos Http típicos, como GET, PUT, POST, mas não limitados apenas por eles.
properties.policies

string

Políticas de Operação
properties.request

RequestContract

Uma entidade que contém os detalhes do pedido.
properties.responses

ResponseContract[]

Matriz de Respostas da operação.
properties.templateParameters

ParameterContract[]

Coleção de parâmetros de modelo de URL.
properties.urlTemplate

string

Modelo de URL relativo que identifica o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date}

Respostas

Name Tipo Description
200 OK

OperationContract

A operação foi atualizada com êxito.

Cabeçalhos

ETag: string
Other Status Codes

ErrorResponse

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

ApiManagementUpdateApiOperation

Pedido de amostra

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api/operations/operationId?api-version=2021-08-01


{
  "properties": {
    "displayName": "Retrieve resource",
    "method": "GET",
    "urlTemplate": "/resource",
    "templateParameters": [],
    "request": {
      "queryParameters": [
        {
          "name": "param1",
          "description": "A sample parameter that is required and has a default value of \"sample\".",
          "type": "string",
          "defaultValue": "sample",
          "required": true,
          "values": [
            "sample"
          ]
        }
      ]
    },
    "responses": [
      {
        "statusCode": 200,
        "description": "Returned in all cases.",
        "representations": [],
        "headers": []
      },
      {
        "statusCode": 500,
        "description": "Server Error.",
        "representations": [],
        "headers": []
      }
    ]
  }
}

Resposta da amostra

Código de estado:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc",
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "name": "57d2ef278aa04f0ad01d6cdc",
  "properties": {
    "displayName": "CancelOrder",
    "method": "POST",
    "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder",
    "templateParameters": [],
    "request": {
      "description": "IFazioService_CancelOrder_InputMessage",
      "queryParameters": [],
      "headers": [],
      "representations": [
        {
          "contentType": "text/xml",
          "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8",
          "typeName": "CancelOrder"
        }
      ]
    },
    "responses": [
      {
        "statusCode": 200,
        "description": "IFazioService_CancelOrder_OutputMessage",
        "representations": [
          {
            "contentType": "text/xml",
            "schemaId": "6980a395-f08b-4a59-8295-1440cbd909b8",
            "typeName": "CancelOrderResponse"
          }
        ],
        "headers": []
      }
    ]
  }
}

Definições

Name Description
ErrorFieldContract

Contrato de campo de erro.
ErrorResponse

Resposta a Erros.
OperationContract

Detalhes da Operação de API.
OperationUpdateContract

Detalhes do Contrato de Atualização da Operação de API.
ParameterContract

Detalhes dos parâmetros de operação.
ParameterExampleContract

Exemplo de parâmetro.
RepresentationContract

Detalhes da representação do pedido/resposta da operação.
RequestContract

Detalhes do pedido de operação.
ResponseContract

Detalhes da resposta da operação.

ErrorFieldContract

Contrato de campo de erro.

Name Tipo Description
code

string

Código de erro ao nível da propriedade.
message

string

Representação legível por humanos do erro ao nível da propriedade.
target

string

Nome da propriedade.

ErrorResponse

Resposta a Erros.

Name Tipo Description
error.code

string

Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta.
error.details

ErrorFieldContract[]

A lista de campos inválidos enviados a pedido, em caso de erro de validação.
error.message

string

Representação legível por humanos do erro.

OperationContract

Detalhes da Operação de API.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

O nome do recurso
properties.description

string

Descrição da operação. Pode incluir etiquetas de formatação HTML.
properties.displayName

string

Nome da Operação.
properties.method

string

Um Método de Operação HTTP Válido. Métodos Http típicos, como GET, PUT, POST, mas não limitados apenas por eles.
properties.policies

string

Políticas de Operação
properties.request

RequestContract

Uma entidade que contém os detalhes do pedido.
properties.responses

ResponseContract[]

Matriz de Respostas da operação.
properties.templateParameters

ParameterContract[]

Coleção de parâmetros de modelo de URL.
properties.urlTemplate

string

Modelo de URL relativo que identifica o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date}
type

string

O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

OperationUpdateContract

Detalhes do Contrato de Atualização da Operação de API.

Name Tipo Description
properties.description

string

Descrição da operação. Pode incluir etiquetas de formatação HTML.
properties.displayName

string

Nome da Operação.
properties.method

string

Um Método de Operação HTTP Válido. Métodos Http típicos, como GET, PUT, POST, mas não limitados apenas por eles.
properties.policies

string

Políticas de Operação
properties.request

RequestContract

Uma entidade que contém os detalhes do pedido.
properties.responses

ResponseContract[]

Matriz de Respostas da operação.
properties.templateParameters

ParameterContract[]

Coleção de parâmetros de modelo de URL.
properties.urlTemplate

string

Modelo de URL relativo que identifica o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date}

ParameterContract

Detalhes dos parâmetros de operação.

Name Tipo Description
defaultValue

string

Valor do parâmetro predefinido.
description

string

Descrição do parâmetro.
examples

<string,  ParameterExampleContract>

Exemplo definido para o parâmetro.
name

string

Nome do parâmetro.
required

boolean

Especifica se o parâmetro é necessário ou não.
schemaId

string

Identificador de esquema.
type

string

Tipo de parâmetro.
typeName

string

Escreva o nome definido pelo esquema.
values

string[]

Valores de parâmetros.

ParameterExampleContract

Exemplo de parâmetro.

Name Tipo Description
description

string

Descrição longa do exemplo
externalValue

string

Um URL que aponta para o exemplo literal
summary

string

Breve descrição do exemplo
value

Valor de exemplo. Pode ser um valor primitivo ou um objeto.

RepresentationContract

Detalhes da representação do pedido/resposta da operação.

Name Tipo Description
contentType

string

Especifica um tipo de conteúdo registado ou personalizado para esta representação, por exemplo, aplicação/xml.
examples

<string,  ParameterExampleContract>

Exemplo definido para a representação.
formParameters

ParameterContract[]

Coleção de parâmetros de formulário. Necessário se o valor "contentType" for "application/x-www-form-urlencoded" ou "multipart/form-data".
schemaId

string

Identificador de esquema. Aplicável apenas se o valor "contentType" não for "application/x-www-form-urlencoded" nem "multipart/form-data".
typeName

string

Escreva o nome definido pelo esquema. Aplicável apenas se o valor "contentType" não for "application/x-www-form-urlencoded" nem "multipart/form-data".

RequestContract

Detalhes do pedido de operação.

Name Tipo Description
description

string

Descrição do pedido de operação.
headers

ParameterContract[]

Coleção de cabeçalhos de pedidos de operação.
queryParameters

ParameterContract[]

Coleção de parâmetros de consulta do pedido de operação.
representations

RepresentationContract[]

Coleção de representações de pedidos de operação.

ResponseContract

Detalhes da resposta da operação.

Name Tipo Description
description

string

Descrição da resposta da operação.
headers

ParameterContract[]

Coleção de cabeçalhos de resposta da operação.
representations

RepresentationContract[]

Coleção de representações de resposta de operação.
statusCode

integer

Código de estado HTTP da resposta da operação.