Group interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en grupp.

Metoder

createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)	Skapar eller Uppdateringar en grupp.
delete(string, string, string, string, GroupDeleteOptionalParams)	Tar bort en specifik grupp av API Management-tjänstinstansen.
get(string, string, string, GroupGetOptionalParams)	Hämtar information om gruppen som anges av dess identifierare.
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)	Hämtar entitetstillståndsversionen (Etag) för den grupp som anges av dess identifierare.
listByService(string, string, GroupListByServiceOptionalParams)	Visar en samling grupper som definierats i en tjänstinstans.
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)	Uppdateringar information om gruppen som anges av dess identifierare.

Metodinformation

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

Skapar eller Uppdateringar en grupp.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

groupId

string

Gruppidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

parameters

GroupCreateParameters

Skapa parametrar.

options

GroupCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<GroupCreateOrUpdateResponse>

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

Tar bort en specifik grupp av API Management-tjänstinstansen.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

groupId

string

Gruppidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

options

GroupDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

get(string, string, string, GroupGetOptionalParams)

Hämtar information om gruppen som anges av dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

groupId

string

Gruppidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

GroupGetOptionalParams

Alternativparametrarna.

Returer

Promise<GroupGetResponse>

getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Hämtar entitetstillståndsversionen (Etag) för den grupp som anges av dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

groupId

string

Gruppidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

options

GroupGetEntityTagOptionalParams

Alternativparametrarna.

Returer

Promise<GroupGetEntityTagHeaders>

listByService(string, string, GroupListByServiceOptionalParams)

Visar en samling grupper som definierats i en tjänstinstans.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

GroupListByServiceOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

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

Uppdateringar information om gruppen som anges av dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

groupId

string

Gruppidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

parameters

GroupUpdateParameters

Uppdatera parametrar.

options

GroupUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<GroupUpdateResponse>