Workspace Api Operation - Create Or Update

Referência

Serviço:: API Management

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

Cria uma nova operação na API ou atualiza uma operação existente.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificador de revisão da API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Revisão não corrente tem ; rev=n como sufixo onde n é o número de revisão.
operationId	path	True	string minLength: 1 maxLength: 80	Identificador de operação dentro de uma API. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
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.displayName	True	string minLength: 1 maxLength: 300	Nome da operação.
properties.method	True	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.urlTemplate	True	string minLength: 1 maxLength: 1000	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}
properties.description		string maxLength: 1000	Descrição da operação. Pode incluir tags de formatação HTML.
properties.policies		string	Políticas de Operação
properties.request		RequestContract	Uma entidade que contém detalhes da solicitação.
properties.responses		ResponseContract[]	Matriz de respostas de operação.
properties.templateParameters		ParameterContract[]	Coleção de parâmetros de modelo de URL.

Respostas

Name	Tipo	Description
200 OK	OperationContract	A operação foi atualizada com êxito. Cabeçalhos ETag: string
201 Created	OperationContract	A operação foi criada com êxito. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Name

Tipo

Description

200 OK

OperationContract

A operação foi atualizada com êxito.

Cabeçalhos

ETag: string

201 Created

OperationContract

A operação foi criada com êxito.

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

ApiManagementCreateWorkspaceApiOperation

Pedido de amostra

HTTP

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

{
  "properties": {
    "displayName": "createUser2",
    "method": "POST",
    "urlTemplate": "/user1",
    "templateParameters": [],
    "description": "This can only be done by the logged in user.",
    "request": {
      "description": "Created user object",
      "queryParameters": [],
      "headers": [],
      "representations": [
        {
          "contentType": "application/json",
          "schemaId": "592f6c1d0af5840ca8897f0c",
          "typeName": "User"
        }
      ]
    },
    "responses": [
      {
        "statusCode": 200,
        "description": "successful operation",
        "representations": [
          {
            "contentType": "application/xml"
          },
          {
            "contentType": "application/json"
          }
        ],
        "headers": []
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/PetStoreTemplate2/operations/newoperations",
  "type": "Microsoft.ApiManagement/service/workspaces/apis/operations",
  "name": "newoperations",
  "properties": {
    "displayName": "createUser2",
    "method": "POST",
    "urlTemplate": "/user1",
    "templateParameters": [],
    "description": "This can only be done by the logged in user.",
    "request": {
      "description": "Created user object",
      "queryParameters": [],
      "headers": [],
      "representations": [
        {
          "contentType": "application/json",
          "schemaId": "592f6c1d0af5840ca8897f0c",
          "typeName": "User"
        }
      ]
    },
    "responses": [
      {
        "statusCode": 200,
        "description": "successful operation",
        "representations": [
          {
            "contentType": "application/xml"
          },
          {
            "contentType": "application/json"
          }
        ],
        "headers": []
      }
    ]
  }
}

Código de estado:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/PetStoreTemplate2/operations/newoperations",
  "type": "Microsoft.ApiManagement/service/workspaces/apis/operations",
  "name": "newoperations",
  "properties": {
    "displayName": "createUser2",
    "method": "POST",
    "urlTemplate": "/user1",
    "templateParameters": [],
    "description": "This can only be done by the logged in user.",
    "request": {
      "description": "Created user object",
      "queryParameters": [],
      "headers": [],
      "representations": [
        {
          "contentType": "application/json",
          "schemaId": "592f6c1d0af5840ca8897f0c",
          "typeName": "User"
        }
      ]
    },
    "responses": [
      {
        "statusCode": 200,
        "description": "successful operation",
        "representations": [
          {
            "contentType": "application/xml"
          },
          {
            "contentType": "application/json"
          }
        ],
        "headers": []
      }
    ]
  }
}

Definições

Name	Description
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
OperationContract	Detalhes da operação da API.
ParameterContract	Detalhes dos parâmetros de operação.
ParameterExampleContract	Exemplo de parâmetro.
RepresentationContract	Detalhes da representação da solicitação/resposta da operação.
RequestContract	Detalhes da solicitação da operação.
ResponseContract	Detalhes da resposta da operação.

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.

OperationContract

Object

Detalhes da operação da API.

Name	Tipo	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 maxLength: 1000	Descrição da operação. Pode incluir tags de formatação HTML.
properties.displayName	string minLength: 1 maxLength: 300	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 detalhes da solicitação.
properties.responses	ResponseContract[]	Matriz de respostas de operação.
properties.templateParameters	ParameterContract[]	Coleção de parâmetros de modelo de URL.
properties.urlTemplate	string minLength: 1 maxLength: 1000	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 do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ParameterContract

Object

Detalhes dos parâmetros de operação.

Name	Tipo	Description
defaultValue	string	Valor do parâmetro padrão.
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	Nome do tipo definido pelo esquema.
values	string[]	Valores de parâmetros.

ParameterExampleContract

Object

Exemplo de parâmetro.

Name	Tipo	Description
description	string	Descrição longa para o 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

Object

Detalhes da representação da solicitação/resposta da operação.

Name	Tipo	Description
contentType	string	Especifica um tipo de conteúdo registrado ou personalizado para essa representação, por exemplo, application/xml.
examples	<string, ParameterExampleContract>	Exemplo definido para a representação.
formParameters	ParameterContract[]	Coleção de parâmetros de formulário. Obrigatório se o valor 'contentType' for 'application/x-www-form-urlencoded' ou 'multipart/form-data'..
schemaId	string	Identificador de esquema. Aplicável somente se o valor 'contentType' não for 'application/x-www-form-urlencoded' nem 'multipart/form-data'.
typeName	string	Nome do tipo definido pelo esquema. Aplicável somente se o valor 'contentType' não for 'application/x-www-form-urlencoded' nem 'multipart/form-data'.

RequestContract

Object

Detalhes da solicitação da operação.

Name	Tipo	Description
description	string	Descrição do pedido de operação.
headers	ParameterContract[]	Coleta de cabeçalhos de solicitação de operação.
queryParameters	ParameterContract[]	Coleção de parâmetros de consulta de solicitação de operação.
representations	RepresentationContract[]	Recolha de representações de pedidos de operação.

ResponseContract

Object

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 de operação.
representations	RepresentationContract[]	Recolha de representações de resposta à operação.
statusCode	integer (int32)	Código de status HTTP de resposta da operação.

Partilhar via

Workspace Api Operation - Create Or Update

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ApiManagementCreateWorkspaceApiOperation

Pedido de amostra

Resposta da amostra

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OperationContract

ParameterContract

ParameterExampleContract

RepresentationContract

RequestContract

ResponseContract

Recursos adicionais