diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/GetScopePoolsList.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/GetScopePoolsList.json new file mode 100644 index 000000000000..c21d557be62f --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/GetScopePoolsList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "d7109bf4-4ca6-46b5-b582-722e2462b7f5", + "resourceGroupName": "Agile_Analytics_Prod", + "workspaceName": "mdesynwus2prd01", + "api-version": "2021-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d7109bf4-4ca6-46b5-b582-722e2462b7f5/resourceGroups/Agile_Analytics_Prod/providers/Microsoft.Synapse/workspaces/mdesynwus2prd01/scopePools", + "name": "usrscpl01", + "type": "Microsoft.Synapse/workspaces/scopePools", + "location": "Japan East", + "properties": { + "creationDate": "2021-05-24T05:19:55.3133333Z", + "maxQueuedJobs": 10, + "maxRunningJobs": 2, + "maxTokens": 50, + "maxEcoTokens": 0, + "extendedProperties": { + "poolLimitAndPolicies": { + "maxTokensPerJob": 50, + "maxEcoTokensPerJob": 0 + } + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/workspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/workspace.json index a76fe58bd832..d54e5fb948a6 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/workspace.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/workspace.json @@ -995,6 +995,55 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/scopePools": { + "get": { + "tags": [ + "ScopePools" + ], + "operationId": "ScopePoolsListByWorkspace_Get", + "description": "Gets a list of scope pools", + "x-ms-examples": { + "Get list of scope pools": { + "$ref": "./examples/GetScopePoolsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + } + ], + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ScopePoolsListResult" + } + }, + "default": { + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + }, + "description": "Error" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } } }, "definitions": { @@ -1696,6 +1745,115 @@ "x-ms-client-flatten": true } } + }, + "ScopePoolsListResult": { + "type": "object", + "properties": { + "value": { + "type": "object", + "items": { + "$ref": "#/definitions/ScopePools" + }, + "description": "A list of Scope pools" + } + }, + "description": "The response to a list Scope pools request" + }, + "ScopePools": { + "type": "object", + "title": "Scope Pools", + "properties": { + "location": { + "type": "string", + "readOnly": true, + "description": "The geo-location where the resource lives" + }, + "properties": { + "$ref": "#/definitions/ScopePoolProperties", + "description": "The properties of a Scope pool", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Scope pool for workspace" + }, + "ScopePoolProperties": { + "type": "object", + "description": "Properties for Scope Pool", + "properties": { + "creationDate": { + "description": "The Creation Date for Scope Pool", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "maxQueuedJobs": { + "readOnly": true, + "type": "number", + "format": "int32", + "description": "The maximum numbers of jobs that can queue up" + }, + "maxRunningJobs": { + "readOnly": true, + "type": "number", + "format": "int32", + "description": "The maximum number of jobs that can run simultaneously" + }, + "maxTokens": { + "readOnly": true, + "type": "number", + "format": "int32", + "description": "The max tokens per pool" + }, + "maxEcoTokens": { + "readOnly": true, + "type": "number", + "format": "int32", + "description": "The max ECO tokens per pool" + }, + "extendedProperties": { + "type": "string", + "description": "Scope Pool Extended Properties", + "properties": { + "poolLimitAndPolicies": { + "type": "string", + "description": "Scope pool Limit And Policies", + "properties": { + "maxTokensPerJob": { + "type": "number", + "format": "int32", + "description": "Max Tokens Per Job" + }, + "maxEcoTokensPerJob": { + "type": "number", + "format": "int32", + "description": "Max ECO Tokens Per Job" + } + } + } + } + }, + "provisioningState": { + "enum": [ + "Provisioning", + "Succeeded", + "Deleting", + "Failed", + "DeleteError", + "UpdateError" + ], + "description": "Provisioning State of Scope Pool", + "type": "string", + "x-ms-enum": { + "name": "Workspace provisioning State", + "modelAsString": true + } + } + } } } }