OperationContract interface
Detalhes da Operação da API.
- Extends
Propriedades
description | Descrição da operação. Pode incluir marcas de formatação HTML. |
display |
Nome da operação. |
method | 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. |
policies | Políticas de operação |
request | Uma entidade que contém detalhes da solicitação. |
responses | Matriz de respostas de operação. |
template |
Coleção de parâmetros de modelo de URL. |
url |
Modelo de URL relativa identificando o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date} |
Propriedades herdadas
id | ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
name | O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
type | Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor. |
Detalhes da propriedade
description
Descrição da operação. Pode incluir marcas de formatação HTML.
description?: string
Valor da propriedade
string
displayName
Nome da operação.
displayName?: string
Valor da propriedade
string
method
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.
method?: string
Valor da propriedade
string
policies
Políticas de operação
policies?: string
Valor da propriedade
string
request
Uma entidade que contém detalhes da solicitação.
request?: RequestContract
Valor da propriedade
responses
Matriz de respostas de operação.
responses?: ResponseContract[]
Valor da propriedade
templateParameters
Coleção de parâmetros de modelo de URL.
templateParameters?: ParameterContract[]
Valor da propriedade
urlTemplate
Modelo de URL relativa identificando o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date}
urlTemplate?: string
Valor da propriedade
string
Detalhes das propriedades herdadas
id
ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
id?: string
Valor da propriedade
string
Herdado deProxyResource.id
name
O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name?: string
Valor da propriedade
string
Herdado deProxyResource.name
type
Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
type?: string
Valor da propriedade
string
Herdado deProxyResource.type