Set Certificate Issuer - Set Certificate Issuer

リファレンス

Service:: Key Vault

API Version:: 7.4

指定した証明書発行者を設定します。
SetCertificateIssuer 操作は、指定された証明書発行者を追加または更新します。この操作には、certificates/setissuers アクセス許可が必要です。

PUT {vaultBaseUrl}/certificates/issuers/{issuer-name}?api-version=7.4

URI パラメーター

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

要求本文

名前	必須	型	説明
provider	True	string	発行者プロバイダー。
attributes		IssuerAttributes	発行者オブジェクトの属性。
credentials		IssuerCredentials	発行者に使用する資格情報。
org_details		OrganizationDetails	発行者に提供されるorganizationの詳細。

応答

名前	型	説明
200 OK	IssuerBundle	キーコンテナー証明書の発行者。
Other Status Codes	KeyVaultError	操作が失敗した理由を説明するエラー応答をKey Vaultします。

例

SetCertificateIssuer

Sample Request

HTTP

PUT https://myvault.vault.azure.net//certificates/issuers/issuer01?api-version=7.4

{
  "provider": "Test",
  "credentials": {
    "account_id": "keyvaultuser",
    "pwd": "password"
  },
  "org_details": {
    "admin_details": [
      {
        "first_name": "John",
        "last_name": "Doe",
        "email": "admin@microsoft.com",
        "phone": "4255555555"
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "id": "https://myvault.vault.azure.net/certificates/issuers/issuer01",
  "provider": "Test",
  "credentials": {
    "account_id": "keyvaultuser"
  },
  "org_details": {
    "admin_details": [
      {
        "first_name": "John",
        "last_name": "Doe",
        "email": "admin@microsoft.com",
        "phone": "4255555555"
      }
    ]
  },
  "attributes": {
    "enabled": true,
    "created": 1482188806,
    "updated": 1482189526
  }
}

定義

名前	説明
AdministratorDetails	証明書発行者のorganization管理者の詳細。
CertificateIssuerSetParameters	証明書発行者がパラメーターを設定します。
Error	キーコンテナーサーバーエラー。
IssuerAttributes	Key Vault サービスによって管理される発行者の属性。
IssuerBundle	証明書の発行者Key Vault。
IssuerCredentials	証明書の発行者に使用する資格情報。
KeyVaultError	キーコンテナーエラー例外。
OrganizationDetails	証明書発行者のorganizationの詳細。

AdministratorDetails

証明書発行者のorganization管理者の詳細。

名前	型	説明
email	string	電子メールアドレス。
first_name	string	名。
last_name	string	姓。
phone	string	電話番号。

CertificateIssuerSetParameters

証明書発行者がパラメーターを設定します。

名前	型	説明
attributes	IssuerAttributes	発行者オブジェクトの属性。
credentials	IssuerCredentials	発行者に使用する資格情報。
org_details	OrganizationDetails	発行者に提供されるorganizationの詳細。
provider	string	発行者プロバイダー。

Error

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

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

IssuerAttributes

Key Vault サービスによって管理される発行者の属性。

名前	型	説明
created	integer	作成時刻 (UTC)。
enabled	boolean	発行者が有効になっているかどうかを判断します。
updated	integer	UTC での最終更新時刻。

IssuerBundle

証明書の発行者Key Vault。

名前	型	説明
attributes	IssuerAttributes	発行者オブジェクトの属性。
credentials	IssuerCredentials	発行者に使用する資格情報。
id	string	発行者オブジェクトの識別子。
org_details	OrganizationDetails	発行者に提供されるorganizationの詳細。
provider	string	発行者プロバイダー。

IssuerCredentials

証明書の発行者に使用する資格情報。

名前	型	説明
account_id	string	ユーザー名/アカウント名/アカウント ID。
pwd	string	パスワード/シークレット/アカウントキー。

KeyVaultError

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

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

OrganizationDetails

証明書発行者のorganizationの詳細。

名前	型	説明
admin_details	AdministratorDetails[]	organization管理者の詳細。
id	string	organizationの ID。