Backend interface
Gränssnitt som representerar en serverdel.
Metoder
| create |
Skapar eller Uppdateringar en serverdel. |
| delete(string, string, string, string, Backend |
Tar bort den angivna serverdelen. |
| get(string, string, string, Backend |
Hämtar information om den serverdel som anges av dess identifierare. |
| get |
Hämtar entitetstillståndsversionen (Etag) för den serverdel som anges av dess identifierare. |
| list |
Visar en samling serverdelar i den angivna tjänstinstansen. |
| reconnect(string, string, string, Backend |
Meddelar API Management-gatewayen om att skapa en ny anslutning till serverdelen efter den angivna tidsgränsen. Om ingen tidsgräns har angetts används tidsgränsen på 2 minuter. |
| update(string, string, string, string, Backend |
Uppdateringar en befintlig serverdel. |
Metodinformation
createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)
Skapar eller Uppdateringar en serverdel.
function createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- backendId
-
string
Identifierare för serverdelsentiteten. Måste vara unikt i den aktuella API Management tjänstinstansen.
- parameters
- BackendContract
Skapa parametrar.
Alternativparametrarna.
Returer
Promise<BackendCreateOrUpdateResponse>
delete(string, string, string, string, BackendDeleteOptionalParams)
Tar bort den angivna serverdelen.
function delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- backendId
-
string
Identifierare för serverdelsentiteten. Måste vara unikt i den aktuella API Management tjänstinstansen.
- ifMatch
-
string
ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.
- options
- BackendDeleteOptionalParams
Alternativparametrarna.
Returer
Promise<void>
get(string, string, string, BackendGetOptionalParams)
Hämtar information om den serverdel som anges av dess identifierare.
function get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- backendId
-
string
Identifierare för serverdelsentiteten. Måste vara unikt i den aktuella API Management tjänstinstansen.
- options
- BackendGetOptionalParams
Alternativparametrarna.
Returer
Promise<BackendGetResponse>
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)
Hämtar entitetstillståndsversionen (Etag) för den serverdel som anges av dess identifierare.
function getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagHeaders>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- backendId
-
string
Identifierare för serverdelsentiteten. Måste vara unikt i den aktuella API Management tjänstinstansen.
Alternativparametrarna.
Returer
Promise<BackendGetEntityTagHeaders>
listByService(string, string, BackendListByServiceOptionalParams)
Visar en samling serverdelar i den angivna tjänstinstansen.
function listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
Alternativparametrarna.
Returer
reconnect(string, string, string, BackendReconnectOptionalParams)
Meddelar API Management-gatewayen om att skapa en ny anslutning till serverdelen efter den angivna tidsgränsen. Om ingen tidsgräns har angetts används tidsgränsen på 2 minuter.
function reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- backendId
-
string
Identifierare för serverdelsentiteten. Måste vara unikt i den aktuella API Management tjänstinstansen.
- options
- BackendReconnectOptionalParams
Alternativparametrarna.
Returer
Promise<void>
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)
Uppdateringar en befintlig serverdel.
function update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- backendId
-
string
Identifierare för serverdelsentiteten. Måste vara unikt i den aktuella API Management tjänstinstansen.
- ifMatch
-
string
ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.
- parameters
- BackendUpdateParameters
Uppdatera parametrar.
- options
- BackendUpdateOptionalParams
Alternativparametrarna.
Returer
Promise<BackendUpdateResponse>