Create Certificate - Create Certificate

リファレンス

Service:: Key Vault

API Version:: 7.4

新しい証明書を作成します。
これが最初のバージョンの場合は、証明書リソースが作成されます。この操作を行うには、証明書/作成アクセス許可が必要です。

POST {vaultBaseUrl}/certificates/{certificate-name}/create?api-version=7.4

URI パラメーター

名前 / 必須型説明

名前	/	必須	型	説明
certificate-name	path	True	string	証明書の名前。指定した値は、サービスを実行するためにグローバルにコピーされる場合があります。指定する値には、個人を特定できる情報や機密情報を含めてはなりません。 Regex pattern: `^[0-9a-zA-Z-]+$`
vaultBaseUrl	path	True	string	コンテナー名 (例: https://myvault.vault.azure.net)。
api-version	query	True	string	クライアント API バージョン。

certificate-name

path

True

string

証明書の名前。指定した値は、サービスを実行するためにグローバルにコピーされる場合があります。指定する値には、個人を特定できる情報や機密情報を含めてはなりません。

Regex pattern: ^[0-9a-zA-Z-]+$

vaultBaseUrl

path

True

string

コンテナー名 (例: https://myvault.vault.azure.net)。

api-version

query

True

string

クライアント API バージョン。

要求本文

名前	型	説明
attributes	CertificateAttributes	証明書の属性 (省略可能)。
policy	CertificatePolicy	証明書の管理ポリシー。
tags	object	キーと値のペアの形式による、アプリケーション固有のメタデータ。

応答

名前	型	説明
202 Accepted	CertificateOperation	証明書バンドルを作成しました。
Other Status Codes	KeyVaultError	操作が失敗した理由を説明するエラー応答をKey Vaultします。

例

CreateCertificate

Sample Request

HTTP

POST https://myvault.vault.azure.net//certificates/selfSignedCert01/create?api-version=7.4

{
  "policy": {
    "key_props": {
      "exportable": true,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    },
    "x509_props": {
      "subject": "CN=*.microsoft.com",
      "sans": {
        "dns_names": [
          "onedrive.microsoft.com",
          "xbox.microsoft.com"
        ]
      }
    },
    "issuer": {
      "name": "Self"
    }
  }
}

Sample Response

Status code:: 202

{
  "id": "https://myvault.vault.azure.net/certificates/selfSignedCert01/pending",
  "issuer": {
    "name": "Self"
  },
  "csr": "MIIC4zCCAcsCAQAwGjEYMBYGA1UEAwwPKi5taWNyb3NvZnQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqe8aINnShK+wQC8QU7fwsviQc9+yiOnqU3adXA6qNjn21HTdRBa7cyQIk1STxHIBLTT/GaEJwqsUi6UvZaPEHokOWsr1bP9M7xOPTicBcRyMrr6bOxsmGczYtu1z2TzzXDD7q7IEignE7/LowGEaIADCIU9iuWk7TiJ+1Q/VLh/B3xPsgVjY+n7zEQ53gBiDHSl7XfELfwmslOQ28TVNogUyXsxHcVxQQYJeI7HqqY448LeleK69Ld86lkBixLEm1pD7HSbEx3WI2lyUQAGR6hD3YFaiIWVpQeEyI7p1jmtQlnfZdEL4q9wdlEEcwd3h3PAZpEBhCixahF54fci3pwIDAQABoIGDMIGABgkqhkiG9w0BCQ4xczBxMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwNQYDVR0RBC4wLIIWb25lZHJpdmUubWljcm9zb2Z0LmNvbYISeGJveC5taWNyb3NvZnQuY29tMAkGA1UdEwQCMAAwDQYJKoZIhvcNAQELBQADggEBACiLeghirF+yCuYGVUPDB3wKQJn2iLY1za9ncxCehIVqOkFK09AphzoxF6Yid90AKCaa/dT/Ohm7oTyVQ+YcZnT00LUNFVG48AOE8YDiw9tjAG9OORsAz80xnv2qaLw2TCVIQ6NjrI83LqAm1GJ8rAnpdD/ZTuWM7TvSO5g/jm/Q0oSuKpMgj3YxpwgB9Ac6YEfVzOnm76OkUcpvR5MS4BoTfRv4thdSnU+uwqxM+HtdSVTbHQeC2U/hM1cyzDMpl1rZRklmiEOoPUeDasEIBVTJhAxR8xAeKJJD7Wzj4mJPw4UMvF8zQZzW8EKYvB1hkVYY+HQ85L+XcXd8lco7hU4=",
  "cancellation_requested": false,
  "status": "inProgress",
  "status_details": "Pending certificate created. Certificate request is in progress. This may take some time based on the issuer provider. Please check again later.",
  "request_id": "6faacd568ab049a2803861e8dd3ae21f"
}

定義

名前	説明
Action	実行されるアクション。
CertificateAttributes	証明書管理属性。
CertificateCreateParameters	証明書によってパラメーターが作成されます。
CertificateOperation	非同期要求の場合は、証明書操作が返されます。
CertificatePolicy	証明書の管理ポリシー。
CertificatePolicyAction	アクションの種類。
DeletionRecoveryLevel	現在のコンテナー内の証明書に対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーによって証明書を完全に削除できます。それ以外の場合は、保持間隔の最後に証明書を消去できるのはシステムだけです。
Error	キーコンテナーサーバーエラー。
IssuerParameters	証明書の X509 コンポーネントの発行者のパラメーター。
JsonWebKeyCurveName	楕円曲線名。有効な値については、「JsonWebKeyCurveName」を参照してください。
JsonWebKeyType	証明書に使用するキーペアの種類。
KeyProperties	証明書をバックアップするキーペアのプロパティ。
KeyUsageType	証明書のキーの使用方法を定義します。
KeyVaultError	キーコンテナーのエラー例外。
LifetimeAction	証明書の有効期間中にKey Vaultによって実行されるアクションとそのトリガー。
SecretProperties	証明書をバックアップするキーのプロパティ。
SubjectAlternativeNames	X509 オブジェクトのサブジェクト代替名。
Trigger	アクションを実行するために満たす条件。
X509CertificateProperties	証明書の X509 コンポーネントのプロパティ。

Action

実行されるアクション。

名前	型	説明
action_type	CertificatePolicyAction	アクションの種類。

CertificateAttributes

証明書管理属性。

名前	型	説明
created	integer	UTC での作成時刻。
enabled	boolean	オブジェクトが有効かどうかを判断します。
exp	integer	UTC の有効期限。
nbf	integer	UTC の日付より前ではありません。
recoverableDays	integer	softDelete data retention days。 softDelete が有効な場合は、値は >=7、 <=90 である必要があります。それ以外の場合は 0 です。
recoveryLevel	DeletionRecoveryLevel	現在のコンテナー内の証明書に対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーによって証明書を完全に削除できます。それ以外の場合は、保持間隔の最後に証明書を消去できるのはシステムだけです。
updated	integer	UTC の最終更新時刻。

CertificateCreateParameters

証明書によってパラメーターが作成されます。

名前	型	説明
attributes	CertificateAttributes	証明書の属性 (省略可能)。
policy	CertificatePolicy	証明書の管理ポリシー。
tags	object	キーと値のペアの形式による、アプリケーション固有のメタデータ。

CertificateOperation

非同期要求の場合は、証明書操作が返されます。

名前	型	説明
cancellation_requested	boolean	証明書操作で取り消しが要求されたかどうかを示します。
csr	string	証明書操作で使用されている証明書署名要求 (CSR)。
error	Error	証明書の操作中にエラーが発生しました (存在する場合)。
id	string	証明書 ID。
issuer	IssuerParameters	証明書の X509 コンポーネントの発行者のパラメーター。
request_id	string	証明書操作の識別子。
status	string	証明書操作の状態。
status_details	string	証明書操作の状態の詳細。
target	string	証明書操作の結果を格納する場所。

CertificatePolicy

証明書の管理ポリシー。

名前	型	説明
attributes	CertificateAttributes	証明書の属性。
id	string	証明書 ID。
issuer	IssuerParameters	証明書の X509 コンポーネントの発行者のパラメーター。
key_props	KeyProperties	証明書をバックアップするキーのプロパティ。
lifetime_actions	LifetimeAction[]	証明書の有効期間中にKey Vaultによって実行されるアクション。
secret_props	SecretProperties	証明書をバックアップするシークレットのプロパティ。
x509_props	X509CertificateProperties	証明書の X509 コンポーネントのプロパティ。

CertificatePolicyAction

アクションの種類。

名前	型	説明
AutoRenew	string
EmailContacts	string

DeletionRecoveryLevel

現在のコンテナー内の証明書に対して現在有効になっている削除回復レベルを反映します。 "Purgeable" が含まれている場合は、特権ユーザーによって証明書を完全に削除できます。それ以外の場合は、保持間隔の最後に証明書を消去できるのはシステムだけです。

名前	型	説明
CustomizedRecoverable	string	即時および永続的な削除を行わずに削除を回復できるコンテナーの状態を示します (つまり、7<= SoftDeleteRetentionInDays < 90 の場合は消去)。このレベルでは、保持期間中およびサブスクリプションが引き続き使用できる間に、削除されたエンティティの回復可能性が保証されます。
CustomizedRecoverable+ProtectedSubscription	string	7<= SoftDeleteRetentionInDays < 90 の場合に、削除が回復可能、即時および完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができないコンテナーとサブスクリプションの状態を示します。このレベルでは、保持期間中に削除されたエンティティの回復可能性が保証され、サブスクリプション自体を取り消すことができないという事実も反映されます。
CustomizedRecoverable+Purgeable	string	削除が回復可能であり、即時および永続的な削除も許可されるコンテナーの状態を示します (つまり、7< = SoftDeleteRetentionInDays < 90 の場合の消去)。このレベルでは、消去操作が要求されるか、サブスクリプションが取り消されない限り、保持期間中に削除されたエンティティの回復可能性が保証されます。
Purgeable	string	復旧の可能性のない、削除が元に戻せない操作であるコンテナーの状態を示します。このレベルは、Delete 操作に対して使用できる保護に対応しません。エンティティレベル以上 (コンテナー、リソースグループ、サブスクリプションなど) で Delete 操作を受け入れると、データが回復不能に失われます。
Recoverable	string	即時および永続的な削除 (消去) を行わずに削除を復旧できるコンテナーの状態を示します。このレベルでは、リテンション期間 (90 日間) の間、およびサブスクリプションが引き続き使用できる間に、削除されたエンティティの回復可能性が保証されます。回復されていない場合、システムは90日後にそれを完全に削除します
Recoverable+ProtectedSubscription	string	コンテナーとサブスクリプションの状態を示します。この状態では、保持期間内 (90 日間)、即時削除と完全削除 (消去) が許可されず、サブスクリプション自体を完全に取り消すことができない状態を示します。回復されていない場合、システムは90日後にそれを完全に削除します
Recoverable+Purgeable	string	削除が回復可能であり、即時および永続的な削除 (消去) も許可されるコンテナーの状態を示します。このレベルでは、消去操作が要求されるか、サブスクリプションが取り消されない限り、保持期間中 (90 日間) に削除されたエンティティの回復可能性が保証されます。回復されていない場合、システムは90日後にそれを完全に削除します

Error

キーコンテナーサーバーエラー。

名前	型	説明
code	string	エラーコード。
innererror	Error	キーコンテナーサーバーエラー。
message	string	エラーメッセージ。

IssuerParameters

証明書の X509 コンポーネントの発行者のパラメーター。

名前	型	説明
cert_transparency	boolean	このポリシーで生成された証明書を証明書透過性ログに発行する必要があるかどうかを示します。
cty	string	プロバイダーでサポートされている証明書の種類 (省略可能)。;例: "OV-SSL"、"EV-SSL"
name	string	参照されている発行者オブジェクトまたは予約名の名前。たとえば、'Self' や 'Unknown' などです。

JsonWebKeyCurveName

楕円曲線名。有効な値については、「JsonWebKeyCurveName」を参照してください。

名前	型	説明
P-256	string
P-256K	string
P-384	string
P-521	string

JsonWebKeyType

証明書に使用するキーペアの種類。

名前	型	説明
EC	string
EC-HSM	string
RSA	string
RSA-HSM	string
oct	string
oct-HSM	string

KeyProperties

証明書をバックアップするキーペアのプロパティ。

名前	型	説明
crv	JsonWebKeyCurveName	楕円曲線名。有効な値については、「JsonWebKeyCurveName」を参照してください。
exportable	boolean	秘密キーをエクスポートできるかどうかを示します。エクスポート可能なキーの最初のバージョンを作成するときは、リリースポリシーを指定する必要があります。
key_size	integer	キーサイズ (ビット単位)。たとえば、RSA の場合は 2048、3072、4096 などです。
kty	JsonWebKeyType	証明書に使用するキーペアの種類。
reuse_key	boolean	証明書の更新時に同じキーペアを使用するかどうかを示します。

KeyUsageType

証明書のキーの使用方法を定義します。

名前	型	説明
cRLSign	string
dataEncipherment	string
decipherOnly	string
digitalSignature	string
encipherOnly	string
keyAgreement	string
keyCertSign	string
keyEncipherment	string
nonRepudiation	string

KeyVaultError

キーコンテナーのエラー例外。

名前	型	説明
error	Error	キーコンテナーサーバーエラー。

LifetimeAction

証明書の有効期間中にKey Vaultによって実行されるアクションとそのトリガー。

名前	型	説明
action	Action	実行されるアクション。
trigger	Trigger	アクションを実行する条件。

SecretProperties

証明書をバックアップするキーのプロパティ。

名前	型	説明
contentType	string	メディアの種類 (MIME の種類)。

SubjectAlternativeNames

X509 オブジェクトのサブジェクト代替名。

名前	型	説明
dns_names	string[]	ドメイン名。
emails	string[]	メールアドレス。
upns	string[]	ユーザープリンシパル名。

Trigger

アクションを実行するために満たす条件。

名前	型	説明
days_before_expiry	integer	更新を試みる有効期限の前の日数。値は 1 ~ validity_in_months 27 を乗算する必要があります。 validity_in_monthsが 36 の場合、値は 1 から 972 (36 * 27) の間である必要があります。
lifetime_percentage	integer	トリガーする有効期間の割合。値は 1 から 99 の間である必要があります。

X509CertificateProperties

証明書の X509 コンポーネントのプロパティ。

名前	型	説明
ekus	string[]	拡張キーの使用法。
key_usage	KeyUsageType[]	証明書のキーの使用方法を定義します。
sans	SubjectAlternativeNames	サブジェクトの別名。
subject	string	サブジェクト名。有効な X509 識別名である必要があります。
validity_months	integer	証明書が有効な期間 (月単位)。

Create Certificate - Create Certificate

URI パラメーター

要求本文

応答

例

CreateCertificate

Sample Request

Sample Response

定義

Action

CertificateAttributes

CertificateCreateParameters

CertificateOperation

CertificatePolicy

CertificatePolicyAction

DeletionRecoveryLevel

Error

IssuerParameters

JsonWebKeyCurveName

JsonWebKeyType

KeyProperties

KeyUsageType

KeyVaultError

LifetimeAction

SecretProperties

SubjectAlternativeNames

Trigger

X509CertificateProperties

その他のリソース