Certificates - List

リファレンス

Service:: App Service

API Version:: 2023-12-01

「サブスクリプションのすべての証明書を取得する」の説明。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates?api-version=2023-12-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates?api-version=2023-12-01&$filter={$filter}

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string	Azure のサブスクリプション ID。これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-00000000000000)。
api-version	query	True	string	API バージョン
$filter	query		string	フィルターで指定された情報のみを返します (OData 構文を使用)。例: $filter=KeyVaultId eq 'KeyVaultId'

応答

名前	型	説明
200 OK	CertificateCollection	OK
Other Status Codes	DefaultErrorResponse	エラー応答をApp Serviceします。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

List Certificates for subscription

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/certificates?api-version=2023-12-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc6282",
      "name": "testc6282",
      "type": "Microsoft.Web/certificates",
      "location": "East US",
      "properties": {
        "friendlyName": "",
        "subjectName": "ServerCert",
        "hostNames": [
          "ServerCert"
        ],
        "issuer": "CACert",
        "issueDate": "2015-11-12T23:40:25+00:00",
        "expirationDate": "2039-12-31T23:59:59+00:00",
        "thumbprint": "FE703D7411A44163B6D32B3AD9B03E175886EBFE"
      }
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/certificates/testc4912",
      "name": "testc4912",
      "type": "Microsoft.Web/certificates",
      "location": "West US",
      "properties": {
        "friendlyName": "",
        "subjectName": "ServerCert2",
        "hostNames": [
          "ServerCert2"
        ],
        "issuer": "CACert",
        "issueDate": "2015-12-12T23:40:25+00:00",
        "expirationDate": "2040-12-31T23:59:59+00:00",
        "thumbprint": "FE703D7411A44163B6D32B3AD9B0490D5886EBFE"
      }
    }
  ]
}

定義

名前	説明
Certificate	アプリの SSL 証明書。
CertificateCollection	証明書のコレクション。
DefaultErrorResponse	エラー応答をApp Serviceします。
Details
Error	エラーモデル。
HostingEnvironmentProfile	このリソースに使用するApp Service Environmentの仕様。
KeyVaultSecretStatus	Key Vault シークレットの状態。

Certificate

アプリの SSL 証明書。

名前	型	説明
id	string	リソース ID。
kind	string	リソースの種類。
location	string	リソースの場所。
name	string	リソース名。
properties.canonicalName	string	無料証明書を介して発行される証明書の CNAME
properties.cerBlob	string	.cer ファイルの生バイト数
properties.domainValidationMethod	string	無料証明書のドメイン検証方法
properties.expirationDate	string	証明書の有効期限。
properties.friendlyName	string	証明書のフレンドリ名。
properties.hostNames	string[]	証明書が適用されるホスト名。
properties.hostingEnvironmentProfile	HostingEnvironmentProfile	証明書に使用するApp Service Environmentの仕様。
properties.issueDate	string	証明書の発行日。
properties.issuer	string	証明書の発行者。
properties.keyVaultId	string	Csm リソース ID をKey Vaultします。
properties.keyVaultSecretName	string	シークレット名をKey Vaultします。
properties.keyVaultSecretStatus	KeyVaultSecretStatus	Key Vault シークレットの状態。
properties.password	string	証明書パスワード。
properties.pfxBlob	string	Pfx BLOB。
properties.publicKeyHash	string	公開キーハッシュ。
properties.selfLink	string	セルフリンク。
properties.serverFarmId	string	関連付けられたApp Service プランのリソース ID。"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}" という形式です。
properties.siteName	string	アプリ名:
properties.subjectName	string	証明書のサブジェクト名。
properties.thumbprint	string	証明書のサムプリント。
properties.valid	boolean	証明書は有効ですか?
tags	object	リソースタグ。
type	string	リソースの種類。

CertificateCollection

証明書のコレクション。

名前	型	説明
nextLink	string	リソースの次のページへのリンク。
value	Certificate[]	リソースのコレクション。

DefaultErrorResponse

エラー応答をApp Serviceします。

名前	型	説明
error	Error	エラーモデル。

Details

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

Error

エラーモデル。

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
details	Details[]	詳細なエラー。
innererror	string	デバッグエラーの詳細。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

HostingEnvironmentProfile

このリソースに使用するApp Service Environmentの仕様。

名前	型	説明
id	string	App Service Environmentのリソース ID。
name	string	App Service Environmentの名前。
type	string	App Service Environmentのリソースの種類。

KeyVaultSecretStatus

Key Vault シークレットの状態。

名前	型	説明
AzureServiceUnauthorizedToAccessKeyVault	string
CertificateOrderFailed	string
ExternalPrivateKey	string
Initialized	string
KeyVaultDoesNotExist	string
KeyVaultSecretDoesNotExist	string
OperationNotPermittedOnKeyVault	string
Succeeded	string
Unknown	string
UnknownError	string
WaitingOnCertificateOrder	string