Freigeben über

Group interface

  • Referenz
Paket:
@azure/arm-apimanagement

Schnittstelle, die eine Gruppe darstellt.

Methoden

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

Erstellt oder aktualisiert eine Gruppe.
delete(string, string, string, string, GroupDeleteOptionalParams)

Löscht eine bestimmte Gruppe der API-Verwaltungsdienstinstanz.
get(string, string, string, GroupGetOptionalParams)

Ruft die Details der Gruppe ab, die durch den Bezeichner angegeben wird.
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Ruft die Entitätsstatusversion (Etag) der Gruppe ab, die durch den Bezeichner angegeben wird.
listByService(string, string, GroupListByServiceOptionalParams)

Listet eine Sammlung von Gruppen auf, die in einer Dienstinstanz definiert sind.
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)

Aktualisiert die Details der durch den Bezeichner angegebenen Gruppe.

Details zur Methode

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

Erstellt oder aktualisiert eine Gruppe.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

groupId

string

Gruppenbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

parameters
GroupCreateParameters

Erstellen Sie Parameter.

options
GroupCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<GroupCreateOrUpdateResponse>

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

Löscht eine bestimmte Gruppe der API-Verwaltungsdienstinstanz.

function delete(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, options?: GroupDeleteOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

groupId

string

Gruppenbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

options
GroupDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, GroupGetOptionalParams)

Ruft die Details der Gruppe ab, die durch den Bezeichner angegeben wird.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

groupId

string

Gruppenbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

options
GroupGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<GroupGetResponse>

getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Ruft die Entitätsstatusversion (Etag) der Gruppe ab, die durch den Bezeichner angegeben wird.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

groupId

string

Gruppenbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

options
GroupGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<GroupGetEntityTagHeaders>

listByService(string, string, GroupListByServiceOptionalParams)

Listet eine Sammlung von Gruppen auf, die in einer Dienstinstanz definiert sind.

function listByService(resourceGroupName: string, serviceName: string, options?: GroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

options
GroupListByServiceOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

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

Aktualisiert die Details der durch den Bezeichner angegebenen Gruppe.

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

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

groupId

string

Gruppenbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

parameters
GroupUpdateParameters

Aktualisieren von Parametern.

options
GroupUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<GroupUpdateResponse>