Partager via

Group interface

  • Référence
Paquet:
@azure/arm-apimanagement

Interface représentant un groupe.

Méthodes

createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)

Crée ou met à jour un groupe.
delete(string, string, string, string, GroupDeleteOptionalParams)

Supprime un groupe spécifique de l’instance de service de gestion des API.
get(string, string, string, GroupGetOptionalParams)

Obtient les détails du groupe spécifié par son identificateur.
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Obtient la version d’état d’entité (Etag) du groupe spécifié par son identificateur.
listByService(string, string, GroupListByServiceOptionalParams)

Répertorie une collection de groupes définis dans une instance de service.
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)

Mises à jour les détails du groupe spécifié par son identificateur.

Détails de la méthode

createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)

Crée ou met à jour un groupe.

function createOrUpdate(resourceGroupName: string, serviceName: string, groupId: string, parameters: GroupCreateParameters, options?: GroupCreateOrUpdateOptionalParams): Promise<GroupCreateOrUpdateResponse>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

groupId

string

Identificateur de groupe. Doit être unique dans le instance de service Gestion des API actuel.

parameters
GroupCreateParameters

Créez des paramètres.

options
GroupCreateOrUpdateOptionalParams

Paramètres d’options.

Retours

Promise<GroupCreateOrUpdateResponse>

delete(string, string, string, string, GroupDeleteOptionalParams)

Supprime un groupe spécifique de l’instance de service de gestion des API.

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

groupId

string

Identificateur de groupe. Doit être unique dans le instance de service Gestion des API actuel.

ifMatch

string

ETag de l’entité. ETag doit correspondre à l’état d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

options
GroupDeleteOptionalParams

Paramètres d’options.

Retours

Promise<void>

get(string, string, string, GroupGetOptionalParams)

Obtient les détails du groupe spécifié par son identificateur.

function get(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetOptionalParams): Promise<GroupGetResponse>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

groupId

string

Identificateur de groupe. Doit être unique dans le instance de service Gestion des API actuel.

options
GroupGetOptionalParams

Paramètres d’options.

Retours

Promise<GroupGetResponse>

getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Obtient la version d’état d’entité (Etag) du groupe spécifié par son identificateur.

function getEntityTag(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetEntityTagOptionalParams): Promise<GroupGetEntityTagHeaders>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

groupId

string

Identificateur de groupe. Doit être unique dans le instance de service Gestion des API actuel.

options
GroupGetEntityTagOptionalParams

Paramètres d’options.

Retours

Promise<GroupGetEntityTagHeaders>

listByService(string, string, GroupListByServiceOptionalParams)

Répertorie une collection de groupes définis dans une instance de service.

function listByService(resourceGroupName: string, serviceName: string, options?: GroupListByServiceOptionalParams): 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.

options
GroupListByServiceOptionalParams

Paramètres d’options.

Retours

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)

Mises à jour les détails du groupe spécifié par son identificateur.

function update(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: GroupUpdateOptionalParams): Promise<GroupUpdateResponse>

Paramètres

resourceGroupName

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName

string

Nom du service Gestion des API.

groupId

string

Identificateur de groupe. Doit être unique dans le instance de service Gestion des API actuel.

ifMatch

string

ETag de l’entité. ETag doit correspondre à l’état d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

parameters
GroupUpdateParameters

Mettre à jour les paramètres.

options
GroupUpdateOptionalParams

Paramètres d’options.

Retours

Promise<GroupUpdateResponse>