WorkspaceBackend interface
Interface représentant un WorkspaceBackend.
Méthodes
| create |
Crée ou met à jour un back-end. |
| delete(string, string, string, string, string, Workspace |
Supprime le back-end spécifié. |
| get(string, string, string, string, Workspace |
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’espace de travail spécifié. |
| update(string, string, string, string, string, Backend |
Met à jour un back-end existant. |
Détails de la méthode
createOrUpdate(string, string, string, string, BackendContract, WorkspaceBackendCreateOrUpdateOptionalParams)
Crée ou met à jour un back-end.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, parameters: BackendContract, options?: WorkspaceBackendCreateOrUpdateOptionalParams): Promise<WorkspaceBackendCreateOrUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle 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
delete(string, string, string, string, string, WorkspaceBackendDeleteOptionalParams)
Supprime le back-end spécifié.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, ifMatch: string, options?: WorkspaceBackendDeleteOptionalParams): 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.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle 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.
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, string, WorkspaceBackendGetOptionalParams)
Obtient les détails du back-end spécifié par son identificateur.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, options?: WorkspaceBackendGetOptionalParams): Promise<WorkspaceBackendGetResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle 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<WorkspaceBackendGetResponse>
getEntityTag(string, string, string, string, WorkspaceBackendGetEntityTagOptionalParams)
Obtient la version d’état d’entité (Etag) du back-end spécifié par son identificateur.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, options?: WorkspaceBackendGetEntityTagOptionalParams): Promise<WorkspaceBackendGetEntityTagHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle 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<WorkspaceBackendGetEntityTagHeaders>
listByWorkspace(string, string, string, WorkspaceBackendListByWorkspaceOptionalParams)
Répertorie une collection de back-ends dans l’espace de travail spécifié.
function listByWorkspace(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceBackendListByWorkspaceOptionalParams): 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.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
Paramètres d’options.
Retours
update(string, string, string, string, string, BackendUpdateParameters, WorkspaceBackendUpdateOptionalParams)
Met à jour un back-end existant.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: WorkspaceBackendUpdateOptionalParams): Promise<WorkspaceBackendUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle 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.
Paramètres d’options.
Retours
Promise<WorkspaceBackendUpdateResponse>