forked from Azure/azure-rest-api-specs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
37 changed files
with
503 additions
and
30 deletions.
There are no files selected for viewing
24 changes: 24 additions & 0 deletions
24
...keyvault/Security.KeyVault.Administration/examples/7.5/DeleteRoleAssignments-example.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,24 @@ | ||
| { | ||
| "operationId": "RoleAssignments_Delete", | ||
| "title": "Delete a role assignment", | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "scope": "keys", | ||
| "roleAssignmentName": "roleAssignmentName", | ||
| "api-version": "7.5" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "properties": { | ||
| "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId", | ||
| "principalId": "principalId", | ||
| "scope": "/keys" | ||
| }, | ||
| "id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId", | ||
| "type": "Microsoft.Authorization/roleAssignments", | ||
| "name": "roleAssignmentId" | ||
| } | ||
| } | ||
| } | ||
| } |
34 changes: 34 additions & 0 deletions
34
.../keyvault/Security.KeyVault.Administration/examples/7.5/DeleteRoleDefinition-example.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,34 @@ | ||
| { | ||
| "operationId": "RoleDefinitions_Delete", | ||
| "title": "Delete a custom role definition", | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "scope": "/", | ||
| "roleDefinitionName": "00000000-0000-0000-0000-000000000000", | ||
| "api-version": "7.5" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "properties": { | ||
| "roleName": "My custom role", | ||
| "type": "CustomRole", | ||
| "description": "Role description", | ||
| "assignableScopes": [ | ||
| "/" | ||
| ], | ||
| "permissions": [ | ||
| { | ||
| "dataActions": [ | ||
| "Microsoft.KeyVault/managedHsm/keys/sign/action" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "id": "Microsoft.KeyVault/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000", | ||
| "type": "Microsoft.Authorization/roleDefinitions", | ||
| "name": "00000000-0000-0000-0000-000000000000" | ||
| } | ||
| } | ||
| } | ||
| } |
28 changes: 28 additions & 0 deletions
28
specification/keyvault/Security.KeyVault.Administration/examples/7.5/FullBackup-example.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 @@ | ||
| { | ||
| "operationId": "FullBackup", | ||
| "title": "Create a full backup", | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "azureStorageBlobContainerUri": { | ||
| "storageResourceUri": "https://myaccount.blob.core.windows.net/sascontainer/sasContainer", | ||
| "token": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED" | ||
| }, | ||
| "api-version": "7.5" | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Retry-After": 5, | ||
| "Azure-AsyncOperation": "https://myvault.vault.azure.net/backup/45aacd568ab049a2803861e8dd3ae21f/pending" | ||
| }, | ||
| "body": { | ||
| "status": "InProgress", | ||
| "statusDetails": "Full backup is in progress", | ||
| "azureStorageBlobContainerUri": "https://myaccount.blob.core.windows.net/sascontainer/fullbackup-pool-61e8dd3ae21f-1579243113", | ||
| "jobId": "45aacd568ab049a2803861e8dd3ae21f", | ||
| "startTime": 1490790000, | ||
| "endTime": 0 | ||
| } | ||
| } | ||
| } | ||
| } |
21 changes: 21 additions & 0 deletions
21
...on/keyvault/Security.KeyVault.Administration/examples/7.5/FullBackup-pending-example.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,21 @@ | ||
| { | ||
| "operationId": "FullBackupStatus", | ||
| "title": "Get the status of a full backup operation", | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "jobId": "45aacd568ab049a2803861e8dd3ae21f", | ||
| "api-version": "7.5" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "status": "InProgress", | ||
| "statusDetails": "Full backup is in progress", | ||
| "azureStorageBlobContainerUri": "https://myaccount.blob.core.windows.net/sascontainer/.fullbackup-pool-61e8dd3ae21f-1579243113", | ||
| "jobId": "45aacd568ab049a2803861e8dd3ae21f", | ||
| "startTime": 1490790000, | ||
| "endTime": 0 | ||
| } | ||
| } | ||
| } | ||
| } |
30 changes: 30 additions & 0 deletions
30
...ification/keyvault/Security.KeyVault.Administration/examples/7.5/FullRestore-example.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,30 @@ | ||
| { | ||
| "operationId": "FullRestoreOperation", | ||
| "title": "Restore all key materials from a previously stored Azure Blob Storage backup", | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myhsm.managedhsm.azure.net", | ||
| "restoreBlobDetails": { | ||
| "sasTokenParameters": { | ||
| "storageResourceUri": "https://myaccount.blob.core.windows.net/sascontainer/sasContainer", | ||
| "token": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=REDACTED" | ||
| }, | ||
| "folderToRestore": "mhsm-mypool-20200303062926785" | ||
| }, | ||
| "api-version": "7.5" | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Retry-After": 5, | ||
| "Azure-AsyncOperation": "https://myvault.vault.azure.net/restore/45aacd568ab049a2803861e8dd3ae21f/pending" | ||
| }, | ||
| "body": { | ||
| "status": "InProgress", | ||
| "statusDetails": "Full restore is in progress", | ||
| "jobId": "45aacd568ab049a2803861e8dd3ae21f", | ||
| "startTime": 1490790000, | ||
| "endTime": 0 | ||
| } | ||
| } | ||
| } | ||
| } |
24 changes: 24 additions & 0 deletions
24
...on/keyvault/Security.KeyVault.Administration/examples/7.5/GetRoleAssignments-example.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,24 @@ | ||
| { | ||
| "operationId": "RoleAssignments_Get", | ||
| "title": "Get the specified role assignment", | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "scope": "keys", | ||
| "roleAssignmentName": "roleAssignmentName", | ||
| "api-version": "7.5" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "properties": { | ||
| "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId", | ||
| "principalId": "principalId", | ||
| "scope": "/keys" | ||
| }, | ||
| "id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId", | ||
| "type": "Microsoft.Authorization/roleAssignments", | ||
| "name": "roleAssignmentId" | ||
| } | ||
| } | ||
| } | ||
| } |
34 changes: 34 additions & 0 deletions
34
...ion/keyvault/Security.KeyVault.Administration/examples/7.5/GetRoleDefinition-example.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,34 @@ | ||
| { | ||
| "operationId": "RoleDefinitions_Get", | ||
| "title": "Get the specified role definition", | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "scope": "/", | ||
| "api-version": "7.5", | ||
| "roleDefinitionName": "00000000-0000-0000-0000-000000000000" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "properties": { | ||
| "roleName": "My custom role", | ||
| "type": "CustomRole", | ||
| "description": "Role description", | ||
| "assignableScopes": [ | ||
| "/" | ||
| ], | ||
| "permissions": [ | ||
| { | ||
| "dataActions": [ | ||
| "Microsoft.KeyVault/managedHsm/keys/sign/action" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "id": "Microsoft.KeyVault/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000", | ||
| "type": "Microsoft.Authorization/roleDefinitions", | ||
| "name": "00000000-0000-0000-0000-000000000000" | ||
| } | ||
| } | ||
| } | ||
| } |
27 changes: 27 additions & 0 deletions
27
...n/keyvault/Security.KeyVault.Administration/examples/7.5/ListRoleAssignments-example.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,27 @@ | ||
| { | ||
| "operationId": "RoleAssignments_ListForScope", | ||
| "title": "Get role assignments for a scope", | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "scope": "keys", | ||
| "api-version": "7.5" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "value": [ | ||
| { | ||
| "properties": { | ||
| "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId", | ||
| "principalId": "principalId", | ||
| "scope": "/keys" | ||
| }, | ||
| "id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId", | ||
| "type": "Microsoft.Authorization/roleAssignments", | ||
| "name": "roleAssignmentId" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } |
38 changes: 38 additions & 0 deletions
38
...n/keyvault/Security.KeyVault.Administration/examples/7.5/ListRoleDefinitions-example.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,38 @@ | ||
| { | ||
| "operationId": "RoleDefinitions_List", | ||
| "title": "Get all role definitions that are applicable at scope and above", | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "scope": "keys", | ||
| "api-version": "7.5" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "value": [ | ||
| { | ||
| "properties": { | ||
| "roleName": "Role name", | ||
| "type": "roletype", | ||
| "description": "Role description", | ||
| "assignableScopes": [ | ||
| "/keys" | ||
| ], | ||
| "permissions": [ | ||
| { | ||
| "actions": [ | ||
| "get" | ||
| ], | ||
| "notActions": [] | ||
| } | ||
| ] | ||
| }, | ||
| "id": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId", | ||
| "type": "Microsoft.Authorization/roleDefinitions", | ||
| "name": "roleDefinitionId" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } |
21 changes: 21 additions & 0 deletions
21
...fication/keyvault/Security.KeyVault.Administration/examples/7.5/ListSettings-example.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,21 @@ | ||
| { | ||
| "operationId": "GetSettings", | ||
| "title": "List account settings", | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "api-version": "7.5" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "settings": [ | ||
| { | ||
| "name": "AllowKeyManagementOperationsThroughARM", | ||
| "value": "true", | ||
| "type": "boolean" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } |
30 changes: 30 additions & 0 deletions
30
...on/keyvault/Security.KeyVault.Administration/examples/7.5/PutRoleAssignments-example.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,30 @@ | ||
| { | ||
| "operationId": "RoleAssignments_Create", | ||
| "title": "Create a role assignment", | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "scope": "keys", | ||
| "roleAssignmentName": "roleAssignmentName", | ||
| "parameters": { | ||
| "properties": { | ||
| "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId", | ||
| "principalId": "principalId" | ||
| } | ||
| }, | ||
| "api-version": "7.5" | ||
| }, | ||
| "responses": { | ||
| "201": { | ||
| "body": { | ||
| "properties": { | ||
| "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId", | ||
| "principalId": "principalId", | ||
| "scope": "/keys" | ||
| }, | ||
| "id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId", | ||
| "type": "Microsoft.Authorization/roleAssignments", | ||
| "name": "roleAssignmentId" | ||
| } | ||
| } | ||
| } | ||
| } |
48 changes: 48 additions & 0 deletions
48
...ion/keyvault/Security.KeyVault.Administration/examples/7.5/PutRoleDefinition-example.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,48 @@ | ||
| { | ||
| "operationId": "RoleDefinitions_CreateOrUpdate", | ||
| "title": "Create or update a custom role definition", | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "scope": "keys", | ||
| "roleDefinitionName": "00000000-0000-0000-0000-000000000000", | ||
| "parameters": { | ||
| "properties": { | ||
| "roleName": "My custom role", | ||
| "type": "CustomRole", | ||
| "description": "Role description", | ||
| "permissions": [ | ||
| { | ||
| "dataActions": [ | ||
| "Microsoft.KeyVault/managedHsm/keys/sign/action" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "api-version": "7.5" | ||
| }, | ||
| "responses": { | ||
| "201": { | ||
| "body": { | ||
| "properties": { | ||
| "roleName": "My custom role", | ||
| "type": "CustomRole", | ||
| "description": "Role description", | ||
| "assignableScopes": [ | ||
| "/" | ||
| ], | ||
| "permissions": [ | ||
| { | ||
| "dataActions": [ | ||
| "Microsoft.KeyVault/managedHsm/keys/sign/action" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "id": "Microsoft.KeyVault/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000", | ||
| "type": "Microsoft.Authorization/roleDefinitions", | ||
| "name": "00000000-0000-0000-0000-000000000000" | ||
| } | ||
| } | ||
| } | ||
| } |
20 changes: 20 additions & 0 deletions
20
...ation/keyvault/Security.KeyVault.Administration/examples/7.5/Restore-pending-example.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,20 @@ | ||
| { | ||
| "operationId": "RestoreStatus", | ||
| "title": "Get the status of restore operation", | ||
| "parameters": { | ||
| "vaultBaseUrl": "https://myvault.vault.azure.net/", | ||
| "jobId": "45aacd568ab049a2803861e8dd3ae21f", | ||
| "api-version": "7.5" | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "status": "InProgress", | ||
| "statusDetails": "Full restore is in progress", | ||
| "jobId": "45aacd568ab049a2803861e8dd3ae21f", | ||
| "startTime": 1490790000, | ||
| "endTime": 0 | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.