OperationContract interface
Details van API-bewerking.
- Uitbreiding
Eigenschappen
description | Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten. |
display |
Bewerkingsnaam. |
method | Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden. |
policies | Bewerkingsbeleid |
request | Een entiteit met aanvraagdetails. |
responses | Matrix met bewerkingsantwoorden. |
template |
Verzameling url-sjabloonparameters. |
url |
Relatieve URL-sjabloon die de doelresource voor deze bewerking identificeert. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date} |
Overgenomen eigenschappen
id | Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server. |
name | De naam van de resource OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server. |
type | Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server. |
Eigenschapdetails
description
Beschrijving van de bewerking. Kan HTML-opmaaktags bevatten.
description?: string
Waarde van eigenschap
string
displayName
Bewerkingsnaam.
displayName?: string
Waarde van eigenschap
string
method
Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden.
method?: string
Waarde van eigenschap
string
policies
Bewerkingsbeleid
policies?: string
Waarde van eigenschap
string
request
responses
Matrix met bewerkingsantwoorden.
responses?: ResponseContract[]
Waarde van eigenschap
templateParameters
Verzameling url-sjabloonparameters.
templateParameters?: ParameterContract[]
Waarde van eigenschap
urlTemplate
Relatieve URL-sjabloon die de doelresource voor deze bewerking identificeert. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date}
urlTemplate?: string
Waarde van eigenschap
string
Details van overgenomen eigenschap
id
Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
id?: string
Waarde van eigenschap
string
Overgenomen vanProxyResource.id
name
De naam van de resource OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
name?: string
Waarde van eigenschap
string
Overgenomen vanProxyResource.name
type
Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
type?: string
Waarde van eigenschap
string
Overgenomen vanProxyResource.type