User interface
Felhasználót képviselő felület.
Metódusok
Metódus adatai
beginDelete(string, string, string, string, UserDeleteOptionalParams)
Törli az adott felhasználót.
function beginDelete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<SimplePollerLike<OperationState<UserDeleteHeaders>, UserDeleteHeaders>>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- userId
-
string
Felhasználói azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- ifMatch
-
string
Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.
- options
- UserDeleteOptionalParams
A beállítások paraméterei.
Válaszok
Promise<@azure/core-lro.SimplePollerLike<OperationState<UserDeleteHeaders>, UserDeleteHeaders>>
beginDeleteAndWait(string, string, string, string, UserDeleteOptionalParams)
Törli az adott felhasználót.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<UserDeleteHeaders>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- userId
-
string
Felhasználói azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- ifMatch
-
string
Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.
- options
- UserDeleteOptionalParams
A beállítások paraméterei.
Válaszok
Promise<UserDeleteHeaders>
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
Létrehoz vagy frissít egy felhasználót.
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- userId
-
string
Felhasználói azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- parameters
- UserCreateParameters
Paraméterek létrehozása vagy frissítése.
- options
- UserCreateOrUpdateOptionalParams
A beállítások paraméterei.
Válaszok
Promise<UserCreateOrUpdateResponse>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
Lekéri az átirányítási URL-címet, amely egy hitelesítési jogkivonatot tartalmaz egy adott felhasználónak a fejlesztői portálra való aláírásához.
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- userId
-
string
Felhasználói azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- options
- UserGenerateSsoUrlOptionalParams
A beállítások paraméterei.
Válaszok
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
Lekéri az azonosító által megadott felhasználó adatait.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- userId
-
string
Felhasználói azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- options
- UserGetOptionalParams
A beállítások paraméterei.
Válaszok
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
Lekéri a felhasználó entitásállapotának (Etag) verzióját, amelyet az azonosítója határoz meg.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- userId
-
string
Felhasználói azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- options
- UserGetEntityTagOptionalParams
A beállítások paraméterei.
Válaszok
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
Lekéri a felhasználó megosztott hozzáférés-engedélyezési jogkivonatát.
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- userId
-
string
Felhasználói azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- parameters
- UserTokenParameters
Engedélyezési jogkivonat paramétereinek létrehozása.
A beállítások paraméterei.
Válaszok
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
A megadott szolgáltatáspéldány regisztrált felhasználóinak gyűjteményét sorolja fel.
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- options
- UserListByServiceOptionalParams
A beállítások paraméterei.
Válaszok
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
Frissíti az azonosító által megadott felhasználó adatait.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- userId
-
string
Felhasználói azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- ifMatch
-
string
Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.
- parameters
- UserUpdateParameters
Paraméterek frissítése.
- options
- UserUpdateOptionalParams
A beállítások paraméterei.
Válaszok
Promise<UserUpdateResponse>