-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update default values and descriptions for Key Vault on API Version 2…
…024-11-01 (#31713) * Copy files from stable/2023-07-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-11-01 Updated the API version from stable/2023-07-01 to stable/2024-11-01. * Added tag for 2024-11-01 in readme file * Removed unnecessary folder * Update default values and descriptions for Key Vault (#31683) * Initial Changes to Spec * Prettier ran * Ran prettier --------- Co-authored-by: Fernando Rauseo Landa <frauseolanda@microsoft.com> * Ran prettier * Ran prettier on all files * Update managedHsm.json (#31732) * typo fix --------- Co-authored-by: Fernando Rauseo Landa <frauseolanda@microsoft.com> Co-authored-by: Daniel Cherrett <49488952+Cherrett@users.noreply.github.com>
- Loading branch information
Showing
57 changed files
with
9,085 additions
and
2 deletions.
There are no files selected for viewing
94 changes: 94 additions & 0 deletions
94
specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/common.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "version": "2024-11-01", | ||
| "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" | ||
| } | ||
| } | ||
| } | ||
| } |
28 changes: 28 additions & 0 deletions
28
...resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/DeletedManagedHsm_Get.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| { | ||
| "parameters": { | ||
| "name": "hsm1", | ||
| "location": "westus", | ||
| "subscriptionId": "00000000-0000-0000-0000-000000000000", | ||
| "api-version": "2024-11-01" | ||
| }, | ||
| "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" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
47 changes: 47 additions & 0 deletions
47
...esource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/DeletedManagedHsm_List.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| { | ||
| "parameters": { | ||
| "subscriptionId": "00000000-0000-0000-0000-000000000000", | ||
| "api-version": "2024-11-01" | ||
| }, | ||
| "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-11-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng==" | ||
| } | ||
| } | ||
| } | ||
| } |
15 changes: 15 additions & 0 deletions
15
...source-manager/Microsoft.KeyVault/stable/2024-11-01/examples/DeletedManagedHsm_Purge.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| { | ||
| "parameters": { | ||
| "name": "hsm1", | ||
| "location": "westus", | ||
| "subscriptionId": "00000000-0000-0000-0000-000000000000", | ||
| "api-version": "2024-11-01" | ||
| }, | ||
| "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" | ||
| } | ||
| } | ||
| } | ||
| } |
89 changes: 89 additions & 0 deletions
89
...urce-manager/Microsoft.KeyVault/stable/2024-11-01/examples/ManagedHsm_CreateOrUpdate.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| { | ||
| "parameters": { | ||
| "resourceGroupName": "hsm-group", | ||
| "name": "hsm1", | ||
| "subscriptionId": "00000000-0000-0000-0000-000000000000", | ||
| "api-version": "2024-11-01", | ||
| "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" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
17 changes: 17 additions & 0 deletions
17
...ult/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/ManagedHsm_Delete.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "parameters": { | ||
| "resourceGroupName": "hsm-group", | ||
| "name": "hsm1", | ||
| "subscriptionId": "00000000-0000-0000-0000-000000000000", | ||
| "api-version": "2024-11-01" | ||
| }, | ||
| "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": {} | ||
| } | ||
| } |
39 changes: 39 additions & 0 deletions
39
...yvault/resource-manager/Microsoft.KeyVault/stable/2024-11-01/examples/ManagedHsm_Get.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| { | ||
| "parameters": { | ||
| "resourceGroupName": "hsm-group", | ||
| "name": "hsm1", | ||
| "subscriptionId": "00000000-0000-0000-0000-000000000000", | ||
| "api-version": "2024-11-01" | ||
| }, | ||
| "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": {} | ||
| } | ||
| } |
Oops, something went wrong.