Workspace interface

Paquet:

@azure/arm-apimanagement

Interface représentant un espace de travail.

Méthodes

createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)	Crée un espace de travail ou met à jour un espace de travail existant.
delete(string, string, string, string, WorkspaceDeleteOptionalParams)	Supprime l’espace de travail spécifié.
get(string, string, string, WorkspaceGetOptionalParams)	Obtient les détails de l’espace de travail spécifié par son identificateur.
getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)	Obtient la version d’état d’entité (Etag) de l’espace de travail spécifié par son identificateur.
listByService(string, string, WorkspaceListByServiceOptionalParams)	Répertorie tous les espaces de travail de l’instance du service Gestion des API.
update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)	Met à jour les détails de l’espace de travail spécifié par son identificateur.

Détails de la méthode

createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)

Crée un espace de travail ou met à jour un espace de travail existant.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, parameters: WorkspaceContract, options?: WorkspaceCreateOrUpdateOptionalParams): Promise<WorkspaceCreateOrUpdateResponse>

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.

parameters

WorkspaceContract

Créez des paramètres.

options

WorkspaceCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<WorkspaceCreateOrUpdateResponse>

delete(string, string, string, string, WorkspaceDeleteOptionalParams)

Supprime l’espace de travail spécifié.

function delete(resourceGroupName: string, serviceName: string, workspaceId: string, ifMatch: string, options?: WorkspaceDeleteOptionalParams): 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.

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

WorkspaceDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, string, WorkspaceGetOptionalParams)

Obtient les détails de l’espace de travail spécifié par son identificateur.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetOptionalParams): Promise<WorkspaceGetResponse>

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.

options

WorkspaceGetOptionalParams

Paramètres d’options.

Retours

Promise<WorkspaceGetResponse>

getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)

Obtient la version d’état d’entité (Etag) de l’espace de travail spécifié par son identificateur.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetEntityTagOptionalParams): Promise<WorkspaceGetEntityTagHeaders>

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.

options

WorkspaceGetEntityTagOptionalParams

Paramètres d’options.

Retours

Promise<WorkspaceGetEntityTagHeaders>

listByService(string, string, WorkspaceListByServiceOptionalParams)

Répertorie tous les espaces de travail de l’instance du service Gestion des API.

function listByService(resourceGroupName: string, serviceName: string, options?: WorkspaceListByServiceOptionalParams): PagedAsyncIterableIterator<WorkspaceContract, WorkspaceContract[], 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.

options

WorkspaceListByServiceOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<WorkspaceContract, WorkspaceContract[], PageSettings>

update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)

Met à jour les détails de l’espace de travail spécifié par son identificateur.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, ifMatch: string, parameters: WorkspaceContract, options?: WorkspaceUpdateOptionalParams): Promise<WorkspaceUpdateResponse>

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.

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

WorkspaceContract

Paramètres de mise à jour de l’espace de travail.

options

WorkspaceUpdateOptionalParams

Paramètres d’options.

Retours

Promise<WorkspaceUpdateResponse>