User interface
Rozhraní představující uživatele
Metody
Podrobnosti metody
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
Vytvoří nebo aktualizuje uživatele.
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- userId
-
string
Identifikátor uživatele. V aktuální instanci služby API Management musí být jedinečné.
- parameters
- UserCreateParameters
Vytvoření nebo aktualizace parametrů
- options
- UserCreateOrUpdateOptionalParams
Parametry možností.
Návraty
Promise<UserCreateOrUpdateResponse>
delete(string, string, string, string, UserDeleteOptionalParams)
Odstraní konkrétního uživatele.
function delete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- userId
-
string
Identifikátor uživatele. V aktuální instanci služby API Management musí být jedinečné.
- ifMatch
-
string
ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.
- options
- UserDeleteOptionalParams
Parametry možností.
Návraty
Promise<void>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
Načte adresu URL přesměrování obsahující ověřovací token pro podepsání daného uživatele na portálu pro vývojáře.
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- userId
-
string
Identifikátor uživatele. V aktuální instanci služby API Management musí být jedinečné.
- options
- UserGenerateSsoUrlOptionalParams
Parametry možností.
Návraty
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
Získá podrobnosti uživatele určeného jeho identifikátorem.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- userId
-
string
Identifikátor uživatele. V aktuální instanci služby API Management musí být jedinečné.
- options
- UserGetOptionalParams
Parametry možností.
Návraty
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
Získá verzi stavu entity (Etag) uživatele určeného jeho identifikátorem.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- userId
-
string
Identifikátor uživatele. V aktuální instanci služby API Management musí být jedinečné.
- options
- UserGetEntityTagOptionalParams
Parametry možností.
Návraty
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
Získá sdílený přístupový autorizační token pro uživatele.
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- userId
-
string
Identifikátor uživatele. V aktuální instanci služby API Management musí být jedinečné.
- parameters
- UserTokenParameters
Vytvořte parametry autorizačního tokenu.
Parametry možností.
Návraty
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
Vypíše kolekci registrovaných uživatelů v zadané instanci služby.
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- options
- UserListByServiceOptionalParams
Parametry možností.
Návraty
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
Aktualizuje podrobnosti uživatele určeného jeho identifikátorem.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- userId
-
string
Identifikátor uživatele. V aktuální instanci služby API Management musí být jedinečné.
- ifMatch
-
string
ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.
- parameters
- UserUpdateParameters
Aktualizujte parametry.
- options
- UserUpdateOptionalParams
Parametry možností.
Návraty
Promise<UserUpdateResponse>