Delen via

Group interface

  • Referentie
Pakket:
@azure/arm-apimanagement

Interface die een groep vertegenwoordigt.

Methoden

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

Hiermee maakt of werkt u een groep bij.
delete(string, string, string, string, GroupDeleteOptionalParams)

Hiermee verwijdert u een specifieke groep van het API Management-service-exemplaar.
get(string, string, string, GroupGetOptionalParams)

Hiermee haalt u de details op van de groep die is opgegeven met de id.
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Hiermee haalt u de versie van de entiteitsstatus (Etag) van de groep op die is opgegeven met de id.
listByService(string, string, GroupListByServiceOptionalParams)

Een lijst met een verzameling groepen die zijn gedefinieerd in een service-exemplaar.
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)

Hiermee worden de details van de groep bijgewerkt die is opgegeven met de id.

Methodedetails

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

Hiermee maakt of werkt u een groep bij.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management-service.

groupId

string

Groeps-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

parameters
GroupCreateParameters

Parameters maken.

options
GroupCreateOrUpdateOptionalParams

De optiesparameters.

Retouren

Promise<GroupCreateOrUpdateResponse>

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

Hiermee verwijdert u een specifieke groep van het API Management-service-exemplaar.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management-service.

groupId

string

Groeps-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

ifMatch

string

ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus van het headerantwoord van de GET-aanvraag of moet * zijn voor een onvoorwaardelijke update.

options
GroupDeleteOptionalParams

De optiesparameters.

Retouren

Promise<void>

get(string, string, string, GroupGetOptionalParams)

Hiermee haalt u de details op van de groep die is opgegeven met de id.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management-service.

groupId

string

Groeps-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

options
GroupGetOptionalParams

De optiesparameters.

Retouren

Promise<GroupGetResponse>

getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Hiermee haalt u de versie van de entiteitsstatus (Etag) van de groep op die is opgegeven met de id.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management-service.

groupId

string

Groeps-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

options
GroupGetEntityTagOptionalParams

De optiesparameters.

Retouren

Promise<GroupGetEntityTagHeaders>

listByService(string, string, GroupListByServiceOptionalParams)

Een lijst met een verzameling groepen die zijn gedefinieerd in een service-exemplaar.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management-service.

options
GroupListByServiceOptionalParams

De optiesparameters.

Retouren

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

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

Hiermee worden de details van de groep bijgewerkt die is opgegeven met de id.

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

Parameters

resourceGroupName

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName

string

De naam van de API Management-service.

groupId

string

Groeps-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.

ifMatch

string

ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus van het headerantwoord van de GET-aanvraag of moet * zijn voor een onvoorwaardelijke update.

parameters
GroupUpdateParameters

Parameters bijwerken.

options
GroupUpdateOptionalParams

De optiesparameters.

Retouren

Promise<GroupUpdateResponse>