WorkspaceGroupUser interface

Pacchetto:

@azure/arm-apimanagement

Interfaccia che rappresenta un WorkspaceGroupUser.

Metodi

checkEntityExists(string, string, string, string, string, WorkspaceGroupUserCheckEntityExistsOptionalParams)	Verifica che l'entità utente specificata dall'identificatore sia associata all'entità del gruppo.
create(string, string, string, string, string, WorkspaceGroupUserCreateOptionalParams)	Aggiunge l’utente esistente al gruppo esistente
delete(string, string, string, string, string, WorkspaceGroupUserDeleteOptionalParams)	Rimuove l’utente esistente dal gruppo esistente.
list(string, string, string, string, WorkspaceGroupUserListOptionalParams)	Elenca una raccolta di entità utente associate al gruppo.

Dettagli metodo

checkEntityExists(string, string, string, string, string, WorkspaceGroupUserCheckEntityExistsOptionalParams)

Verifica che l'entità utente specificata dall'identificatore sia associata all'entità del gruppo.

function checkEntityExists(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, userId: string, options?: WorkspaceGroupUserCheckEntityExistsOptionalParams): Promise<WorkspaceGroupUserCheckEntityExistsResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

workspaceId

string

Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.

groupId

string

Identificatore di gruppo. Deve essere univoco nell'istanza corrente del servizio Gestione API.

userId

string

Identificatore utente. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options

WorkspaceGroupUserCheckEntityExistsOptionalParams

Parametri delle opzioni.

Restituisce

Promise<WorkspaceGroupUserCheckEntityExistsResponse>

create(string, string, string, string, string, WorkspaceGroupUserCreateOptionalParams)

Aggiunge l’utente esistente al gruppo esistente

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

workspaceId

string

Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.

groupId

string

Identificatore di gruppo. Deve essere univoco nell'istanza corrente del servizio Gestione API.

userId

string

Identificatore utente. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options

WorkspaceGroupUserCreateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<UserContract>

delete(string, string, string, string, string, WorkspaceGroupUserDeleteOptionalParams)

Rimuove l’utente esistente dal gruppo esistente.

function delete(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, userId: string, options?: WorkspaceGroupUserDeleteOptionalParams): Promise<void>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

workspaceId

string

Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.

groupId

string

Identificatore di gruppo. Deve essere univoco nell'istanza corrente del servizio Gestione API.

userId

string

Identificatore utente. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options

WorkspaceGroupUserDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

list(string, string, string, string, WorkspaceGroupUserListOptionalParams)

Elenca una raccolta di entità utente associate al gruppo.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

workspaceId

string

Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.

groupId

string

Identificatore di gruppo. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options

WorkspaceGroupUserListOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>