User interface
Interfejs reprezentujący użytkownika.
Metody
Szczegóły metody
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
Tworzy lub aktualizuje użytkownika.
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- userId
-
string
Identyfikator użytkownika. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- parameters
- UserCreateParameters
Tworzenie lub aktualizowanie parametrów.
- options
- UserCreateOrUpdateOptionalParams
Parametry opcji.
Zwraca
Promise<UserCreateOrUpdateResponse>
delete(string, string, string, string, UserDeleteOptionalParams)
Usuwa określonego użytkownika.
function delete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- userId
-
string
Identyfikator użytkownika. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
- options
- UserDeleteOptionalParams
Parametry opcji.
Zwraca
Promise<void>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
Pobiera adres URL przekierowania zawierający token uwierzytelniania na potrzeby podpisywania danego użytkownika w portalu deweloperów.
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- userId
-
string
Identyfikator użytkownika. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- options
- UserGenerateSsoUrlOptionalParams
Parametry opcji.
Zwraca
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
Pobiera szczegóły użytkownika określonego przez jego identyfikator.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- userId
-
string
Identyfikator użytkownika. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- options
- UserGetOptionalParams
Parametry opcji.
Zwraca
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
Pobiera wersję stanu jednostki (Etag) użytkownika określonego przez jego identyfikator.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- userId
-
string
Identyfikator użytkownika. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- options
- UserGetEntityTagOptionalParams
Parametry opcji.
Zwraca
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
Pobiera token autoryzacji dostępu współdzielonego dla użytkownika.
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- userId
-
string
Identyfikator użytkownika. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- parameters
- UserTokenParameters
Utwórz parametry tokenu autoryzacji.
Parametry opcji.
Zwraca
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
Wyświetla listę kolekcji zarejestrowanych użytkowników w określonym wystąpieniu usługi.
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- options
- UserListByServiceOptionalParams
Parametry opcji.
Zwraca
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
Aktualizuje szczegóły użytkownika określonego przez jego identyfikator.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
- serviceName
-
string
Nazwa usługi API Management.
- userId
-
string
Identyfikator użytkownika. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
- ifMatch
-
string
Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.
- parameters
- UserUpdateParameters
Aktualizuj parametry.
- options
- UserUpdateOptionalParams
Parametry opcji.
Zwraca
Promise<UserUpdateResponse>