Backend interface
Interface représentant un back-end.
Méthodes
| create |
Crée ou met à jour un serveur principal. |
| delete(string, string, string, string, Backend |
Supprime le back-end spécifié. |
| get(string, string, string, Backend |
Obtient les détails du back-end spécifié par son identificateur. |
| get |
Obtient la version d’état d’entité (Etag) du back-end spécifié par son identificateur. |
| list |
Répertorie une collection de back-ends dans l’instance de service spécifiée. |
| reconnect(string, string, string, Backend |
Avertit la passerelle Gestion des API de créer une connexion au back-end après le délai d’expiration spécifié. Si aucun délai d’expiration n’a été spécifié, le délai d’expiration de 2 minutes est utilisé. |
| update(string, string, string, string, Backend |
Met à jour un back-end existant. |
Détails de la méthode
createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)
Crée ou met à jour un serveur principal.
function createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- backendId
-
string
Identificateur de l’entité back-end. Doit être unique dans l’instance actuelle du service Gestion des API.
- parameters
- BackendContract
Créez des paramètres.
Paramètres d’options.
Retours
Promise<BackendCreateOrUpdateResponse>
delete(string, string, string, string, BackendDeleteOptionalParams)
Supprime le back-end spécifié.
function delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- backendId
-
string
Identificateur de l’entité back-end. Doit être unique dans l’instance actuelle du service Gestion des API.
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
- options
- BackendDeleteOptionalParams
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, BackendGetOptionalParams)
Obtient les détails du back-end spécifié par son identificateur.
function get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- backendId
-
string
Identificateur de l’entité back-end. Doit être unique dans l’instance actuelle du service Gestion des API.
- options
- BackendGetOptionalParams
Paramètres d’options.
Retours
Promise<BackendGetResponse>
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)
Obtient la version d’état d’entité (Etag) du back-end spécifié par son identificateur.
function getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- backendId
-
string
Identificateur de l’entité back-end. Doit être unique dans l’instance actuelle du service Gestion des API.
Paramètres d’options.
Retours
Promise<BackendGetEntityTagHeaders>
listByService(string, string, BackendListByServiceOptionalParams)
Répertorie une collection de back-ends dans l’instance de service spécifiée.
function listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
Paramètres d’options.
Retours
reconnect(string, string, string, BackendReconnectOptionalParams)
Avertit la passerelle Gestion des API de créer une connexion au back-end après le délai d’expiration spécifié. Si aucun délai d’expiration n’a été spécifié, le délai d’expiration de 2 minutes est utilisé.
function reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- backendId
-
string
Identificateur de l’entité back-end. Doit être unique dans l’instance actuelle du service Gestion des API.
- options
- BackendReconnectOptionalParams
Paramètres d’options.
Retours
Promise<void>
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)
Met à jour un back-end existant.
function update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- backendId
-
string
Identificateur de l’entité back-end. Doit être unique dans l’instance actuelle du service Gestion des API.
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
- parameters
- BackendUpdateParameters
Mettez à jour les paramètres.
- options
- BackendUpdateOptionalParams
Paramètres d’options.
Retours
Promise<BackendUpdateResponse>