Certificate interface
証明書を表すインターフェイス。
メソッド
| create |
バックエンドでの認証に使用される証明書を作成または更新します。 |
| delete(string, string, string, string, Certificate |
特定の証明書を削除します。 |
| get(string, string, string, Certificate |
識別子で指定された証明書の詳細を取得します。 |
| get |
識別子で指定された証明書のエンティティ状態 (Etag) バージョンを取得します。 |
| list |
指定されたサービス インスタンスにおけるすべての証明書のコレクションを一覧表示します。 |
| refresh |
KeyVault から、バックエンドでの認証に使用されている証明書を更新します。 |
メソッドの詳細
createOrUpdate(string, string, string, CertificateCreateOrUpdateParameters, CertificateCreateOrUpdateOptionalParams)
バックエンドでの認証に使用される証明書を作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, certificateId: string, parameters: CertificateCreateOrUpdateParameters, options?: CertificateCreateOrUpdateOptionalParams): Promise<CertificateCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- certificateId
-
string
証明書エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- CertificateCreateOrUpdateParameters
パラメーターを作成または更新します。
options パラメーター。
戻り値
Promise<CertificateCreateOrUpdateResponse>
delete(string, string, string, string, CertificateDeleteOptionalParams)
特定の証明書を削除します。
function delete(resourceGroupName: string, serviceName: string, certificateId: string, ifMatch: string, options?: CertificateDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- certificateId
-
string
証明書エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- CertificateDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, CertificateGetOptionalParams)
識別子で指定された証明書の詳細を取得します。
function get(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetOptionalParams): Promise<CertificateGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- certificateId
-
string
証明書エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- CertificateGetOptionalParams
options パラメーター。
戻り値
Promise<CertificateGetResponse>
getEntityTag(string, string, string, CertificateGetEntityTagOptionalParams)
識別子で指定された証明書のエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateGetEntityTagOptionalParams): Promise<CertificateGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- certificateId
-
string
証明書エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<CertificateGetEntityTagHeaders>
listByService(string, string, CertificateListByServiceOptionalParams)
指定されたサービス インスタンスにおけるすべての証明書のコレクションを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: CertificateListByServiceOptionalParams): PagedAsyncIterableIterator<CertificateContract, CertificateContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
refreshSecret(string, string, string, CertificateRefreshSecretOptionalParams)
KeyVault から、バックエンドでの認証に使用されている証明書を更新します。
function refreshSecret(resourceGroupName: string, serviceName: string, certificateId: string, options?: CertificateRefreshSecretOptionalParams): Promise<CertificateRefreshSecretResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- certificateId
-
string
証明書エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<CertificateRefreshSecretResponse>