你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

User interface

参考

包:: @azure/arm-apimanagement

表示用户的接口。

方法

createOrUpdate(string, string, string, UserCreateParameters, UserCreateOrUpdateOptionalParams)	创建或更新用户。
delete(string, string, string, string, UserDeleteOptionalParams)	删除特定用户。
generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)	检索重定向 URL，其中包含用于将给定用户签名到开发人员门户中的身份验证令牌。
get(string, string, string, UserGetOptionalParams)	获取由标识符指定的用户的详细信息。
getEntityTag(string, string, string, UserGetEntityTagOptionalParams)	获取由其标识符指定的用户的实体状态（Etag）版本。
getSharedAccessToken(string, string, string, UserTokenParameters, UserGetSharedAccessTokenOptionalParams)	获取用户的共享访问授权令牌。
listByService(string, string, UserListByServiceOptionalParams)	列出指定服务实例中已注册用户的集合。
update(string, string, string, string, UserUpdateParameters, UserUpdateOptionalParams)	更新由标识符指定的用户的详细信息。

方法详细信息

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

创建授权令牌参数。

options: UserGetSharedAccessTokenOptionalParams

选项参数。

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

选项参数。

PagedAsyncIterableIterator<UserContract, UserContract[], PageSettings>

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>

通过

User interface

方法

方法详细信息

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

参数

返回

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

参数

返回

generateSsoUrl(string, string, string, UserGenerateSsoUrlOptionalParams)

参数

返回

get(string, string, string, UserGetOptionalParams)

参数

返回

getEntityTag(string, string, string, UserGetEntityTagOptionalParams)

参数

返回

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

参数

返回

listByService(string, string, UserListByServiceOptionalParams)

参数

返回

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

参数

返回

其他资源