Release keyvault microsoft.key vault preview/2024 12 01 preview (#31796)

* Copy files from preview/2024-04-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-12-01-preview Updated the API version from preview/2024-04-01-preview to preview/2024-12-01-preview. * Added tag for 2024-12-01-preview in readme file * Added Azure Managed HSM C SKUs to preview version (#31733) * Update managedHsm.json * Update managedHsm.json * Changes to update default values and description and prettier ran (#31718) Co-authored-by: Fernando Rauseo Landa <frauseolanda@microsoft.com> * Update readme * misc fix * update tag * resolve ci issue * fixed typos and override words --------- Co-authored-by: Fernando Rauseo Landa <frauseolanda@microsoft.com> Co-authored-by: Daniel Cherrett <49488952+Cherrett@users.noreply.github.com> Co-authored-by: Chenjie Shi <tadelesh.shi@live.cn>
Azure · Jan 15, 2025 · bab617c · bab617c
1 parent 8b28a13
commit bab617c
Show file tree

Hide file tree

Showing 61 changed files with 9,377 additions and 0 deletions.
diff --git a/cSpell.json b/cSpell.json
@@ -427,6 +427,12 @@
                 "Regenerte"
             ]
         },
+        {
+            "filename": "**/specification/keyvault/resource-manager/readme.go.md",
+            "words": [
+                "modelerfour"
+            ]
+        },
         {
             "filename": "**/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json",
             "words": [

diff --git a/...ation/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-12-01-preview/common.json b/...ation/keyvault/resource-manager/Microsoft.KeyVault/preview/2024-12-01-preview/common.json
@@ -0,0 +1,94 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "2024-12-01-preview",
+    "title": "KeyVaultManagementClient",
+    "description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault."
+  },
+  "paths": {},
+  "definitions": {
+    "CloudError": {
+      "description": "An error response from Key Vault resource provider",
+      "properties": {
+        "error": {
+          "$ref": "#/definitions/CloudErrorBody"
+        }
+      },
+      "x-ms-external": true,
+      "type": "object"
+    },
+    "CloudErrorBody": {
+      "description": "An error response from Key Vault resource provider",
+      "properties": {
+        "code": {
+          "type": "string",
+          "description": "Error code. This is a mnemonic that can be consumed programmatically."
+        },
+        "message": {
+          "type": "string",
+          "description": "User friendly error message. The message is typically localized and may vary with service version."
+        }
+      },
+      "x-ms-external": true,
+      "type": "object"
+    },
+    "SystemData": {
+      "description": "Metadata pertaining to creation and last modification of the key vault resource.",
+      "readOnly": true,
+      "properties": {
+        "createdBy": {
+          "type": "string",
+          "description": "The identity that created the key vault resource."
+        },
+        "createdByType": {
+          "description": "The type of identity that created the key vault resource.",
+          "$ref": "#/definitions/IdentityType"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The timestamp of the key vault resource creation (UTC)."
+        },
+        "lastModifiedBy": {
+          "type": "string",
+          "description": "The identity that last modified the key vault resource."
+        },
+        "lastModifiedByType": {
+          "description": "The type of identity that last modified the key vault resource.",
+          "$ref": "#/definitions/IdentityType"
+        },
+        "lastModifiedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The timestamp of the key vault resource last modification (UTC)."
+        }
+      },
+      "type": "object"
+    },
+    "IdentityType": {
+      "type": "string",
+      "description": "The type of identity.",
+      "enum": [
+        "User",
+        "Application",
+        "ManagedIdentity",
+        "Key"
+      ],
+      "x-ms-enum": {
+        "name": "identityType",
+        "modelAsString": true
+      }
+    }
+  },
+  "securityDefinitions": {
+    "azure_auth": {
+      "type": "oauth2",
+      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
+      "flow": "implicit",
+      "description": "Azure Active Directory OAuth2 Flow",
+      "scopes": {
+        "user_impersonation": "impersonate your user account"
+      }
+    }
+  }
+}
diff --git a/...manager/Microsoft.KeyVault/preview/2024-12-01-preview/examples/DeletedManagedHsm_Get.json b/...manager/Microsoft.KeyVault/preview/2024-12-01-preview/examples/DeletedManagedHsm_Get.json
@@ -0,0 +1,28 @@
+{
+  "parameters": {
+    "name": "hsm1",
+    "location": "westus",
+    "subscriptionId": "00000000-0000-0000-0000-000000000000",
+    "api-version": "2024-12-01-preview"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm1",
+        "name": "vault-agile-drawer-6404",
+        "type": "Microsoft.KeyVault/deletedManagedHSMs",
+        "properties": {
+          "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
+          "location": "westus",
+          "deletionDate": "2021-04-01T00:00:59Z",
+          "scheduledPurgeDate": "2021-04-01T00:00:59Z",
+          "purgeProtectionEnabled": true,
+          "tags": {
+            "Dept": "hsm",
+            "Environment": "production"
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/...anager/Microsoft.KeyVault/preview/2024-12-01-preview/examples/DeletedManagedHsm_List.json b/...anager/Microsoft.KeyVault/preview/2024-12-01-preview/examples/DeletedManagedHsm_List.json
@@ -0,0 +1,47 @@
+{
+  "parameters": {
+    "subscriptionId": "00000000-0000-0000-0000-000000000000",
+    "api-version": "2024-12-01-preview"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm1",
+            "name": "vault-agile-drawer-6404",
+            "type": "Microsoft.KeyVault/deletedManagedHSMs",
+            "properties": {
+              "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
+              "location": "westus",
+              "deletionDate": "2021-04-01T00:00:59Z",
+              "scheduledPurgeDate": "2021-04-01T00:00:59Z",
+              "purgeProtectionEnabled": true,
+              "tags": {
+                "Dept": "hsm",
+                "Environment": "production"
+              }
+            }
+          },
+          {
+            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm2",
+            "name": "vault-agile-drawer-6404",
+            "type": "Microsoft.KeyVault/deletedManagedHSMs",
+            "properties": {
+              "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2",
+              "location": "westus",
+              "deletionDate": "2021-04-01T00:00:59Z",
+              "scheduledPurgeDate": "2021-04-01T00:00:59Z",
+              "purgeProtectionEnabled": true,
+              "tags": {
+                "Dept": "hsm",
+                "Environment": "production"
+              }
+            }
+          }
+        ],
+        "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedManagedHSMs?api-version=2024-12-01-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
+      }
+    }
+  }
+}
diff --git a/...nager/Microsoft.KeyVault/preview/2024-12-01-preview/examples/DeletedManagedHsm_Purge.json b/...nager/Microsoft.KeyVault/preview/2024-12-01-preview/examples/DeletedManagedHsm_Purge.json
@@ -0,0 +1,15 @@
+{
+  "parameters": {
+    "name": "hsm1",
+    "location": "westus",
+    "subscriptionId": "00000000-0000-0000-0000-000000000000",
+    "api-version": "2024-12-01-preview"
+  },
+  "responses": {
+    "202": {
+      "headers": {
+        "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/managedHsmOperationResults/00000000-0000-0000-0000-000000000000"
+      }
+    }
+  }
+}
diff --git a/...ger/Microsoft.KeyVault/preview/2024-12-01-preview/examples/ManagedHsm_CreateOrUpdate.json b/...ger/Microsoft.KeyVault/preview/2024-12-01-preview/examples/ManagedHsm_CreateOrUpdate.json
@@ -0,0 +1,89 @@
+{
+  "parameters": {
+    "resourceGroupName": "hsm-group",
+    "name": "hsm1",
+    "subscriptionId": "00000000-0000-0000-0000-000000000000",
+    "api-version": "2024-12-01-preview",
+    "parameters": {
+      "properties": {
+        "tenantId": "00000000-0000-0000-0000-000000000000",
+        "initialAdminObjectIds": [
+          "00000000-0000-0000-0000-000000000000"
+        ],
+        "enableSoftDelete": true,
+        "softDeleteRetentionInDays": 90,
+        "enablePurgeProtection": false
+      },
+      "location": "westus",
+      "sku": {
+        "family": "B",
+        "name": "Standard_B1"
+      },
+      "tags": {
+        "Dept": "hsm",
+        "Environment": "dogfood"
+      }
+    }
+  },
+  "responses": {
+    "202": {
+      "headers": {
+        "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/managedHsmOperationResults/00000000-0000-0000-0000-000000000000"
+      },
+      "body": {
+        "properties": {
+          "tenantId": "00000000-0000-0000-0000-000000000000",
+          "initialAdminObjectIds": [
+            "00000000-0000-0000-0000-000000000000"
+          ],
+          "enableSoftDelete": true,
+          "softDeleteRetentionInDays": 90,
+          "enablePurgeProtection": false,
+          "hsmUri": null,
+          "provisioningState": "Provisioning",
+          "statusMessage": "Allocating hardware"
+        },
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
+        "name": "hsm1",
+        "type": "Microsoft.KeyVault/managedHSMs",
+        "location": "westus",
+        "sku": {
+          "family": "B",
+          "name": "Standard_B1"
+        },
+        "tags": {
+          "Dept": "hsm",
+          "Environment": "dogfood"
+        }
+      }
+    },
+    "200": {
+      "body": {
+        "properties": {
+          "tenantId": "00000000-0000-0000-0000-000000000000",
+          "initialAdminObjectIds": [
+            "00000000-0000-0000-0000-000000000000"
+          ],
+          "enableSoftDelete": true,
+          "softDeleteRetentionInDays": 90,
+          "enablePurgeProtection": false,
+          "hsmUri": "https://westus.hsm1.managedhsm.azure.net",
+          "provisioningState": "Succeeded",
+          "statusMessage": "ManagedHsm is functional."
+        },
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
+        "name": "hsm1",
+        "type": "Microsoft.KeyVault/managedHSMs",
+        "location": "westus",
+        "sku": {
+          "family": "B",
+          "name": "Standard_B1"
+        },
+        "tags": {
+          "Dept": "hsm",
+          "Environment": "dogfood"
+        }
+      }
+    }
+  }
+}
diff --git a/...rce-manager/Microsoft.KeyVault/preview/2024-12-01-preview/examples/ManagedHsm_Delete.json b/...rce-manager/Microsoft.KeyVault/preview/2024-12-01-preview/examples/ManagedHsm_Delete.json
@@ -0,0 +1,17 @@
+{
+  "parameters": {
+    "resourceGroupName": "hsm-group",
+    "name": "hsm1",
+    "subscriptionId": "00000000-0000-0000-0000-000000000000",
+    "api-version": "2024-12-01-preview"
+  },
+  "responses": {
+    "200": {},
+    "202": {
+      "headers": {
+        "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/managedHsmOperationResults/00000000-0000-0000-0000-000000000000"
+      }
+    },
+    "204": {}
+  }
+}
diff --git a/...source-manager/Microsoft.KeyVault/preview/2024-12-01-preview/examples/ManagedHsm_Get.json b/...source-manager/Microsoft.KeyVault/preview/2024-12-01-preview/examples/ManagedHsm_Get.json
@@ -0,0 +1,39 @@
+{
+  "parameters": {
+    "resourceGroupName": "hsm-group",
+    "name": "hsm1",
+    "subscriptionId": "00000000-0000-0000-0000-000000000000",
+    "api-version": "2024-12-01-preview"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "properties": {
+          "tenantId": "00000000-0000-0000-0000-000000000000",
+          "initialAdminObjectIds": [
+            "00000000-0000-0000-0000-000000000000"
+          ],
+          "enableSoftDelete": true,
+          "softDeleteRetentionInDays": 90,
+          "enablePurgeProtection": false,
+          "hsmUri": "https://westus.hsm1.managedhsm.azure.net",
+          "provisioningState": "Succeeded",
+          "statusMessage": "ManagedHsm is functional."
+        },
+        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
+        "name": "hsm1",
+        "type": "Microsoft.KeyVault/managedHSMs",
+        "location": "westus",
+        "sku": {
+          "family": "B",
+          "name": "Standard_B1"
+        },
+        "tags": {
+          "Dept": "hsm",
+          "Environment": "dogfood"
+        }
+      }
+    },
+    "204": {}
+  }
+}