User interface
代表使用者的介面。
方法
| create |
建立或更新使用者。 |
| delete(string, string, string, string, User |
刪除特定使用者。 |
| generate |
擷取重新導向 URL，其中包含用來將指定使用者簽署至開發人員入口網站的驗證權杖。 |
| get(string, string, string, User |
取得使用者識別碼所指定的詳細資料。 |
| get |
取得 Etag (其識別碼所指定使用者的實體狀態) 版本。 |
| get |
取得使用者的共用存取授權權杖。 |
| list |
列出指定服務實例中已註冊使用者的集合。 |
| update(string, string, string, string, User |
更新識別碼所指定之使用者的詳細資料。 |
方法詳細資料
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>