From 9cfee0b4b77adc0b15a6dac2b233d671d40c67cc Mon Sep 17 00:00:00 2001 From: David Edge Date: Mon, 14 Feb 2022 15:49:54 -0800 Subject: [PATCH 1/4] Add EntityId to the API definitions for secrets, keys, and certificates --- .../preview/7.4-preview.1/certificates.json | 10 ++++++++++ .../Microsoft.KeyVault/preview/7.4-preview.1/keys.json | 10 ++++++++++ .../preview/7.4-preview.1/secrets.json | 10 ++++++++++ 3 files changed, 30 insertions(+) diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/certificates.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/certificates.json index f4832f23e4d9..0e0568089271 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/certificates.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/certificates.json @@ -1331,6 +1331,11 @@ "type": "string", "format": "base64url", "description": "Thumbprint of the certificate." + }, + "entityId": { + "type": "string", + "readOnly": true, + "description": "The system-generated ID for this secret." } }, "description": "The certificate item containing certificate metadata." @@ -1396,6 +1401,11 @@ "type": "string" }, "description": "Application specific metadata in the form of key-value pairs" + }, + "entityId": { + "type": "string", + "readOnly": true, + "description": "The system-generated ID for this secret." } }, "description": "A certificate bundle consists of a certificate (X509) plus its attributes." diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/keys.json index 743076929e45..a9bfd082aa31 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/keys.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/keys.json @@ -1572,6 +1572,11 @@ "$ref": "#/definitions/KeyReleasePolicy", "x-nullable": true, "description": "The policy rules under which the key can be exported." + }, + "entityId": { + "type": "string", + "readOnly": true, + "description": "The system-generated ID for this secret." } }, "description": "A KeyBundle consisting of a WebKey plus its attributes." @@ -1597,6 +1602,11 @@ "type": "boolean", "readOnly": true, "description": "True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true." + }, + "entityId": { + "type": "string", + "readOnly": true, + "description": "The system-generated ID for this secret." } }, "description": "The key item containing key metadata." diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/secrets.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/secrets.json index 67e8e9cfb403..64e210bcda4d 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/secrets.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/secrets.json @@ -609,6 +609,11 @@ "type": "boolean", "readOnly": true, "description": "True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true." + }, + "entityId": { + "type": "string", + "readOnly": true, + "description": "The system-generated ID for this secret." } }, "description": "A secret consisting of a value, id and its attributes." @@ -638,6 +643,11 @@ "type": "boolean", "readOnly": true, "description": "True if the secret's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true." + }, + "entityId": { + "type": "string", + "readOnly": true, + "description": "The system-generated ID for this secret." } }, "description": "The secret item containing secret metadata." From 8e794ace8a4693b1c57967e7faf469f4cf1c331c Mon Sep 17 00:00:00 2001 From: David Edge Date: Mon, 14 Feb 2022 16:45:00 -0800 Subject: [PATCH 2/4] fixed typos on entity ID --- .../preview/7.4-preview.1/certificates.json | 4 ++-- .../Microsoft.KeyVault/preview/7.4-preview.1/keys.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/certificates.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/certificates.json index 0e0568089271..e431c9c21bd6 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/certificates.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/certificates.json @@ -1335,7 +1335,7 @@ "entityId": { "type": "string", "readOnly": true, - "description": "The system-generated ID for this secret." + "description": "The system-generated ID for this certificate." } }, "description": "The certificate item containing certificate metadata." @@ -1405,7 +1405,7 @@ "entityId": { "type": "string", "readOnly": true, - "description": "The system-generated ID for this secret." + "description": "The system-generated ID for this certificate." } }, "description": "A certificate bundle consists of a certificate (X509) plus its attributes." diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/keys.json index a9bfd082aa31..e0b0d2202815 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/keys.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/keys.json @@ -1576,7 +1576,7 @@ "entityId": { "type": "string", "readOnly": true, - "description": "The system-generated ID for this secret." + "description": "The system-generated ID for this key." } }, "description": "A KeyBundle consisting of a WebKey plus its attributes." @@ -1606,7 +1606,7 @@ "entityId": { "type": "string", "readOnly": true, - "description": "The system-generated ID for this secret." + "description": "The system-generated ID for this key." } }, "description": "The key item containing key metadata." From a467f3ba0c6de49eac47fadcb6dee31b6de66002 Mon Sep 17 00:00:00 2001 From: David Edge Date: Tue, 15 Feb 2022 14:54:59 -0800 Subject: [PATCH 3/4] added entityId to the api samples --- .../7.4-preview.1/examples/CreateCertificate-example.json | 3 ++- .../preview/7.4-preview.1/examples/CreateKey-example.json | 3 ++- .../7.4-preview.1/examples/GetCertificate-example.json | 3 ++- .../examples/GetCertificateVersions-example.json | 6 ++++-- .../7.4-preview.1/examples/GetCertificates-example.json | 6 ++++-- .../preview/7.4-preview.1/examples/GetKey-example.json | 3 ++- .../preview/7.4-preview.1/examples/GetKeys-example.json | 3 ++- .../preview/7.4-preview.1/examples/GetSecret-example.json | 3 ++- .../preview/7.4-preview.1/examples/GetSecrets-example.json | 3 ++- 9 files changed, 22 insertions(+), 11 deletions(-) diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/CreateCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/CreateCertificate-example.json index 67807840edd5..09bae54d4a45 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/CreateCertificate-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/CreateCertificate-example.json @@ -40,7 +40,8 @@ "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" + "request_id": "6faacd568ab049a2803861e8dd3ae21f", + "entityId": "98802922-c3e8-4aa9-9216-28df27039b0d" } } } diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/CreateKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/CreateKey-example.json index 2a396180a488..f91ebf841034 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/CreateKey-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/CreateKey-example.json @@ -47,7 +47,8 @@ "tags": { "purpose": "unit test", "test name ": "CreateGetDeleteKeyTest" - } + }, + "entityId": "98802922-c3e8-4aa9-9216-28df27039b0d" } } } diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificate-example.json index a7adf3fd0203..cf08965287fe 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificate-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificate-example.json @@ -55,7 +55,8 @@ "enabled": true, "created": 1493938289, "updated": 1493938291 - } + }, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" } } } diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificateVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificateVersions-example.json index ad3e46e33254..1caa767c514d 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificateVersions-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificateVersions-example.json @@ -16,7 +16,8 @@ "nbf": 1430344421, "exp": 2208988799, "created": 1482189534, - "updated": 1482189534 + "updated": 1482189534, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" } }, { @@ -27,7 +28,8 @@ "nbf": 1430344421, "exp": 2208988799, "created": 1482189532, - "updated": 1482189532 + "updated": 1482189532, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" } } ], diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificates-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificates-example.json index d221a97789e8..d26bf4dcc31d 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificates-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificates-example.json @@ -15,7 +15,8 @@ "nbf": 1430344421, "exp": 2208988799, "created": 1482188987, - "updated": 1482188987 + "updated": 1482188987, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" } }, { @@ -26,7 +27,8 @@ "nbf": 1430344421, "exp": 2208988799, "created": 1482188988, - "updated": 1482188988 + "updated": 1482188988, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" } } ], diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetKey-example.json index 485577f92eb7..38791b6c34a2 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetKey-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetKey-example.json @@ -31,7 +31,8 @@ "tags": { "purpose": "unit test", "test name ": "CreateGetDeleteKeyTest" - } + }, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" } } } diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetKeys-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetKeys-example.json index 52d826b2b2f6..7e6e896c81ce 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetKeys-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetKeys-example.json @@ -16,7 +16,8 @@ "created": 1493937656, "updated": 1493937656, "recoveryLevel": "Recoverable+Purgeable" - } + }, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" } ], "nextLink": "https://myvault.vault.azure.net:443/keys?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE5NiFNREF3TURJM0lXdGxlUzlWVUVSQlZFVkxSVmxCVkZSU1NVSlZWRVZUVkVWVFZDRXdNREF3TWpnaE1qQXhOeTB3TlMwd05GUXdNVG94TVRveE5pNDNNekE0TnpReVdpRS0iLCJUYXJnZXRMb2NhdGlvbiI6MH0&maxresults=1" diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetSecret-example.json index e1e7af8d5400..447804116601 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetSecret-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetSecret-example.json @@ -15,7 +15,8 @@ "created": 1493938410, "updated": 1493938410, "recoveryLevel": "Recoverable+Purgeable" - } + }, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" } } } diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetSecrets-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetSecrets-example.json index b98329d7d2d7..a5c1f24188cb 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetSecrets-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetSecrets-example.json @@ -15,7 +15,8 @@ "enabled": true, "created": 1482189047, "updated": 1482189047 - } + }, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" } ], "nextLink": "https://myvault.vault.azure.net:443/secrets?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE4OCFNREF3TURJeUlYTmxZM0psZEM5TVNWTlVVMFZEVWtWVVZFVlRWREVoTURBd01ESTRJVEl3TVRZdE1USXRNVGxVTWpNNk1UQTZORFV1T0RneE9ERXhNRm9oIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1" From 5369e982be606485e063eedf3db8b4ed5d3f1386 Mon Sep 17 00:00:00 2001 From: David Edge Date: Wed, 16 Feb 2022 15:11:06 -0800 Subject: [PATCH 4/4] fixed examples --- .../examples/CreateCertificate-example.json | 3 +-- .../examples/GetCertificate-example.json | 6 +++--- .../examples/GetCertificateVersions-example.json | 12 ++++++------ .../examples/GetCertificates-example.json | 12 ++++++------ 4 files changed, 16 insertions(+), 17 deletions(-) diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/CreateCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/CreateCertificate-example.json index 09bae54d4a45..67807840edd5 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/CreateCertificate-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/CreateCertificate-example.json @@ -40,8 +40,7 @@ "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", - "entityId": "98802922-c3e8-4aa9-9216-28df27039b0d" + "request_id": "6faacd568ab049a2803861e8dd3ae21f" } } } diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificate-example.json index cf08965287fe..c4d89b1c913d 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificate-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificate-example.json @@ -55,9 +55,9 @@ "enabled": true, "created": 1493938289, "updated": 1493938291 - }, - "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" - } + } + }, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" } } } diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificateVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificateVersions-example.json index 1caa767c514d..ecf4749207c2 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificateVersions-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificateVersions-example.json @@ -16,9 +16,9 @@ "nbf": 1430344421, "exp": 2208988799, "created": 1482189534, - "updated": 1482189534, - "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" - } + "updated": 1482189534 + }, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" }, { "id": "https://myvault.vault.azure.net/certificates/listVersionsCert01/7fcb3e9eb8bf43f3a6ff4b9c3740801d", @@ -28,9 +28,9 @@ "nbf": 1430344421, "exp": 2208988799, "created": 1482189532, - "updated": 1482189532, - "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" - } + "updated": 1482189532 + }, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" } ], "nextLink": null diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificates-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificates-example.json index d26bf4dcc31d..94307f72ff12 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificates-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.4-preview.1/examples/GetCertificates-example.json @@ -15,9 +15,9 @@ "nbf": 1430344421, "exp": 2208988799, "created": 1482188987, - "updated": 1482188987, - "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" - } + "updated": 1482188987 + }, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" }, { "id": "https://myvault.vault.azure.net/certificates/listCert02", @@ -27,9 +27,9 @@ "nbf": 1430344421, "exp": 2208988799, "created": 1482188988, - "updated": 1482188988, - "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" - } + "updated": 1482188988 + }, + "entityId": "d1b835e8-29b8-40d7-8bc8-9a0c629fc87a" } ], "nextLink": null