From 421dde4c867e3ad72e3fd90c63b8b428a9ba9137 Mon Sep 17 00:00:00 2001 From: Eduardo Coronado Date: Wed, 14 Oct 2020 18:49:47 -0700 Subject: [PATCH 01/11] Add Workspace Keys and Workspace CMK to workspace properties --- specification/synapse/common/v1/types.json | 8 + .../examples/CreateOrUpdateKey.json | 34 ++ .../examples/DeleteKey.json | 25 ++ .../2019-06-01-preview/examples/GetKey.json | 23 ++ .../examples/ListKeysInWorkspace.json | 37 +++ .../preview/2019-06-01-preview/keys.json | 306 ++++++++++++++++++ .../preview/2019-06-01-preview/workspace.json | 53 +++ 7 files changed, 486 insertions(+) create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json diff --git a/specification/synapse/common/v1/types.json b/specification/synapse/common/v1/types.json index 6aaf16bf83f5..ed597065be18 100644 --- a/specification/synapse/common/v1/types.json +++ b/specification/synapse/common/v1/types.json @@ -110,6 +110,14 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" + }, + "KeyNameParameter":{ + "name": "keyName", + "in": "path", + "description": "The name of a workspace key.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" } } } diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json new file mode 100644 index 000000000000..0f51ba3361ba --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "keyName": "somekey", + "api-version": "2019-06-01-preview", + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/somesecret" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", + "type": "Microsoft.Synapse/workspaces/keys", + "name": "somekey", + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/somesecret" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } + } \ No newline at end of file diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json new file mode 100644 index 000000000000..1a4c40e164fc --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "keyName": "somekey", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", + "type": "Microsoft.Synapse/workspaces/keys", + "name": "somekey", + "location": "West US 2", + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/key1" + } + } + }, + "202": {}, + "204": {} + } + } \ No newline at end of file diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json new file mode 100644 index 000000000000..90210f2219ef --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "keyName": "somekey", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", + "name": "somekey", + "type": "Microsoft.Synapse/workspaces/keys", + "location": "Japan East", + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/key1" + } + } + } + } + } \ No newline at end of file diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json new file mode 100644 index 000000000000..daf3ba59a62e --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/key1", + "name": "key1", + "type": "Microsoft.Synapse/workspaces/keys", + "location": "Japan East", + "properties": { + "keyVaultUrl": "https://vault.azure.net/keys/somesecret1", + "isActiveCMK": false + } + }, + { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/key2", + "name": "key2", + "type": "Microsoft.Synapse/workspaces/keys", + "location": "Japan East", + "properties": { + "keyVaultUrl": "https://vault.azure.net/keys/somesecret2", + "isActiveCMK": true + } + } + ] + } + } + } + } + \ No newline at end of file diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json new file mode 100644 index 000000000000..978b8f7fe4fd --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json @@ -0,0 +1,306 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-06-01-preview", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys": { + "get": { + "operationId": "Keys_ListByWorkspace", + "description": "Returns a list of keys in a workspace", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/KeyInfoListResult" + }, + "description": "The list of workspace keys." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List keys in workspace": { + "$ref": "./examples/ListKeysInWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName}": { + "get": { + "operationId": "Keys_Get", + "description": "Gets a workspace key", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/keyNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/Keys" + }, + "description": "Workspace Key details" + }, + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while trying to get details for Workspace Keys." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a workspace key": { + "$ref": "./examples/GetKey.json" + } + } + }, + "put": { + "operationId": "Keys_CreateOrUpdate", + "description": "Creates or updates a workspace key", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/keyNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/Key" + }, + "description": "Workspace Key resource details" + }, + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 400 BadRequest - Invalid request to create a Workspace Key.\n\n * 500 InternalServerError- Some error occurred while creating Workspace Key." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create or update a workspace key": { + "$ref": "./examples/CreateOrUpdateKey.json" + } + } + }, + "delete": { + "operationId": "Keys_Delete", + "description": "Deletes a workspace key", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/keyNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "Keys resource not found." + }, + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while deleting Workspace Key." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Delete a workspace key": { + "$ref": "./examples/DeleteKey.json" + } + } + } + } + }, + "definitions": { + "ErrorDetail": { + "description": "Error details", + "type": "object", + "properties": { + "message": { + "description": "Error message", + "type": "string" + }, + "code": { + "description": "Error code", + "type": "string" + }, + "target": { + "description": "Error target", + "type": "string" + } + } + }, + "ErrorContract": { + "title": "Error details.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + } + }, + "KeyInfoListResult": { + "description": "List of keys", + "type": "object", + "properties": { + "nextLink": { + "description": "Link to the next page of results", + "type": "string" + }, + "value": { + "description": "List of keys", + "type": "array", + "items": { + "$ref": "#/definitions/Key" + } + } + } + }, + "Key": { + "description": "A workspace key", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Keys resource properties", + "$ref": "#/definitions/KeyProperties", + "x-ms-client-flatten": true + } + } + }, + "KeyProperties": { + "description": "Key properties", + "type": "object", + "properties": { + "isActiveCMK": { + "type": "bool", + "description": "Used to activate the workspace after a customer managed key is provided." + }, + "keyVaultUrl":{ + "type": "string", + "description": "The Key Vault Url of the workspace key." + } + } + } + }, + "parameters": { + "keyNameParameter": { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace key", + "x-ms-parameter-location": "method" + } + } + } + \ No newline at end of file diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json index 88b3013bd28e..3aac7e16eb64 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json @@ -668,6 +668,50 @@ } } }, + "EncryptionDetails":{ + "description": "Details of the encryption associated with the workspace", + "type": "object", + "properties": { + "doubleEncryptionEnabled": { + "description": "Double Encryption enabled", + "type": "bool", + "readOnly": true + }, + "cmk": { + "description": "Customer Managed Key Details", + "$ref": "#/definitions/CustomerManagedKeyDetails" + } + } + }, + "CustomerManagedKeyDetails":{ + "description": "Details of the customer managed key associated with the workspace", + "type": "object", + "properties": { + "status": { + "description": "The customer managed key status on the workspace", + "type": "string", + "readOnly": true + }, + "key":{ + "description": "The key object of the workspace", + "$ref": "#/definitions/WorkspaceKeyDetails" + } + } + }, + "WorkspaceKeyDetails":{ + "description": "Details of the customer managed key associated with the workspace", + "type": "object", + "properties": { + "name":{ + "description": "Workspace Key sub-resource name", + "type": "string" + }, + "keyVaultUrl": { + "description": "Workspace Key sub-resource key vault url", + "type": "string" + } + } + }, "ManagedIdentity": { "description": "The workspace managed identity", "type": "object", @@ -790,6 +834,15 @@ "$ref": "./privateEndpointConnections.json#/definitions/PrivateEndpointConnection" } }, + "encryption": { + "description": "The encryption details of the workspace", + "$ref": "#/definitions/EncryptionDetails" + }, + "workspaceUID":{ + "description": "The workspace unique identifier", + "type": "string", + "readOnly": true + }, "extraProperties": { "description": "Workspace level configs and feature flags", "additionalProperties": { From 8ea240c2d4a487fb55094145693ab50845438265 Mon Sep 17 00:00:00 2001 From: Eduardo Coronado Date: Wed, 14 Oct 2020 21:36:51 -0700 Subject: [PATCH 02/11] Fix boolean --- .../Microsoft.Synapse/preview/2019-06-01-preview/keys.json | 2 +- .../Microsoft.Synapse/preview/2019-06-01-preview/workspace.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json index 978b8f7fe4fd..1625871413db 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json @@ -282,7 +282,7 @@ "type": "object", "properties": { "isActiveCMK": { - "type": "bool", + "type": "boolean", "description": "Used to activate the workspace after a customer managed key is provided." }, "keyVaultUrl":{ diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json index 3aac7e16eb64..c347678b4474 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json @@ -674,7 +674,7 @@ "properties": { "doubleEncryptionEnabled": { "description": "Double Encryption enabled", - "type": "bool", + "type": "boolean", "readOnly": true }, "cmk": { From a68e7c62d9540fd909b742a8fe50441e7255227f Mon Sep 17 00:00:00 2001 From: Eduardo Coronado Date: Wed, 14 Oct 2020 21:39:39 -0700 Subject: [PATCH 03/11] Update readme.md --- specification/synapse/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/synapse/resource-manager/readme.md b/specification/synapse/resource-manager/readme.md index 68da597e5e27..59f3f31e6779 100644 --- a/specification/synapse/resource-manager/readme.md +++ b/specification/synapse/resource-manager/readme.md @@ -46,6 +46,7 @@ input-file: - Microsoft.Synapse/preview/2019-06-01-preview/privateLinkResources.json - Microsoft.Synapse/preview/2019-06-01-preview/privateEndpointConnections.json - Microsoft.Synapse/preview/2019-06-01-preview/privatelinkhub.json +- Microsoft.Synapse/preview/2019-06-01-preview/keys.json ``` ### Tag: package-sqlGen3-2020-04-01-preview From f3bf8738c5b55548978d3eb39e5957cab4c21ae6 Mon Sep 17 00:00:00 2001 From: Eduardo Coronado Date: Wed, 14 Oct 2020 22:51:00 -0700 Subject: [PATCH 04/11] Update keys.json --- .../Microsoft.Synapse/preview/2019-06-01-preview/keys.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json index 1625871413db..c62174c97864 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json @@ -93,7 +93,7 @@ "responses": { "200": { "schema": { - "$ref": "#/definitions/Keys" + "$ref": "#/definitions/Key" }, "description": "Workspace Key details" }, From e6cf1ad70a6aac466a83363cf30ad6d5be2f0c41 Mon Sep 17 00:00:00 2001 From: Eduardo Coronado Date: Thu, 15 Oct 2020 00:29:23 -0700 Subject: [PATCH 05/11] Fix validations --- .../examples/CreateOrUpdateKey.json | 2 +- .../examples/DeleteKey.json | 1 - .../examples/UpdateKey.json | 33 +++++++++ .../preview/2019-06-01-preview/keys.json | 71 ++++++++++++++++++- 4 files changed, 104 insertions(+), 3 deletions(-) create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json index 0f51ba3361ba..eba8e98aad4f 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json @@ -5,7 +5,7 @@ "workspaceName": "ExampleWorkspace", "keyName": "somekey", "api-version": "2019-06-01-preview", - "properties": { + "keyProperties": { "isActiveCMK": true, "keyVaultUrl": "https://vault.azure.net/keys/somesecret" } diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json index 1a4c40e164fc..a2a8fe9311ca 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json @@ -19,7 +19,6 @@ } } }, - "202": {}, "204": {} } } \ No newline at end of file diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json new file mode 100644 index 000000000000..f9d3f81d82da --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "keyName": "somekey", + "api-version": "2019-06-01-preview", + "keyProperties": { + "location": "West US 2", + "tags": {}, + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/somesecret" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspaces/keys/somekey", + "type": "Microsoft.Synapse/workspaces/keys", + "name": "somekey", + "location": "West US 2", + "tags": {}, + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/somesecret" + } + } + } + } + } + \ No newline at end of file diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json index c62174c97864..0c4ac07fc3ca 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json @@ -136,6 +136,15 @@ }, { "$ref": "#/parameters/keyNameParameter" + }, + { + "schema": { + "$ref": "#/definitions/KeyProperties" + }, + "in": "body", + "name": "keyProperties", + "required": true, + "description": "Key put request properties" } ], "responses": { @@ -190,7 +199,10 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK", + "schema": { + "$ref": "#/definitions/Key" + } }, "204": { "description": "Keys resource not found." @@ -212,6 +224,63 @@ } } } + }, + "patch": { + "operationId": "Keys_Patch", + "description": "Patch a workspace key", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/keyNameParameter" + }, + { + "schema": { + "$ref": "#/definitions/KeyProperties" + }, + "in": "body", + "name": "keyProperties", + "required": true, + "description": "Key patch request properties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Key" + } + }, + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while deleting Workspace Key." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Patch a workspace key": { + "$ref": "./examples/UpdateKey.json" + } + } } }, "definitions": { From a7dae5c029c24c203594e660d0f9ce8666ef5b3e Mon Sep 17 00:00:00 2001 From: Eduardo Coronado Date: Thu, 15 Oct 2020 00:59:28 -0700 Subject: [PATCH 06/11] Update keys.json --- .../preview/2019-06-01-preview/keys.json | 106 +++++++++--------- 1 file changed, 53 insertions(+), 53 deletions(-) diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json index 0c4ac07fc3ca..a891119d5b45 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json @@ -223,62 +223,62 @@ "$ref": "./examples/DeleteKey.json" } } - } - }, - "patch": { - "operationId": "Keys_Patch", - "description": "Patch a workspace key", - "tags": [ - "Keys" - ], - "deprecated": false, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./workspace.json#/parameters/workspaceNameParameter" - }, - { - "$ref": "#/parameters/keyNameParameter" - }, - { - "schema": { - "$ref": "#/definitions/KeyProperties" + }, + "patch": { + "operationId": "Keys_Patch", + "description": "Patch a workspace key", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, - "in": "body", - "name": "keyProperties", - "required": true, - "description": "Key patch request properties" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Key" + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/keyNameParameter" + }, + { + "schema": { + "$ref": "#/definitions/KeyProperties" + }, + "in": "body", + "name": "keyProperties", + "required": true, + "description": "Key patch request properties" } - }, - "default": { - "schema": { - "$ref": "#/definitions/ErrorContract" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Key" + } }, - "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while deleting Workspace Key." - } - }, - "consumes": [], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Patch a workspace key": { - "$ref": "./examples/UpdateKey.json" + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while deleting Workspace Key." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Patch a workspace key": { + "$ref": "./examples/UpdateKey.json" + } } } } From b326f9526f27c1dd94ccf860cedbef37b5257a6f Mon Sep 17 00:00:00 2001 From: Eduardo Coronado Date: Thu, 15 Oct 2020 01:48:28 -0700 Subject: [PATCH 07/11] Fix examples --- .../examples/CreateOrUpdateKey.json | 14 ++++++++++++-- .../2019-06-01-preview/examples/GetKey.json | 3 ++- .../examples/ListKeysInWorkspace.json | 6 ++++-- .../preview/2019-06-01-preview/keys.json | 6 ++++++ 4 files changed, 24 insertions(+), 5 deletions(-) diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json index eba8e98aad4f..cc5498d47a15 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json @@ -6,8 +6,14 @@ "keyName": "somekey", "api-version": "2019-06-01-preview", "keyProperties": { - "isActiveCMK": true, - "keyVaultUrl": "https://vault.azure.net/keys/somesecret" + "properties":{ + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/somesecret" + }, + "location": "East US", + "tags": { + "key": "value" + } } }, "responses": { @@ -15,10 +21,14 @@ "body": { "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", "type": "Microsoft.Synapse/workspaces/keys", + "location": "East US", "name": "somekey", "properties": { "isActiveCMK": true, "keyVaultUrl": "https://vault.azure.net/keys/somesecret" + }, + "tags": { + "key": "value" } } }, diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json index 90210f2219ef..d8e411b4a5ba 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json @@ -16,7 +16,8 @@ "properties": { "isActiveCMK": true, "keyVaultUrl": "https://vault.azure.net/keys/key1" - } + }, + "tags":{} } } } diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json index daf3ba59a62e..d44b4e46b27a 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json @@ -17,7 +17,8 @@ "properties": { "keyVaultUrl": "https://vault.azure.net/keys/somesecret1", "isActiveCMK": false - } + }, + "tags":{} }, { "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/key2", @@ -27,7 +28,8 @@ "properties": { "keyVaultUrl": "https://vault.azure.net/keys/somesecret2", "isActiveCMK": true - } + }, + "tags":{} } ] } diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json index a891119d5b45..77fc1dd92504 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json @@ -49,6 +49,12 @@ "$ref": "#/definitions/KeyInfoListResult" }, "description": "The list of workspace keys." + }, + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 400 BadRequest - Invalid request to create a Workspace Key.\n\n * 500 InternalServerError- Some error occurred while creating Workspace Key." } }, "consumes": [], From ed00344f3fb81acd9c5b9046d95c4c6d360a7b2e Mon Sep 17 00:00:00 2001 From: Eduardo Coronado Date: Thu, 15 Oct 2020 14:37:55 -0700 Subject: [PATCH 08/11] Update keys.json --- .../Microsoft.Synapse/preview/2019-06-01-preview/keys.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json index 77fc1dd92504..ba1912cb492e 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json @@ -145,7 +145,7 @@ }, { "schema": { - "$ref": "#/definitions/KeyProperties" + "$ref": "#/definitions/Key" }, "in": "body", "name": "keyProperties", @@ -255,7 +255,7 @@ }, { "schema": { - "$ref": "#/definitions/KeyProperties" + "$ref": "#/definitions/Key" }, "in": "body", "name": "keyProperties", From 74f0e4710564a1bd5d44d2d75ad7a30d03938490 Mon Sep 17 00:00:00 2001 From: Eduardo Coronado Date: Thu, 15 Oct 2020 17:47:24 -0700 Subject: [PATCH 09/11] Add property key --- .../2019-06-01-preview/examples/UpdateKey.json | 7 +------ .../preview/2019-06-01-preview/keys.json | 15 ++++++++++++++- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json index f9d3f81d82da..fccb84d7ea8d 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json @@ -6,12 +6,7 @@ "keyName": "somekey", "api-version": "2019-06-01-preview", "keyProperties": { - "location": "West US 2", - "tags": {}, - "properties": { - "isActiveCMK": true, - "keyVaultUrl": "https://vault.azure.net/keys/somesecret" - } + "tags": {} } }, "responses": { diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json index ba1912cb492e..697c3edb0909 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json @@ -255,7 +255,7 @@ }, { "schema": { - "$ref": "#/definitions/Key" + "$ref": "#/definitions/KeyPatchInfo" }, "in": "body", "name": "keyProperties", @@ -352,6 +352,19 @@ } } }, + "KeyPatchInfo": { + "description": "KeyInfo patch details", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags", + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + } + }, "KeyProperties": { "description": "Key properties", "type": "object", From 7de2dcf6e9a7d29c7621cb3795ccebd7f58940a0 Mon Sep 17 00:00:00 2001 From: Eduardo Coronado Date: Thu, 15 Oct 2020 20:55:23 -0700 Subject: [PATCH 10/11] formatting fixed --- specification/synapse/common/v1/types.json | 2 +- .../examples/CreateOrUpdateKey.json | 66 +- .../examples/DeleteKey.json | 44 +- .../2019-06-01-preview/examples/GetKey.json | 42 +- .../examples/ListKeysInWorkspace.json | 67 +- .../examples/UpdateKey.json | 45 +- .../preview/2019-06-01-preview/keys.json | 703 +++++++++--------- .../preview/2019-06-01-preview/workspace.json | 12 +- 8 files changed, 489 insertions(+), 492 deletions(-) diff --git a/specification/synapse/common/v1/types.json b/specification/synapse/common/v1/types.json index ed597065be18..239f5bab4788 100644 --- a/specification/synapse/common/v1/types.json +++ b/specification/synapse/common/v1/types.json @@ -111,7 +111,7 @@ "type": "string", "x-ms-parameter-location": "method" }, - "KeyNameParameter":{ + "KeyNameParameter": { "name": "keyName", "in": "path", "description": "The name of a workspace key.", diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json index cc5498d47a15..56fe337740d9 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json @@ -1,44 +1,44 @@ { - "parameters": { - "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", - "resourceGroupName": "ExampleResourceGroup", - "workspaceName": "ExampleWorkspace", - "keyName": "somekey", - "api-version": "2019-06-01-preview", - "keyProperties": { - "properties":{ + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "keyName": "somekey", + "api-version": "2019-06-01-preview", + "keyProperties": { + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/somesecret" + }, + "location": "East US", + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", + "type": "Microsoft.Synapse/workspaces/keys", + "location": "East US", + "name": "somekey", + "properties": { "isActiveCMK": true, - "keyVaultUrl": "https://vault.azure.net/keys/somesecret" + "keyVaultUrl": "https://vault.azure.net/keys/somesecret" }, - "location": "East US", "tags": { "key": "value" } } }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", - "type": "Microsoft.Synapse/workspaces/keys", - "location": "East US", - "name": "somekey", - "properties": { - "isActiveCMK": true, - "keyVaultUrl": "https://vault.azure.net/keys/somesecret" - }, - "tags": { - "key": "value" - } - } - }, - "default": { - "body": { - "error": { - "code": "Error code", - "message": "Error message" - } + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" } } } - } \ No newline at end of file + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json index a2a8fe9311ca..3df4a4ae5983 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json @@ -1,24 +1,24 @@ { - "parameters": { - "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", - "resourceGroupName": "ExampleResourceGroup", - "workspaceName": "ExampleWorkspace", - "keyName": "somekey", - "api-version": "2019-06-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", - "type": "Microsoft.Synapse/workspaces/keys", - "name": "somekey", - "location": "West US 2", - "properties": { - "isActiveCMK": true, - "keyVaultUrl": "https://vault.azure.net/keys/key1" - } + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "keyName": "somekey", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", + "type": "Microsoft.Synapse/workspaces/keys", + "name": "somekey", + "location": "West US 2", + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/key1" } - }, - "204": {} - } - } \ No newline at end of file + } + }, + "204": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json index d8e411b4a5ba..d8709cf35530 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json @@ -1,24 +1,24 @@ { - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "ExampleResourceGroup", - "workspaceName": "ExampleWorkspace", - "keyName": "somekey", - "api-version": "2019-06-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", - "name": "somekey", - "type": "Microsoft.Synapse/workspaces/keys", - "location": "Japan East", - "properties": { - "isActiveCMK": true, - "keyVaultUrl": "https://vault.azure.net/keys/key1" - }, - "tags":{} - } + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "keyName": "somekey", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", + "name": "somekey", + "type": "Microsoft.Synapse/workspaces/keys", + "location": "Japan East", + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/key1" + }, + "tags": {} } } - } \ No newline at end of file + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json index d44b4e46b27a..067c1dd748f4 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json @@ -1,39 +1,38 @@ { - "parameters": { - "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", - "resourceGroupName": "ExampleResourceGroup", - "workspaceName": "ExampleWorkspace", - "api-version": "2019-06-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/key1", - "name": "key1", - "type": "Microsoft.Synapse/workspaces/keys", - "location": "Japan East", - "properties": { - "keyVaultUrl": "https://vault.azure.net/keys/somesecret1", - "isActiveCMK": false - }, - "tags":{} + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/key1", + "name": "key1", + "type": "Microsoft.Synapse/workspaces/keys", + "location": "Japan East", + "properties": { + "keyVaultUrl": "https://vault.azure.net/keys/somesecret1", + "isActiveCMK": false }, - { - "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/key2", - "name": "key2", - "type": "Microsoft.Synapse/workspaces/keys", - "location": "Japan East", - "properties": { - "keyVaultUrl": "https://vault.azure.net/keys/somesecret2", - "isActiveCMK": true - }, - "tags":{} - } - ] - } + "tags": {} + }, + { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/key2", + "name": "key2", + "type": "Microsoft.Synapse/workspaces/keys", + "location": "Japan East", + "properties": { + "keyVaultUrl": "https://vault.azure.net/keys/somesecret2", + "isActiveCMK": true + }, + "tags": {} + } + ] } } } - \ No newline at end of file +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json index fccb84d7ea8d..a5b4c5dbfb59 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json @@ -1,28 +1,27 @@ { - "parameters": { - "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", - "resourceGroupName": "ExampleResourceGroup", - "workspaceName": "ExampleWorkspace", - "keyName": "somekey", - "api-version": "2019-06-01-preview", - "keyProperties": { - "tags": {} - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspaces/keys/somekey", - "type": "Microsoft.Synapse/workspaces/keys", - "name": "somekey", - "location": "West US 2", - "tags": {}, - "properties": { - "isActiveCMK": true, - "keyVaultUrl": "https://vault.azure.net/keys/somesecret" - } + "parameters": { + "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", + "resourceGroupName": "ExampleResourceGroup", + "workspaceName": "ExampleWorkspace", + "keyName": "somekey", + "api-version": "2019-06-01-preview", + "keyProperties": { + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspaces/keys/somekey", + "type": "Microsoft.Synapse/workspaces/keys", + "name": "somekey", + "location": "West US 2", + "tags": {}, + "properties": { + "isActiveCMK": true, + "keyVaultUrl": "https://vault.azure.net/keys/somesecret" } } } } - \ No newline at end of file +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json index 697c3edb0909..9523a1bc38a9 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json @@ -1,394 +1,393 @@ { - "swagger": "2.0", - "info": { - "version": "2019-06-01-preview", - "title": "SynapseManagementClient", - "description": "Azure Synapse Analytics APIs" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "securityDefinitions": { - "azure_auth": { - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "type": "oauth2", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow" - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys": { - "get": { - "operationId": "Keys_ListByWorkspace", - "description": "Returns a list of keys in a workspace", - "tags": [ - "Keys" - ], - "deprecated": false, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./workspace.json#/parameters/workspaceNameParameter" - } - ], - "responses": { - "200": { - "schema": { - "$ref": "#/definitions/KeyInfoListResult" - }, - "description": "The list of workspace keys." - }, - "default": { - "schema": { - "$ref": "#/definitions/ErrorContract" - }, - "description": "*** Error Responses: ***\n\n * 400 BadRequest - Invalid request to create a Workspace Key.\n\n * 500 InternalServerError- Some error occurred while creating Workspace Key." - } + "swagger": "2.0", + "info": { + "version": "2019-06-01-preview", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys": { + "get": { + "operationId": "Keys_ListByWorkspace", + "description": "Returns a list of keys in a workspace", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, - "consumes": [], - "produces": [ - "application/json" - ], - "x-ms-pageable": { - "nextLinkName": "nextLink" + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, - "x-ms-examples": { - "List keys in workspace": { - "$ref": "./examples/ListKeysInWorkspace.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName}": { - "get": { - "operationId": "Keys_Get", - "description": "Gets a workspace key", - "tags": [ - "Keys" - ], - "deprecated": false, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./workspace.json#/parameters/workspaceNameParameter" - }, - { - "$ref": "#/parameters/keyNameParameter" - } - ], - "responses": { - "200": { - "schema": { - "$ref": "#/definitions/Key" - }, - "description": "Workspace Key details" - }, - "default": { - "schema": { - "$ref": "#/definitions/ErrorContract" - }, - "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while trying to get details for Workspace Keys." - } + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, - "consumes": [], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Get a workspace key": { - "$ref": "./examples/GetKey.json" - } + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" } - }, - "put": { - "operationId": "Keys_CreateOrUpdate", - "description": "Creates or updates a workspace key", - "tags": [ - "Keys" - ], - "deprecated": false, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./workspace.json#/parameters/workspaceNameParameter" - }, - { - "$ref": "#/parameters/keyNameParameter" - }, - { - "schema": { - "$ref": "#/definitions/Key" - }, - "in": "body", - "name": "keyProperties", - "required": true, - "description": "Key put request properties" - } - ], - "responses": { - "200": { - "schema": { - "$ref": "#/definitions/Key" - }, - "description": "Workspace Key resource details" + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/KeyInfoListResult" }, - "default": { - "schema": { - "$ref": "#/definitions/ErrorContract" - }, - "description": "*** Error Responses: ***\n\n * 400 BadRequest - Invalid request to create a Workspace Key.\n\n * 500 InternalServerError- Some error occurred while creating Workspace Key." - } + "description": "The list of workspace keys." }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Create or update a workspace key": { - "$ref": "./examples/CreateOrUpdateKey.json" - } - } - }, - "delete": { - "operationId": "Keys_Delete", - "description": "Deletes a workspace key", - "tags": [ - "Keys" - ], - "deprecated": false, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./workspace.json#/parameters/workspaceNameParameter" + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" }, - { - "$ref": "#/parameters/keyNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Key" - } - }, - "204": { - "description": "Keys resource not found." - }, - "default": { - "schema": { - "$ref": "#/definitions/ErrorContract" - }, - "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while deleting Workspace Key." - } - }, - "consumes": [], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Delete a workspace key": { - "$ref": "./examples/DeleteKey.json" - } + "description": "*** Error Responses: ***\n\n * 400 BadRequest - Invalid request to create a Workspace Key.\n\n * 500 InternalServerError- Some error occurred while creating Workspace Key." } }, - "patch": { - "operationId": "Keys_Patch", - "description": "Patch a workspace key", - "tags": [ - "Keys" - ], - "deprecated": false, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./workspace.json#/parameters/workspaceNameParameter" - }, - { - "$ref": "#/parameters/keyNameParameter" - }, - { - "schema": { - "$ref": "#/definitions/KeyPatchInfo" - }, - "in": "body", - "name": "keyProperties", - "required": true, - "description": "Key patch request properties" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Key" - } - }, - "default": { - "schema": { - "$ref": "#/definitions/ErrorContract" - }, - "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while deleting Workspace Key." - } - }, - "consumes": [], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Patch a workspace key": { - "$ref": "./examples/UpdateKey.json" - } + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List keys in workspace": { + "$ref": "./examples/ListKeysInWorkspace.json" } } } }, - "definitions": { - "ErrorDetail": { - "description": "Error details", - "type": "object", - "properties": { - "message": { - "description": "Error message", - "type": "string" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/keys/{keyName}": { + "get": { + "operationId": "Keys_Get", + "description": "Gets a workspace key", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, - "code": { - "description": "Error code", - "type": "string" + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, - "target": { - "description": "Error target", - "type": "string" + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/keyNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/Key" + }, + "description": "Workspace Key details" + }, + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while trying to get details for Workspace Keys." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a workspace key": { + "$ref": "./examples/GetKey.json" } } }, - "ErrorContract": { - "title": "Error details.", - "description": "Contains details when the response code indicates an error.", - "type": "object", - "properties": { - "error": { - "description": "The error details.", - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + "put": { + "operationId": "Keys_CreateOrUpdate", + "description": "Creates or updates a workspace key", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/keyNameParameter" + }, + { + "schema": { + "$ref": "#/definitions/Key" + }, + "in": "body", + "name": "keyProperties", + "required": true, + "description": "Key put request properties" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/Key" + }, + "description": "Workspace Key resource details" + }, + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 400 BadRequest - Invalid request to create a Workspace Key.\n\n * 500 InternalServerError- Some error occurred while creating Workspace Key." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create or update a workspace key": { + "$ref": "./examples/CreateOrUpdateKey.json" } } }, - "KeyInfoListResult": { - "description": "List of keys", - "type": "object", - "properties": { - "nextLink": { - "description": "Link to the next page of results", - "type": "string" + "delete": { + "operationId": "Keys_Delete", + "description": "Deletes a workspace key", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, - "value": { - "description": "List of keys", - "type": "array", - "items": { + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/keyNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Key" } + }, + "204": { + "description": "Keys resource not found." + }, + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while deleting Workspace Key." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Delete a workspace key": { + "$ref": "./examples/DeleteKey.json" } } }, - "Key": { - "description": "A workspace key", - "type": "object", - "allOf": [ + "patch": { + "operationId": "Keys_Patch", + "description": "Patch a workspace key", + "tags": [ + "Keys" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./workspace.json#/parameters/workspaceNameParameter" + }, + { + "$ref": "#/parameters/keyNameParameter" + }, + { + "schema": { + "$ref": "#/definitions/KeyPatchInfo" + }, + "in": "body", + "name": "keyProperties", + "required": true, + "description": "Key patch request properties" } ], - "properties": { - "properties": { - "description": "Keys resource properties", - "$ref": "#/definitions/KeyProperties", - "x-ms-client-flatten": true + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Key" + } + }, + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while deleting Workspace Key." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Patch a workspace key": { + "$ref": "./examples/UpdateKey.json" } } - }, - "KeyPatchInfo": { - "description": "KeyInfo patch details", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags", - "additionalProperties": { - "type": "string" - }, - "type": "object" + } + } + }, + "definitions": { + "ErrorDetail": { + "description": "Error details", + "type": "object", + "properties": { + "message": { + "description": "Error message", + "type": "string" + }, + "code": { + "description": "Error code", + "type": "string" + }, + "target": { + "description": "Error target", + "type": "string" + } + } + }, + "ErrorContract": { + "title": "Error details.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + } + }, + "KeyInfoListResult": { + "description": "List of keys", + "type": "object", + "properties": { + "nextLink": { + "description": "Link to the next page of results", + "type": "string" + }, + "value": { + "description": "List of keys", + "type": "array", + "items": { + "$ref": "#/definitions/Key" } } - }, - "KeyProperties": { - "description": "Key properties", - "type": "object", + } + }, + "Key": { + "description": "A workspace key", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { "properties": { - "isActiveCMK": { - "type": "boolean", - "description": "Used to activate the workspace after a customer managed key is provided." - }, - "keyVaultUrl":{ - "type": "string", - "description": "The Key Vault Url of the workspace key." - } + "description": "Keys resource properties", + "$ref": "#/definitions/KeyProperties", + "x-ms-client-flatten": true + } + } + }, + "KeyPatchInfo": { + "description": "KeyInfo patch details", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags", + "additionalProperties": { + "type": "string" + }, + "type": "object" } } }, - "parameters": { - "keyNameParameter": { - "name": "keyName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the workspace key", - "x-ms-parameter-location": "method" + "KeyProperties": { + "description": "Key properties", + "type": "object", + "properties": { + "isActiveCMK": { + "type": "boolean", + "description": "Used to activate the workspace after a customer managed key is provided." + }, + "keyVaultUrl": { + "type": "string", + "description": "The Key Vault Url of the workspace key." + } } } + }, + "parameters": { + "keyNameParameter": { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace key", + "x-ms-parameter-location": "method" + } } - \ No newline at end of file +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json index c347678b4474..83e595fe7044 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json @@ -668,7 +668,7 @@ } } }, - "EncryptionDetails":{ + "EncryptionDetails": { "description": "Details of the encryption associated with the workspace", "type": "object", "properties": { @@ -683,7 +683,7 @@ } } }, - "CustomerManagedKeyDetails":{ + "CustomerManagedKeyDetails": { "description": "Details of the customer managed key associated with the workspace", "type": "object", "properties": { @@ -692,17 +692,17 @@ "type": "string", "readOnly": true }, - "key":{ + "key": { "description": "The key object of the workspace", "$ref": "#/definitions/WorkspaceKeyDetails" } } }, - "WorkspaceKeyDetails":{ + "WorkspaceKeyDetails": { "description": "Details of the customer managed key associated with the workspace", "type": "object", "properties": { - "name":{ + "name": { "description": "Workspace Key sub-resource name", "type": "string" }, @@ -838,7 +838,7 @@ "description": "The encryption details of the workspace", "$ref": "#/definitions/EncryptionDetails" }, - "workspaceUID":{ + "workspaceUID": { "description": "The workspace unique identifier", "type": "string", "readOnly": true From d87cfa40ba18dec6a25f8b89c061cd71c61d3be1 Mon Sep 17 00:00:00 2001 From: Eduardo Coronado Date: Mon, 26 Oct 2020 00:34:47 -0700 Subject: [PATCH 11/11] Address PR comments --- .../examples/CreateOrUpdateKey.json | 8 --- .../examples/DeleteKey.json | 1 - .../2019-06-01-preview/examples/GetKey.json | 4 +- .../examples/ListKeysInWorkspace.json | 8 +-- .../examples/UpdateKey.json | 27 ------- .../preview/2019-06-01-preview/keys.json | 72 +------------------ 6 files changed, 4 insertions(+), 116 deletions(-) delete mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json index 56fe337740d9..fd4c825f2822 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdateKey.json @@ -9,10 +9,6 @@ "properties": { "isActiveCMK": true, "keyVaultUrl": "https://vault.azure.net/keys/somesecret" - }, - "location": "East US", - "tags": { - "key": "value" } } }, @@ -21,14 +17,10 @@ "body": { "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", "type": "Microsoft.Synapse/workspaces/keys", - "location": "East US", "name": "somekey", "properties": { "isActiveCMK": true, "keyVaultUrl": "https://vault.azure.net/keys/somesecret" - }, - "tags": { - "key": "value" } } }, diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json index 3df4a4ae5983..a7495bfd40fe 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeleteKey.json @@ -12,7 +12,6 @@ "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", "type": "Microsoft.Synapse/workspaces/keys", "name": "somekey", - "location": "West US 2", "properties": { "isActiveCMK": true, "keyVaultUrl": "https://vault.azure.net/keys/key1" diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json index d8709cf35530..401880d6ed85 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetKey.json @@ -12,12 +12,10 @@ "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/somekey", "name": "somekey", "type": "Microsoft.Synapse/workspaces/keys", - "location": "Japan East", "properties": { "isActiveCMK": true, "keyVaultUrl": "https://vault.azure.net/keys/key1" - }, - "tags": {} + } } } } diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json index 067c1dd748f4..0d5ec5d9d04f 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListKeysInWorkspace.json @@ -13,23 +13,19 @@ "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/key1", "name": "key1", "type": "Microsoft.Synapse/workspaces/keys", - "location": "Japan East", "properties": { "keyVaultUrl": "https://vault.azure.net/keys/somesecret1", "isActiveCMK": false - }, - "tags": {} + } }, { "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/keys/key2", "name": "key2", "type": "Microsoft.Synapse/workspaces/keys", - "location": "Japan East", "properties": { "keyVaultUrl": "https://vault.azure.net/keys/somesecret2", "isActiveCMK": true - }, - "tags": {} + } } ] } diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json deleted file mode 100644 index a5b4c5dbfb59..000000000000 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdateKey.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "subscriptionId": "01234567-89ab-4def-0123-456789abcdef", - "resourceGroupName": "ExampleResourceGroup", - "workspaceName": "ExampleWorkspace", - "keyName": "somekey", - "api-version": "2019-06-01-preview", - "keyProperties": { - "tags": {} - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspaces/keys/somekey", - "type": "Microsoft.Synapse/workspaces/keys", - "name": "somekey", - "location": "West US 2", - "tags": {}, - "properties": { - "isActiveCMK": true, - "keyVaultUrl": "https://vault.azure.net/keys/somesecret" - } - } - } - } -} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json index 9523a1bc38a9..1475148b89c6 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/keys.json @@ -229,63 +229,6 @@ "$ref": "./examples/DeleteKey.json" } } - }, - "patch": { - "operationId": "Keys_Patch", - "description": "Patch a workspace key", - "tags": [ - "Keys" - ], - "deprecated": false, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./workspace.json#/parameters/workspaceNameParameter" - }, - { - "$ref": "#/parameters/keyNameParameter" - }, - { - "schema": { - "$ref": "#/definitions/KeyPatchInfo" - }, - "in": "body", - "name": "keyProperties", - "required": true, - "description": "Key patch request properties" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Key" - } - }, - "default": { - "schema": { - "$ref": "#/definitions/ErrorContract" - }, - "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while deleting Workspace Key." - } - }, - "consumes": [], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Patch a workspace key": { - "$ref": "./examples/UpdateKey.json" - } - } } } }, @@ -341,7 +284,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -352,19 +295,6 @@ } } }, - "KeyPatchInfo": { - "description": "KeyInfo patch details", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags", - "additionalProperties": { - "type": "string" - }, - "type": "object" - } - } - }, "KeyProperties": { "description": "Key properties", "type": "object",