OperationContract interface
Podrobnosti o operaci rozhraní API
- Extends
Vlastnosti
description | Popis operace. Mohou obsahovat značky formátování HTML. |
display |
Název operace. |
method | Platná metoda operace HTTP. Typické metody HTTP, jako jsou GET, PUT, POST, ale neomezují se pouze na ně. |
policies | Zásady operací |
request | Entita obsahující podrobnosti požadavku. |
responses | Pole odpovědí operace |
template |
Kolekce parametrů šablony adresy URL. |
url |
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 Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{resourceType}/{název_prostředku} POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server. |
name | Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server. |
type | Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server. |
Podrobnosti vlastnosti
description
Popis operace. Mohou 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 jsou GET, PUT, POST, ale neomezují se pouze na ně.
method?: string
Hodnota vlastnosti
string
policies
Zásady operací
policies?: string
Hodnota vlastnosti
string
request
Entita obsahující podrobnosti požadavku.
request?: RequestContract
Hodnota vlastnosti
responses
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 Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{resourceType}/{název_prostředku} POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
id?: string
Hodnota vlastnosti
string
Zděděno zProxyResource.id
name
Název prostředku POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
name?: string
Hodnota vlastnosti
string
Zděděno zProxyResource.name
type
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts POZNÁMKA: Tato vlastnost nebude serializována. Naplnit ho může jenom server.
type?: string
Hodnota vlastnosti
string
Zděděno zProxyResource.type