WorkspaceGroup interface
Interface représentant un WorkspaceGroup.
Méthodes
| create |
Crée ou met à jour un groupe. |
| delete(string, string, string, string, string, Workspace |
Supprime un groupe spécifique de l’espace de travail dans une instance de service Gestion des API. |
| get(string, string, string, string, Workspace |
Obtient les détails du groupe spécifié par son identificateur. |
| get |
Obtient la version d’état d’entité (Etag) du groupe spécifié par son identificateur. |
| list |
Répertorie une collection de groupes définis dans un espace de travail dans une instance de service. |
| update(string, string, string, string, string, Group |
Met à jour les détails du groupe spécifié par son identificateur. |
Détails de la méthode
createOrUpdate(string, string, string, string, GroupCreateParameters, WorkspaceGroupCreateOrUpdateOptionalParams)
Crée ou met à jour un groupe.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, parameters: GroupCreateParameters, options?: WorkspaceGroupCreateOrUpdateOptionalParams): Promise<WorkspaceGroupCreateOrUpdateResponse>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.
- groupId
-
string
Identificateur de groupe. Doit être unique dans l’instance actuelle du service Gestion des API.
- parameters
- GroupCreateParameters
Créez des paramètres.
Paramètres d’options.
Retours
Promise<WorkspaceGroupCreateOrUpdateResponse>
delete(string, string, string, string, string, WorkspaceGroupDeleteOptionalParams)
Supprime un groupe spécifique de l’espace de travail dans une instance de service Gestion des API.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, ifMatch: string, options?: WorkspaceGroupDeleteOptionalParams): 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.
- groupId
-
string
Identificateur de groupe. 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, WorkspaceGroupGetOptionalParams)
Obtient les détails du groupe spécifié par son identificateur.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetOptionalParams): Promise<WorkspaceGroupGetResponse>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.
- groupId
-
string
Identificateur de groupe. Doit être unique dans l’instance actuelle du service Gestion des API.
- options
- WorkspaceGroupGetOptionalParams
Paramètres d’options.
Retours
Promise<WorkspaceGroupGetResponse>
getEntityTag(string, string, string, string, WorkspaceGroupGetEntityTagOptionalParams)
Obtient la version d’état d’entité (Etag) du groupe spécifié par son identificateur.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetEntityTagOptionalParams): Promise<WorkspaceGroupGetEntityTagHeaders>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.
- groupId
-
string
Identificateur de groupe. Doit être unique dans l’instance actuelle du service Gestion des API.
Paramètres d’options.
Retours
Promise<WorkspaceGroupGetEntityTagHeaders>
listByService(string, string, string, WorkspaceGroupListByServiceOptionalParams)
Répertorie une collection de groupes définis dans un espace de travail dans une instance de service.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], 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, GroupUpdateParameters, WorkspaceGroupUpdateOptionalParams)
Met à jour les détails du groupe spécifié par son identificateur.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: WorkspaceGroupUpdateOptionalParams): Promise<WorkspaceGroupUpdateResponse>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.
- groupId
-
string
Identificateur de groupe. 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
- GroupUpdateParameters
Mettez à jour les paramètres.
Paramètres d’options.
Retours
Promise<WorkspaceGroupUpdateResponse>