User interface
Интерфейс, представляющий пользователя.
Методы
Сведения о методе
createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)
Создает или обновляет пользователя.
function createOrUpdate(resourceGroupName: string, serviceName: string, userId: string, parameters: UserCreateParameters, options?: UserCreateOrUpdateOptionalParams): Promise<UserCreateOrUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- userId
-
string
Идентификатор пользователя. Должен быть уникальным в текущем экземпляре службы Управление API.
- parameters
- UserCreateParameters
Создание или обновление параметров.
- options
- UserCreateOrUpdateOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<UserCreateOrUpdateResponse>
delete(string, string, string, string, UserDeleteOptionalParams)
Удаляет конкретного пользователя.
function delete(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, options?: UserDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- userId
-
string
Идентификатор пользователя. Должен быть уникальным в текущем экземпляре службы Управление API.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- options
- UserDeleteOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)
Получает URL-адрес перенаправления, содержащий маркер проверки подлинности для входа данного пользователя на портал разработчиков.
function generateSsoUrl(resourceGroupName: string, serviceName: string, userId: string, options?: UserGenerateSsoUrlOptionalParams): Promise<GenerateSsoUrlResult>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- userId
-
string
Идентификатор пользователя. Должен быть уникальным в текущем экземпляре службы Управление API.
- options
- UserGenerateSsoUrlOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<GenerateSsoUrlResult>
get(string, string, string, UserGetOptionalParams)
Возвращает сведения о пользователе, заданном его идентификатором.
function get(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetOptionalParams): Promise<UserGetResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- userId
-
string
Идентификатор пользователя. Должен быть уникальным в текущем экземпляре службы Управление API.
- options
- UserGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<UserGetResponse>
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)
Возвращает версию состояния сущности (Etag) пользователя, указанного его идентификатором.
function getEntityTag(resourceGroupName: string, serviceName: string, userId: string, options?: UserGetEntityTagOptionalParams): Promise<UserGetEntityTagHeaders>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- userId
-
string
Идентификатор пользователя. Должен быть уникальным в текущем экземпляре службы Управление API.
- options
- UserGetEntityTagOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<UserGetEntityTagHeaders>
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)
Возвращает маркер авторизации общего доступа для пользователя.
function getSharedAccessToken(resourceGroupName: string, serviceName: string, userId: string, parameters: UserTokenParameters, options?: UserGetSharedAccessTokenOptionalParams): Promise<UserTokenResult>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- userId
-
string
Идентификатор пользователя. Должен быть уникальным в текущем экземпляре службы Управление API.
- parameters
- UserTokenParameters
Создание параметров маркера авторизации.
Параметры параметров.
Возвращаемое значение
Promise<UserTokenResult>
listByService(string, string, UserListByServiceOptionalParams)
Возвращает коллекцию пользователей, зарегистрированных в указанном экземпляре службы.
function listByService(resourceGroupName: string, serviceName: string, options?: UserListByServiceOptionalParams): PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- options
- UserListByServiceOptionalParams
Параметры параметров.
Возвращаемое значение
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)
Обновления сведения о пользователе, заданном его идентификатором.
function update(resourceGroupName: string, serviceName: string, userId: string, ifMatch: string, parameters: UserUpdateParameters, options?: UserUpdateOptionalParams): Promise<UserUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- userId
-
string
Идентификатор пользователя. Должен быть уникальным в текущем экземпляре службы Управление API.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- parameters
- UserUpdateParameters
Обновление параметров.
- options
- UserUpdateOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<UserUpdateResponse>