Certificate - Get
識別子で指定された証明書の詳細を取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}?api-version=2022-08-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
certificate
|
path | True |
string |
証明書エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 Regex pattern: |
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
service
|
path | True |
string |
API Management サービスの名前。 Regex pattern: |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
応答本文には、指定された証明書エンティティが含まれます。 Headers ETag: string |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
Api |
Api |
ApiManagementGetCertificate
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCert1?api-version=2022-08-01
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCert1",
"type": "Microsoft.ApiManagement/service/certificates",
"name": "templateCert1",
"properties": {
"subject": "CN=mutual-authcert",
"thumbprint": "EBA**********************8594A6",
"expirationDate": "2017-04-23T17:03:41Z"
}
}
ApiManagementGetCertificateWithKeyVault
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv?api-version=2022-08-01
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv",
"type": "Microsoft.ApiManagement/service/certificates",
"name": "templateCertkv",
"properties": {
"subject": "CN=*.msitesting.net",
"thumbprint": "EA**********************9AD690",
"expirationDate": "2037-01-01T07:00:00Z",
"keyVault": {
"secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert",
"identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
"lastStatus": {
"code": "Success",
"timeStampUtc": "2020-09-22T00:24:53.3191468Z"
}
}
}
}
定義
名前 | 説明 |
---|---|
Certificate |
証明書の詳細。 |
Error |
エラー フィールド コントラクト。 |
Error |
エラー応答。 |
Key |
KeyVault コントラクトの詳細。 |
Key |
コントラクトの更新プロパティを発行します。 |
CertificateContract
証明書の詳細。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
リソースの名前 |
properties.expirationDate |
string |
証明書の有効期限。 日付は、ISO 8601 標準で指定されている形式 |
properties.keyVault |
証明書の KeyVault の場所の詳細。 |
|
properties.subject |
string |
証明書の件名属性。 |
properties.thumbprint |
string |
証明書の拇印。 |
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
ErrorFieldContract
エラー フィールド コントラクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
プロパティ レベルのエラー コード。 |
message |
string |
プロパティ レベルエラーの人間が判読できる表現。 |
target |
string |
プロパティ名。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
error.code |
string |
サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。 |
error.details |
検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。 |
|
error.message |
string |
人が判読できるエラーの表現。 |
KeyVaultContractProperties
KeyVault コントラクトの詳細。
名前 | 型 | 説明 |
---|---|---|
identityClientId |
string |
Key Vault シークレットへのアクセスに使用される、SystemAssignedIdentity の場合は Null、UserAssignedIdentity の場合はクライアント ID。 |
lastStatus |
キー コンテナーからのシークレットの前回の同期と更新の状態。 |
|
secretIdentifier |
string |
シークレットをフェッチするためのキー コンテナー シークレット識別子。 バージョン管理されたシークレットを指定すると、自動更新ができなくなります。 これには、API Management サービスを aka.ms/apimmsi で構成する必要があります |
KeyVaultLastAccessStatusContractProperties
コントラクトの更新プロパティを発行します。
名前 | 型 | 説明 |
---|---|---|
code |
string |
キー コンテナーからのシークレットの同期と更新の最後の状態コード。 |
message |
string |
エラーの詳細は空です。 |
timeStampUtc |
string |
シークレットが最後にアクセスされた時刻。 日付は、ISO 8601 標準で指定されている形式 |