Sdílet prostřednictvím


OperationContract interface

Podrobnosti o operaci rozhraní API

Extends

Vlastnosti

description

Popis operace Může obsahovat značky formátování HTML.

displayName

Název operace.

method

Platná metoda operace HTTP. Typické metody HTTP, jako je GET, PUT, POST, ale nejsou omezeny pouze nimi.

policies

Zásady operací

request

Entita obsahující podrobnosti žádosti.

responses

Pole odpovědí operací.

templateParameters

Kolekce parametrů šablony adresy URL

urlTemplate

Relativní šablona adresy URL identifikující cílový prostředek pro tuto operaci Může obsahovat parametry. Příklad: /customers/{cid}/orders/{oid}/?date={date}

Zděděné vlastnosti

id

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

name

Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

type

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

Podrobnosti vlastnosti

description

Popis operace Může obsahovat značky formátování HTML.

description?: string

Hodnota vlastnosti

string

displayName

Název operace.

displayName?: string

Hodnota vlastnosti

string

method

Platná metoda operace HTTP. Typické metody HTTP, jako je GET, PUT, POST, ale nejsou omezeny pouze nimi.

method?: string

Hodnota vlastnosti

string

policies

Zásady operací

policies?: string

Hodnota vlastnosti

string

request

Entita obsahující podrobnosti žádosti.

request?: RequestContract

Hodnota vlastnosti

responses

Pole odpovědí operací.

responses?: ResponseContract[]

Hodnota vlastnosti

templateParameters

Kolekce parametrů šablony adresy URL

templateParameters?: ParameterContract[]

Hodnota vlastnosti

urlTemplate

Relativní šablona adresy URL identifikující cílový prostředek pro tuto operaci Může obsahovat parametry. Příklad: /customers/{cid}/orders/{oid}/?date={date}

urlTemplate?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

id

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

id?: string

Hodnota vlastnosti

string

zděděno zeProxyResource.id

name

Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

name?: string

Hodnota vlastnosti

string

zděděno zeProxyResource.name

type

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

type?: string

Hodnota vlastnosti

string

zděděno zeProxyResource.type