Skip to content

Commit 02a1900

Browse files
rahulalapati43Rahul Alapati
rahulalapati43
and
Rahul Alapati
authored
Dev keyvault microsoft.key vault 2022 02 01 preview swagger completeness (#22154)
* Adds base for updating Microsoft.KeyVault from version stable/2022-07-01 to version 2022-02-01-preview * Updates readme * Updates API version in new specs and examples * Fixed breaking changes in managedHsm.json. (#22112) Fixed LRO_RESPONSE_HEADER, INVALID_REQUEST_PARAMETER and OBJECT_MISSING_REQUIRED_PROPERTY errors. Co-authored-by: Rahul Alapati <rahulalapati@microsoft.com> * Undid the API version changes to the Vaults_List API (#22142) * Fixed breaking changes in managedHsm.json. Fixed LRO_RESPONSE_HEADER, INVALID_REQUEST_PARAMETER and OBJECT_MISSING_REQUIRED_PROPERTY errors. * Undid the API Version change to the VaultListFilterTypes API. Co-authored-by: Rahul Alapati <rahulalapati@microsoft.com> * Update listVault.json (#22155) * Update listVault.json * Remove the preview API version for the enum * Delete Vault_Lists API specification * Added the Vaults_List swagger specification back. * Abstracted Vaults_List API into 2015-11-01 directory to Swagger ModelValidation Errors. * Resolved unresolvable references. * Reorganized the definitions. * Reorganized the 2015-11-01 directory under 2022-02-01-preview * Moved the 2015-11-10 directory to stable. * Undo the abstraction changes. * Readd the listVault.json. * Added suppression directives for INVALID_REQUEST_PARAMETER and OBJECT_MISSING_REQUIRED_PROPERTY. * Modify suppress rule. * Update the suppression directive. * Update suppression directive. * Update suppression directive. * Update suppression directives. * Updated suppression directive. * Added suppression directives for INVALID_REQUEST_PARAMETER, OBJECT_MISSING_REQUIRED_PROPERTY * Updated suppression directives. * Updated suppression directives. * Updated suppression directives. * Updated suppression directives. * Updated suppression directives. * Added x-ms-validation rules to the api-version parameter. * Updated suppression directives. * Added individual suppression directives. * Removed where clause from the OBJECT_MISSING_REQUIRED_PROPERTY suppression directive. * Corrected yaml title for suppression directives. Co-authored-by: Rahul Alapati <rahulalapati@microsoft.com> --------- Co-authored-by: Rahul Alapati <rahulalapati@microsoft.com>
1 parent c1eb413 commit 02a1900

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+8036
-3
lines changed

‎specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2022-02-01-preview/common.json‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"version": "2022-02-01-preview",
5+
"title": "KeyVaultManagementClient",
6+
"description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault."
7+
},
8+
"paths": {},
9+
"definitions": {
10+
"CloudError": {
11+
"description": "An error response from Key Vault resource provider",
12+
"properties": {
13+
"error": {
14+
"$ref": "#/definitions/CloudErrorBody"
15+
}
16+
},
17+
"x-ms-external": true,
18+
"type": "object"
19+
},
20+
"CloudErrorBody": {
21+
"description": "An error response from Key Vault resource provider",
22+
"properties": {
23+
"code": {
24+
"type": "string",
25+
"description": "Error code. This is a mnemonic that can be consumed programmatically."
26+
},
27+
"message": {
28+
"type": "string",
29+
"description": "User friendly error message. The message is typically localized and may vary with service version."
30+
}
31+
},
32+
"x-ms-external": true,
33+
"type": "object"
34+
},
35+
"SystemData": {
36+
"description": "Metadata pertaining to creation and last modification of the key vault resource.",
37+
"readOnly": true,
38+
"properties": {
39+
"createdBy": {
40+
"type": "string",
41+
"description": "The identity that created the key vault resource."
42+
},
43+
"createdByType": {
44+
"description": "The type of identity that created the key vault resource.",
45+
"$ref": "#/definitions/IdentityType"
46+
},
47+
"createdAt": {
48+
"type": "string",
49+
"format": "date-time",
50+
"description": "The timestamp of the key vault resource creation (UTC)."
51+
},
52+
"lastModifiedBy": {
53+
"type": "string",
54+
"description": "The identity that last modified the key vault resource."
55+
},
56+
"lastModifiedByType": {
57+
"description": "The type of identity that last modified the key vault resource.",
58+
"$ref": "#/definitions/IdentityType"
59+
},
60+
"lastModifiedAt": {
61+
"type": "string",
62+
"format": "date-time",
63+
"description": "The timestamp of the key vault resource last modification (UTC)."
64+
}
65+
},
66+
"type": "object"
67+
},
68+
"IdentityType": {
69+
"type": "string",
70+
"description": "The type of identity.",
71+
"enum": [
72+
"User",
73+
"Application",
74+
"ManagedIdentity",
75+
"Key"
76+
],
77+
"x-ms-enum": {
78+
"name": "identityType",
79+
"modelAsString": true
80+
}
81+
}
82+
},
83+
"securityDefinitions": {
84+
"azure_auth": {
85+
"type": "oauth2",
86+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
87+
"flow": "implicit",
88+
"description": "Azure Active Directory OAuth2 Flow",
89+
"scopes": {
90+
"user_impersonation": "impersonate your user account"
91+
}
92+
}
93+
}
94+
}

‎specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2022-02-01-preview/examples/DeletedManagedHsm_Get.json‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"parameters": {
3+
"name": "hsm1",
4+
"location": "westus",
5+
"subscriptionId": "00000000-0000-0000-0000-000000000000",
6+
"api-version": "2022-02-01-preview"
7+
},
8+
"responses": {
9+
"200": {
10+
"body": {
11+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm1",
12+
"name": "vault-agile-drawer-6404",
13+
"type": "Microsoft.KeyVault/deletedManagedHSMs",
14+
"properties": {
15+
"mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
16+
"location": "westus",
17+
"deletionDate": "2022-02-01T00:00:59Z",
18+
"scheduledPurgeDate": "2022-02-01T00:00:59Z",
19+
"purgeProtectionEnabled": true,
20+
"tags": {
21+
"Dept": "hsm",
22+
"Environment": "production"
23+
}
24+
}
25+
}
26+
}
27+
}
28+
}

‎specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2022-02-01-preview/examples/DeletedManagedHsm_List.json‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "00000000-0000-0000-0000-000000000000",
4+
"api-version": "2022-02-01-preview"
5+
},
6+
"responses": {
7+
"200": {
8+
"body": {
9+
"value": [
10+
{
11+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm1",
12+
"name": "vault-agile-drawer-6404",
13+
"type": "Microsoft.KeyVault/deletedManagedHSMs",
14+
"properties": {
15+
"mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
16+
"location": "westus",
17+
"deletionDate": "2022-02-01T00:00:59Z",
18+
"scheduledPurgeDate": "2022-02-01T00:00:59Z",
19+
"purgeProtectionEnabled": true,
20+
"tags": {
21+
"Dept": "hsm",
22+
"Environment": "production"
23+
}
24+
}
25+
},
26+
{
27+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm2",
28+
"name": "vault-agile-drawer-6404",
29+
"type": "Microsoft.KeyVault/deletedManagedHSMs",
30+
"properties": {
31+
"mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2",
32+
"location": "westus",
33+
"deletionDate": "2022-02-01T00:00:59Z",
34+
"scheduledPurgeDate": "2022-02-01T00:00:59Z",
35+
"purgeProtectionEnabled": true,
36+
"tags": {
37+
"Dept": "hsm",
38+
"Environment": "production"
39+
}
40+
}
41+
}
42+
],
43+
"nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedManagedHSMs?api-version=2022-02-01-preview&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
44+
}
45+
}
46+
}
47+
}

‎specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2022-02-01-preview/examples/DeletedManagedHsm_Purge.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"parameters": {
3+
"name": "hsm1",
4+
"location": "westus",
5+
"subscriptionId": "00000000-0000-0000-0000-000000000000",
6+
"api-version": "2022-02-01-preview"
7+
},
8+
"responses": {
9+
"202": {
10+
"headers": {
11+
"Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2022-02-01-preview&kv-operation=abJjb2RkIjoiAGVsZXRlTWFuYWdlZEhzbUFzeW5jYm9"
12+
}
13+
}
14+
}
15+
}

‎specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2022-02-01-preview/examples/ManagedHsm_CreateOrUpdate.json‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
{
2+
"parameters": {
3+
"resourceGroupName": "hsm-group",
4+
"name": "hsm1",
5+
"subscriptionId": "00000000-0000-0000-0000-000000000000",
6+
"api-version": "2022-02-01-preview",
7+
"parameters": {
8+
"properties": {
9+
"tenantId": "00000000-0000-0000-0000-000000000000",
10+
"initialAdminObjectIds": [
11+
"00000000-0000-0000-0000-000000000000"
12+
],
13+
"enableSoftDelete": true,
14+
"softDeleteRetentionInDays": 90,
15+
"enablePurgeProtection": false
16+
},
17+
"location": "westus",
18+
"sku": {
19+
"family": "B",
20+
"name": "Standard_B1"
21+
},
22+
"tags": {
23+
"Dept": "hsm",
24+
"Environment": "dogfood"
25+
}
26+
}
27+
},
28+
"responses": {
29+
"202": {
30+
"headers": {
31+
"Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2022-02-01-preview&kv-operation=abJjb2RkIjoiAGVsZXRlTWFuYWdlZEhzbUFzeW5jYm9"
32+
},
33+
"body": {
34+
"properties": {
35+
"tenantId": "00000000-0000-0000-0000-000000000000",
36+
"initialAdminObjectIds": [
37+
"00000000-0000-0000-0000-000000000000"
38+
],
39+
"enableSoftDelete": true,
40+
"softDeleteRetentionInDays": 90,
41+
"enablePurgeProtection": false,
42+
"hsmUri": null,
43+
"provisioningState": "Provisioning",
44+
"statusMessage": "Allocating hardware"
45+
},
46+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
47+
"name": "hsm1",
48+
"type": "Microsoft.KeyVault/managedHSMs",
49+
"location": "westus",
50+
"sku": {
51+
"family": "B",
52+
"name": "Standard_B1"
53+
},
54+
"tags": {
55+
"Dept": "hsm",
56+
"Environment": "dogfood"
57+
}
58+
}
59+
},
60+
"200": {
61+
"body": {
62+
"properties": {
63+
"tenantId": "00000000-0000-0000-0000-000000000000",
64+
"initialAdminObjectIds": [
65+
"00000000-0000-0000-0000-000000000000"
66+
],
67+
"enableSoftDelete": true,
68+
"softDeleteRetentionInDays": 90,
69+
"enablePurgeProtection": false,
70+
"hsmUri": "https://westus.hsm1.managedhsm.azure.net",
71+
"provisioningState": "Succeeded",
72+
"statusMessage": "ManagedHsm is functional."
73+
},
74+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
75+
"name": "hsm1",
76+
"type": "Microsoft.KeyVault/managedHSMs",
77+
"location": "westus",
78+
"sku": {
79+
"family": "B",
80+
"name": "Standard_B1"
81+
},
82+
"tags": {
83+
"Dept": "hsm",
84+
"Environment": "dogfood"
85+
}
86+
}
87+
}
88+
}
89+
}

‎specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2022-02-01-preview/examples/ManagedHsm_Delete.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"parameters": {
3+
"resourceGroupName": "hsm-group",
4+
"name": "hsm1",
5+
"subscriptionId": "00000000-0000-0000-0000-000000000000",
6+
"api-version": "2022-02-01-preview"
7+
},
8+
"responses": {
9+
"200": {},
10+
"202": {
11+
"headers": {
12+
"Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2022-02-01-preview&kv-operation=abJjb2RkIjoiAGVsZXRlTWFuYWdlZEhzbUFzeW5jYm9"
13+
}
14+
},
15+
"204": {}
16+
}
17+
}

‎specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2022-02-01-preview/examples/ManagedHsm_Get.json‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"parameters": {
3+
"resourceGroupName": "hsm-group",
4+
"name": "hsm1",
5+
"subscriptionId": "00000000-0000-0000-0000-000000000000",
6+
"api-version": "2022-02-01-preview"
7+
},
8+
"responses": {
9+
"200": {
10+
"body": {
11+
"properties": {
12+
"tenantId": "00000000-0000-0000-0000-000000000000",
13+
"initialAdminObjectIds": [
14+
"00000000-0000-0000-0000-000000000000"
15+
],
16+
"enableSoftDelete": true,
17+
"softDeleteRetentionInDays": 90,
18+
"enablePurgeProtection": false,
19+
"hsmUri": "https://westus.hsm1.managedhsm.azure.net",
20+
"provisioningState": "Succeeded",
21+
"statusMessage": "ManagedHsm is functional."
22+
},
23+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
24+
"name": "hsm1",
25+
"type": "Microsoft.KeyVault/managedHSMs",
26+
"location": "westus",
27+
"sku": {
28+
"family": "B",
29+
"name": "Standard_B1"
30+
},
31+
"tags": {
32+
"Dept": "hsm",
33+
"Environment": "dogfood"
34+
}
35+
}
36+
},
37+
"204": {}
38+
}
39+
}

0 commit comments

Comments
 (0)