TenantAccess interface
TenantAccess を表すインターフェイス。
メソッド
| create(string, string, string, string, Access |
テナント アクセス情報の詳細を更新します。 |
| get(string, string, string, Tenant |
シークレットなしでテナント アクセス情報の詳細を取得します。 |
| get |
テナント アクセス メタデータ |
| list |
Git エンドポイントと管理エンドポイントのアクセス情報の一覧を返します。 |
| list |
テナント アクセス情報の詳細を取得します。 |
| regenerate |
プライマリ アクセス キーを再生成します。 |
| regenerate |
セカンダリ アクセス キーを再生成します。 |
| update(string, string, string, string, Access |
テナント アクセス情報の詳細を更新します。 |
メソッドの詳細
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 Management サービスの名前。
- accessName
-
string
Access 構成の識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- AccessInformationCreateParameters
テナント アクセス情報を取得するために指定されたパラメーター。
- options
- TenantAccessCreateOptionalParams
options パラメーター。
戻り値
Promise<TenantAccessCreateResponse>
get(string, string, string, TenantAccessGetOptionalParams)
シークレットなしでテナント アクセス情報の詳細を取得します。
function get(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessGetOptionalParams): Promise<TenantAccessGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- accessName
-
string
Access 構成の識別子。
- options
- TenantAccessGetOptionalParams
options パラメーター。
戻り値
Promise<TenantAccessGetResponse>
getEntityTag(string, string, string, TenantAccessGetEntityTagOptionalParams)
テナント アクセス メタデータ
function getEntityTag(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessGetEntityTagOptionalParams): Promise<TenantAccessGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- accessName
-
string
Access 構成の識別子。
options パラメーター。
戻り値
Promise<TenantAccessGetEntityTagHeaders>
listByService(string, string, TenantAccessListByServiceOptionalParams)
Git エンドポイントと管理エンドポイントのアクセス情報の一覧を返します。
function listByService(resourceGroupName: string, serviceName: string, options?: TenantAccessListByServiceOptionalParams): PagedAsyncIterableIterator<AccessInformationContract, AccessInformationContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
listSecrets(string, string, string, TenantAccessListSecretsOptionalParams)
テナント アクセス情報の詳細を取得します。
function listSecrets(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessListSecretsOptionalParams): Promise<TenantAccessListSecretsResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- accessName
-
string
Access 構成の識別子。
options パラメーター。
戻り値
Promise<TenantAccessListSecretsResponse>
regeneratePrimaryKey(string, string, string, TenantAccessRegeneratePrimaryKeyOptionalParams)
プライマリ アクセス キーを再生成します。
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessRegeneratePrimaryKeyOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- accessName
-
string
Access 構成の識別子。
options パラメーター。
戻り値
Promise<void>
regenerateSecondaryKey(string, string, string, TenantAccessRegenerateSecondaryKeyOptionalParams)
セカンダリ アクセス キーを再生成します。
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, accessName: string, options?: TenantAccessRegenerateSecondaryKeyOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- accessName
-
string
Access 構成の識別子。
options パラメーター。
戻り値
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 Management サービスの名前。
- accessName
-
string
Access 構成の識別子。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- AccessInformationUpdateParameters
テナント アクセス情報を取得するために指定されたパラメーター。
- options
- TenantAccessUpdateOptionalParams
options パラメーター。
戻り値
Promise<TenantAccessUpdateResponse>