TenantAccess interface
代表 TenantAccess 的介面。
方法
方法詳細資料
create(string, string, string, string, AccessInformationCreateParameters, TenantAccessCreateOptionalParams)
更新租使用者存取訊號詳細資料。
function create(resourceGroupName: string, serviceName: string, accessName: string, ifMatch: string, parameters: AccessInformationCreateParameters, options?: TenantAccessCreateOptionalParams): Promise<TenantAccessCreateResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- accessName
-
string
Access 組態的識別碼。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求標頭回應的目前實體狀態,否則應該為 * 進行無條件更新。
- parameters
- AccessInformationCreateParameters
提供用來擷取租使用者存取訊號的參數。
- options
- TenantAccessCreateOptionalParams
選項參數。
傳回
Promise<TenantAccessCreateResponse>
get(string, string, string, TenantAccessGetOptionalParams)
取得沒有秘密的租使用者存取訊號詳細資料。
function get(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessGetOptionalParams): Promise<TenantAccessGetResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- accessName
-
string
Access 組態的識別碼。
- options
- TenantAccessGetOptionalParams
選項參數。
傳回
Promise<TenantAccessGetResponse>
getEntityTag(string, string, string, TenantAccessGetEntityTagOptionalParams)
租使用者存取中繼資料
function getEntityTag(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessGetEntityTagOptionalParams): Promise<TenantAccessGetEntityTagHeaders>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- accessName
-
string
Access 組態的識別碼。
選項參數。
傳回
Promise<TenantAccessGetEntityTagHeaders>
listByService(string, string, TenantAccessListByServiceOptionalParams)
傳回 Git 和管理端點的存取訊號清單。
function listByService(resourceGroupName: string, serviceName: string, options?: TenantAccessListByServiceOptionalParams): PagedAsyncIterableIterator<AccessInformationContract, AccessInformationContract[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
選項參數。
傳回
listSecrets(string, string, string, TenantAccessListSecretsOptionalParams)
取得租使用者存取訊號詳細資料。
function listSecrets(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessListSecretsOptionalParams): Promise<TenantAccessListSecretsResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- accessName
-
string
Access 組態的識別碼。
選項參數。
傳回
Promise<TenantAccessListSecretsResponse>
regeneratePrimaryKey(string, string, string, TenantAccessRegeneratePrimaryKeyOptionalParams)
重新產生主要存取金鑰
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessRegeneratePrimaryKeyOptionalParams): Promise<void>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- accessName
-
string
Access 組態的識別碼。
選項參數。
傳回
Promise<void>
regenerateSecondaryKey(string, string, string, TenantAccessRegenerateSecondaryKeyOptionalParams)
重新產生次要存取金鑰
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessRegenerateSecondaryKeyOptionalParams): Promise<void>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- accessName
-
string
Access 組態的識別碼。
選項參數。
傳回
Promise<void>
update(string, string, string, string, AccessInformationUpdateParameters, TenantAccessUpdateOptionalParams)
更新租使用者存取訊號詳細資料。
function update(resourceGroupName: string, serviceName: string, accessName: string, ifMatch: string, parameters: AccessInformationUpdateParameters, options?: TenantAccessUpdateOptionalParams): Promise<TenantAccessUpdateResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- accessName
-
string
Access 組態的識別碼。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求標頭回應的目前實體狀態,否則應該為 * 進行無條件更新。
- parameters
- AccessInformationUpdateParameters
提供用來擷取租使用者存取訊號的參數。
- options
- TenantAccessUpdateOptionalParams
選項參數。
傳回
Promise<TenantAccessUpdateResponse>