Compartir a través de


OperationContract interface

Detalles de la operación de API.

Extends

Propiedades

description

Descripción de la operación. Puede incluir etiquetas de formato HTML.

displayName

Nombre de la operación.

method

Un método de operación HTTP válido. Métodos HTTP típicos, como GET, PUT, POST, pero no limitado solo por ellos.

policies

Directivas de operación

request

Una entidad que contiene los detalles de la solicitud.

responses

Matriz de respuestas de operación.

templateParameters

Colección de parámetros de plantilla de dirección URL.

urlTemplate

Plantilla de dirección URL relativa identifica el recurso de destino para esta operación. Puede incluir parámetros. Ejemplo: /customers/{cid}/orders/{oid}/?date={date}

Propiedades heredadas

id

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

name

El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

type

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

Detalles de las propiedades

description

Descripción de la operación. Puede incluir etiquetas de formato HTML.

description?: string

Valor de propiedad

string

displayName

Nombre de la operación.

displayName?: string

Valor de propiedad

string

method

Un método de operación HTTP válido. Métodos HTTP típicos, como GET, PUT, POST, pero no limitado solo por ellos.

method?: string

Valor de propiedad

string

policies

Directivas de operación

policies?: string

Valor de propiedad

string

request

Una entidad que contiene los detalles de la solicitud.

request?: RequestContract

Valor de propiedad

responses

Matriz de respuestas de operación.

responses?: ResponseContract[]

Valor de propiedad

templateParameters

Colección de parámetros de plantilla de dirección URL.

templateParameters?: ParameterContract[]

Valor de propiedad

urlTemplate

Plantilla de dirección URL relativa identifica el recurso de destino para esta operación. Puede incluir parámetros. Ejemplo: /customers/{cid}/orders/{oid}/?date={date}

urlTemplate?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

id

Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

id?: string

Valor de propiedad

string

Heredado deProxyResource.id

name

El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

name?: string

Valor de propiedad

string

Heredado deProxyResource.name

type

Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

type?: string

Valor de propiedad

string

Heredado deProxyResource.type