User interface

Pacchetto:

@azure/arm-apimanagement

Interfaccia che rappresenta un utente.

Metodi

createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)	Crea o Aggiornamenti un utente.
delete(string, string, string, string, UserDeleteOptionalParams)	Elimina un utente specifico.
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)	Recupera un URL di reindirizzamento contenente un token di autenticazione per firmare un determinato utente nel portale per sviluppatori.
get(string, string, string, UserGetOptionalParams)	Ottiene i dettagli dell'utente specificato dal relativo identificatore.
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)	Ottiene la versione dello stato dell'entità (Etag) dell'utente specificato dal relativo identificatore.
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)	Ottiene il token di autorizzazione di accesso condiviso per l'utente.
listByService(string, string, UserListByServiceOptionalParams)	Elenca una raccolta di utenti registrati nell'istanza del servizio specificata.
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)	Aggiornamenti i dettagli dell'utente specificato dal relativo identificatore.

Dettagli metodo

createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)

Crea o Aggiornamenti un utente.

function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

userId

string

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

parameters

UserCreateParameters

Creare o aggiornare i parametri.

options

UserCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<UserCreateOrUpdateResponse>

delete(string, string, string, string, UserDeleteOptionalParams)

Elimina un utente specifico.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

userId

string

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

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

options

UserDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)

Recupera un URL di reindirizzamento contenente un token di autenticazione per firmare un determinato utente nel portale per sviluppatori.

function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

userId

string

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

options

UserGenerateSsoUrlOptionalParams

Parametri delle opzioni.

Restituisce

Promise<GenerateSsoUrlResult>

get(string, string, string, UserGetOptionalParams)

Ottiene i dettagli dell'utente specificato dal relativo identificatore.

function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

userId

string

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

options

UserGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<UserGetResponse>

getEntityTag(string, string, string, UserGetEntityTagOptionalParams)

Ottiene la versione dello stato dell'entità (Etag) dell'utente specificato dal relativo identificatore.

function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

userId

string

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

options

UserGetEntityTagOptionalParams

Parametri delle opzioni.

Restituisce

Promise<UserGetEntityTagHeaders>

getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)

Ottiene il token di autorizzazione di accesso condiviso per l'utente.

function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

userId

string

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

parameters

UserTokenParameters

Creare i parametri del token di autorizzazione.

options

UserGetSharedAccessTokenOptionalParams

Parametri delle opzioni.

Restituisce

Promise<UserTokenResult>

listByService(string, string, UserListByServiceOptionalParams)

Elenca una raccolta di utenti registrati nell'istanza del servizio specificata.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

options

UserListByServiceOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>

update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)

Aggiornamenti i dettagli dell'utente specificato dal relativo identificatore.

function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

userId

string

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

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

parameters

UserUpdateParameters

Aggiornare i parametri.

options

UserUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<UserUpdateResponse>