Övervaka och hantera processen för att skapa certifikat

  • Artikel

Gäller för: Azure

Scenarier/åtgärder som beskrivs i den här artikeln är:

  • Begära ett KV-certifikat med en utfärdare som stöds
  • Hämta väntande begäran – status för begäran är "inProgress"
  • Hämta väntande begäran – statusen för begäran är "fullständig"
  • Hämta väntande begäran – statusen för väntande begäran är "avbruten" eller "misslyckad"
  • Hämta väntande begäran – väntande begärandestatus "tas bort" eller "skrivs över"
  • Skapa (eller importera) när väntande begäran finns – statusen är "inProgress"
  • Sammanfoga när väntande begäran skapas med en utfärdare (DigiCert, till exempel)
  • Begär en annullering medan statusen för väntande begäran är "inProgress"
  • Ta bort ett väntande begärandeobjekt
  • Skapa ett KV-certifikat manuellt
  • Sammanfoga när en väntande begäran skapas – manuellt skapande av certifikat

Begära ett KV-certifikat med en utfärdare som stöds

Metod URI för förfrågan
POST https://mykeyvault.vault.azure.net/certificates/mycert1/create?api-version={api-version}

Följande exempel kräver att ett objekt med namnet "mydigicert" redan är tillgängligt i ditt nyckelvalv med utfärdarprovidern som DigiCert. Certifikatutfärdaren är en entitet som representeras i Azure Key Vault (KV) som en CertificateIssuer-resurs. Den används för att ge information om källan till ett KV-certifikat. utfärdarnamn, provider, autentiseringsuppgifter och annan administrativ information.

Begär

{
  "policy": {
    "x509_props": {
      "subject": "CN=MyCertSubject1"
    },
    "issuer": {
      "name": "mydigicert",
      "cty": "OV-SSL",
    }
  }
}

Response

StatusCode: 202, ReasonPhrase: 'Accepted'
Location: “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}&request_id=a76827a18b63421c917da80f28e9913d"
{
  "id": “https://mykeyvault.vault.azure.net/certificates/mycert1/pending",
  "issuer": {
    "name": "mydigicert"
  },
  "csr": "MIICq......DD5Lp5cqXg==",
  "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": "a76827a18b63421c917da80f28e9913d"
}

Hämta väntande begäran – status för begäran är "inProgress"

Metod URI för förfrågan
GET https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}

Förfrågan

GET “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}&request_id=a76827a18b63421c917da80f28e9913d"

ELLER

GET “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}"

Kommentar

Om request_id anges i frågan fungerar det som ett filter. Om request_id i frågan och i det väntande objektet är annorlunda returneras en http-statuskod på 404.

Response

StatusCode: 200, ReasonPhrase: 'OK'
{
  "id": “https://mykeyvault.vault.azure.net/certificates/mycert1/pending",
  "issuer": {
    "name": "{issuer-name}"
  },
  "csr": "MIICq......DD5Lp5cqXg==",
  "cancellation_requested": false,
  "status": "inProgress",
  "status_details": "…",
  "request_id": "a76827a18b63421c917da80f28e9913d"
}

Hämta väntande begäran – statusen för begäran är "fullständig"

Förfrågan

Metod URI för förfrågan
GET https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}

GET “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}&request_id=a76827a18b63421c917da80f28e9913d"

ELLER

GET “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}"

Response

StatusCode: 200, ReasonPhrase: 'OK'
{
  "id": “https://mykeyvault.vault.azure.net/certificates/mycert1/pending",
  "issuer": {
    "name": "{issuer-name}"
  },
  "csr": "MIICq......DD5Lp5cqXg==",
  "cancellation_requested": false,
  "status": "completed",
  "request_id": "a76827a18b63421c917da80f28e9913d",
  "target": “https://mykeyvault.vault.azure.net/certificates/mycert1?api-version={api-version}"
}

Hämta väntande begäran – statusen för väntande begäran är "avbruten" eller "misslyckad"

Förfrågan

Metod URI för förfrågan
GET https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}

GET “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}&request_id=a76827a18b63421c917da80f28e9913d"

ELLER

GET “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}"

Svar

StatusCode: 200, ReasonPhrase: 'OK'
{
  "id": “https://mykeyvault.vault.azure.net/certificates/mycert1/pending",
  "issuer": {
    "name": "{issuer-name}"
  },
  "csr": "MIICq......DD5Lp5cqXg==",
  "cancellation_requested": false,
  "status": "failed",
  "status_details": "",
  "request_id": "a76827a18b63421c917da80f28e9913d",
  "error": {
    "code": "<errorcode>",
    "message": "<message>"
  }
}

Kommentar

Värdet för felkoden kan vara "Certifikatutfärdarfel" eller "Begäran avvisades" baserat på utfärdare respektive användarfel.

Hämta väntande begäran – väntande begärandestatus "tas bort" eller "skrivs över"

Ett väntande objekt kan tas bort eller skrivas över av en create/import-åtgärd när dess status inte inProgressär .

Metod URI för förfrågan
GET https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}

Förfrågan

GET “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}&request_id=a76827a18b63421c917da80f28e9913d"

ELLER

GET “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}"

Response

StatusCode: 404, ReasonPhrase: 'Not Found'
{
  "error": {
    "code": "PendingCertificateNotFound",
    "message": "…"
  }
}

Skapa (eller importera) när väntande begäran finns – statusen är "inProgress"

Ett väntande objekt har fyra möjliga tillstånd. "inprogress", "canceled", "failed" eller "completed".

När statusen för en väntande begäran är "inprogress" misslyckas åtgärderna för att skapa (och importera) med http-statuskoden 409 (konflikt).

Så här åtgärdar du en konflikt:

  • Om certifikatet skapas manuellt kan du antingen slutföra KV-certifikatet genom att göra en sammanslagning eller ta bort det väntande objektet.

  • Om certifikatet skapas med en utfärdare kan du vänta tills certifikatet har slutförts, misslyckas eller avbryts. Du kan också ta bort det väntande objektet.

Kommentar

Om du tar bort ett väntande objekt kanske eller inte avbryter du x509-certifikatbegäran med providern.

Metod URI för förfrågan
POST https://mykeyvault.vault.azure.net/certificates/mycert1/create?api-version={api-version}

Begär

{
  "policy": {
    "x509_props": {
      "subject": "CN=MyCertSubject1"
    },
    "issuer": {
      "name": "mydigicert"
    }
  }
}

Response

StatusCode: 409, ReasonPhrase: 'Conflict'
{
  "error": {
    "code": "Forbidden",
    "message": "A new key vault certificate can not be created or imported while a pending key vault certificate's status is inProgress."
  }
}

Sammanfoga när väntande begäran skapas med en utfärdare

Sammanfogning tillåts inte när ett väntande objekt skapas med en utfärdare, men tillåts när dess tillstånd är inProgress.

Om begäran om att skapa x509-certifikatet misslyckas eller avbryts av någon anledning, och om ett x509-certifikat kan hämtas med out-of-band-medel, kan en sammanslagningsåtgärd utföras för att slutföra KV-certifikatet.

Metod URI för förfrågan
POST https://mykeyvault.vault.azure.net/certificates/mycert1/pending/merge?api-version={api-version}

Begär

{
  "x5c": [ "MIICxTCCAbi………………………trimmed for brevitiy……………………………………………EPAQj8=" ]
}

Response

StatusCode: 403, ReasonPhrase: 'Forbidden'
{
  "error": {
    "code": "Forbidden",
    "message": "Merge is forbidden on pending object created with issuer : <issuer-name> while it is in progess."
  }
}

Begär en annullering medan statusen för väntande begäran är "inProgress"

En annullering kan bara begäras. En begäran kan avbrytas eller inte. Om en begäran inte är "inProgress" returneras http-statusen 400 (felaktig begäran).

Metod URI för förfrågan
PATCH https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}

Förfrågan

LAPP “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}&request_id=a76827a18b63421c917da80f28e9913d"

ELLER

LAPP “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}"

{
  "cancellation_requested": true
}

Response

StatusCode: 200, ReasonPhrase: 'OK'
{
  "id": “https://mykeyvault.vault.azure.net/certificates/mycert1/pending",
  "issuer": {
    "name": "{issuer-name}"
  },
  "csr": "MIICq......DD5Lp5cqXg==",
  "cancellation_requested": true,
  "status": "inProgress",
  "status_details": "…",
  "request_id": "a76827a18b63421c917da80f28e9913d"
}

Ta bort ett väntande begärandeobjekt

Kommentar

Om du tar bort det väntande objektet kanske eller inte avbryter du x509-certifikatbegäran med providern.

Metod URI för förfrågan
DELETE https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}

Förfrågan

TA BORT “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}&request_id=a76827a18b63421c917da80f28e9913d"

ELLER

TA BORT “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}"

Response

StatusCode: 200, ReasonPhrase: 'OK'
{
  "id": “https://mykeyvault.vault.azure.net/certificates/mycert1/pending",
  "issuer": {
    "name": "{issuer-name}"
  },
  "csr": "MIICq......DD5Lp5cqXg==",
  "cancellation_requested": false,
  "status": "inProgress",
  "request_id": "a76827a18b63421c917da80f28e9913d",
}

Skapa ett KV-certifikat manuellt

Du kan skapa ett certifikat som utfärdats med valfri certifikatutfärdare genom en manuell skapandeprocess. Ange namnet på utfärdaren till "Okänd" eller ange inte utfärdarfältet.

Metod URI för förfrågan
POST https://mykeyvault.vault.azure.net/certificates/mycert1/create?api-version={api-version}

Begär

{
  "policy": {
    "x509_props": {
      "subject": "CN=MyCertSubject1"
    },
    "issuer": {
      "name": "Unknown"
    }
  }
}

Response

StatusCode: 202, ReasonPhrase: 'Accepted'
Location: “https://mykeyvault.vault.azure.net/certificates/mycert1/pending?api-version={api-version}&request_id=a76827a18b63421c917da80f28e9913d"
{
  "id": “https://mykeyvault.vault.azure.net/certificates/mycert1/pending",
  "issuer": {
    "name": "Unknown"
  },
  "csr": "MIICq......DD5Lp5cqXg==",
  "status": "inProgress",
  "status_details": "Pending certificate created. Please Perform Merge to complete the request.",
  "request_id": "a76827a18b63421c917da80f28e9913d"
}

Sammanfoga när en väntande begäran skapas – manuellt skapande av certifikat

Metod URI för förfrågan
POST https://mykeyvault.vault.azure.net/certificates/mycert1/pending/merge?api-version={api-version}

Förfrågan

{
  "x5c": [ "MIICxTCCAbi………………………trimmed for brevitiy……………………………………………EPAQj8=" ]
}
Elementnamn Obligatoriskt Typ Version beskrivning
x5c Ja matris <introduktion till version> X509-certifikatkedja som bas 64-strängmatris.

Response

StatusCode: 201, ReasonPhrase: 'Created'
Location: “https://mykeyvault.vault.azure.net/certificates/mycert1?api-version={api-version}"
{
	"id": "https mykeyvault.vault.azure.net/certificates/mycert1/f366e1a9dd774288ad84a45a5f620352",
	"kid": "https:// mykeyvault.vault.azure.net/keys/mycert1/f366e1a9dd774288ad84a45a5f620352",
	"sid": " mykeyvault.vault.azure.net/secrets/mycert1/f366e1a9dd774288ad84a45a5f620352",
	"cer": "……de34534……",
	"x5t": "n14q2wbvyXr71Pcb58NivuiwJKk",
	"attributes": {
		"enabled": true,
		"exp": 1530394215,
		"nbf": 1435699215,
		"created": 1435699919,
		"updated": 1435699919
	},
	"pending": {
		"id": "https:// mykeyvault.vault.azure.net/certificates/mycert1/pending"
	},
	"policy": {
		"id": "https:// mykeyvault.vault.azure.net/certificates/mycert1/policy",
		"key_props": {
			"exportable": false,
			"kty": "RSA",
			"key_size": 2048,
			"reuse_key": false
		},
		"secret_props": {
			"contentType": "application/x-pkcs12"
		},
		"x509_props": {
			"subject": "CN=Mycert1",
			"ekus": ["1.3.6.1.5.5.7.3.1", "1.3.6.1.5.5.7.3.2"],
			"validity_months": 12
		},
		"lifetime_actions": [{
			"trigger": {
				"lifetime_percentage": 80
			},
			"action": {
				"action_type": "EmailContacts"
			}
		}],
		"issuer": {
			"name": "Unknown"
		},
		"attributes": {
			"enabled": true,
			"created": 1435699811,
			"updated": 1435699811
		}
	}
}