GroupUser interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en GroupUser.

Metoder

checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)	Kontrollerar att användarentiteten som anges av identifieraren är associerad med gruppentiteten.
create(string, string, string, string, GroupUserCreateOptionalParams)	Lägga till befintlig användare i befintlig grupp
delete(string, string, string, string, GroupUserDeleteOptionalParams)	Ta bort befintlig användare från en befintlig grupp.
list(string, string, string, GroupUserListOptionalParams)	Visar en samling användarentiteter som är associerade med gruppen.

Metodinformation

checkEntityExists(string, string, string, string, GroupUserCheckEntityExistsOptionalParams)

Kontrollerar att användarentiteten som anges av identifieraren är associerad med gruppentiteten.

function checkEntityExists(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCheckEntityExistsOptionalParams): Promise<GroupUserCheckEntityExistsResponse>

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.

userId

string

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

options

GroupUserCheckEntityExistsOptionalParams

Alternativparametrarna.

Returer

Promise<GroupUserCheckEntityExistsResponse>

create(string, string, string, string, GroupUserCreateOptionalParams)

Lägga till befintlig användare i befintlig grupp

function create(resourceGroupName: string, serviceName: string, groupId: string, userId: string, options?: GroupUserCreateOptionalParams): Promise<UserContract>

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.

userId

string

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

options

GroupUserCreateOptionalParams

Alternativparametrarna.

Returer

Promise<UserContract>

delete(string, string, string, string, GroupUserDeleteOptionalParams)

Ta bort befintlig användare från en befintlig grupp.

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

userId

string

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

options

GroupUserDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

list(string, string, string, GroupUserListOptionalParams)

Visar en samling användarentiteter som är associerade med gruppen.

function list(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupUserListOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>

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

GroupUserListOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>