diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json index 2ae1a2d47216..dfe92e9e5c6d 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json @@ -4364,6 +4364,194 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters": { + "get": { + "tags": [ + "globalParameters" + ], + "operationId": "GlobalParameters_ListByFactory", + "x-ms-examples": { + "GlobalParameters_ListByFactory": { + "$ref": "./examples/GlobalParameters_ListByFactory.json" + } + }, + "description": "Lists Global parameters", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GlobalParameterListResponse" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/globalParameters/{globalParameterName}": { + "get": { + "tags": [ + "globalParameters" + ], + "operationId": "GlobalParameters_Get", + "x-ms-examples": { + "GlobalParameters_Get": { + "$ref": "./examples/GlobalParameters_Get.json" + } + }, + "description": "Gets a Global parameter", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/globalParameterName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GlobalParameterResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "globalParameters" + ], + "operationId": "GlobalParameters_CreateOrUpdate", + "x-ms-examples": { + "GlobalParameters_Create": { + "$ref": "./examples/GlobalParameters_Create.json" + }, + "GlobalParameters_Update": { + "$ref": "./examples/GlobalParameters_Update.json" + } + }, + "description": "Creates or updates a Global parameter", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/globalParameterName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "default", + "description": "Global parameter resource definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GlobalParameterResource" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/GlobalParameterResource" + } + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "globalParameters" + ], + "operationId": "GlobalParameters_Delete", + "x-ms-examples": { + "GlobalParameters_Delete": { + "$ref": "./examples/GlobalParameters_Delete.json" + } + }, + "description": "Deletes a Global parameter", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/globalParameterName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No Content." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } } }, "definitions": { @@ -4837,6 +5025,26 @@ "runId" ] }, + "GlobalParameterListResponse": { + "description": "A list of Global parameters.", + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of global parameters.", + "items": { + "$ref": "#/definitions/GlobalParameterResource" + } + }, + "nextLink": { + "description": "The link to the next page of results, if any remaining results exist.", + "type": "string" + } + } + }, "CloudError": { "x-ms-external": true, "description": "The object that defines the structure of an Azure Data Factory error response.", @@ -5385,6 +5593,24 @@ "properties" ] }, + "GlobalParameterResource": { + "description": "Global parameters resource type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "$ref": "./entityTypes/GlobalParameter.json#/definitions/GlobalParameter", + "description": "Properties of the global parameter." + } + }, + "required": [ + "properties" + ] + }, "Factory": { "description": "Factory resource type.", "type": "object", @@ -7248,6 +7474,17 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" + }, + "globalParameterName": { + "name": "globalParameterName", + "description": "The global parameter name.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_][^<>*#.%&:\\\\+?/]*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method" } } } diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/GlobalParameter.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/GlobalParameter.json new file mode 100644 index 000000000000..c91c70ad0cce --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/GlobalParameter.json @@ -0,0 +1,29 @@ +{ + "swagger": "2.0", + "info": { + "title": "DataFactoryManagementClient", + "version": "2018-06-01" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "GlobalParameter": { + "description": "Global parameters associated with the Azure Data Factory", + "type": "object", + "properties": {}, + "additionalProperties": { + "$ref": "../datafactory.json#/definitions/GlobalParameterSpecification" + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_Create.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_Create.json new file mode 100644 index 000000000000..54f696c43358 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_Create.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "globalParameterName": "default", + "default": { + "properties": { + "waitTime": { + "value": 5, + "type": "Int" + } + } + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:14 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1186", + "x-ms-request-id": "373f1a49-685d-4c07-8857-0fcf1bcaffcb", + "x-ms-correlation-request-id": "373f1a49-685d-4c07-8857-0fcf1bcaffcb" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/globalParameters/default", + "name": "default", + "type": "Microsoft.DataFactory/factories/globalParameters", + "properties": { + "waitTime": { + "value": 5, + "type": "Int" + } + }, + "etag": "0a008ad4-0000-0000-0000-5b245c6e0000" + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_Delete.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_Delete.json new file mode 100644 index 000000000000..771f84b66fa9 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "globalParameterName": "default", + "api-version": "2018-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_Get.json new file mode 100644 index 000000000000..bef89ef3f50a --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "globalParameterName": "default", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:52 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11989", + "x-ms-request-id": "8ad1759f-24c1-46a5-aef5-edd267e18870", + "x-ms-correlation-request-id": "8ad1759f-24c1-46a5-aef5-edd267e18870" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/globalParameters/default", + "name": "default", + "type": "Microsoft.DataFactory/factories/globalParameters", + "properties": { + "waitTime": { + "value": 10, + "type": "Int" + } + }, + "etag": "72001a6a-0000-0400-0000-623d058f0000" + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_ListByFactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_ListByFactory.json new file mode 100644 index 000000000000..62e8a609520d --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_ListByFactory.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Mon, 22 Apr 2019 18:33:52 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11989", + "x-ms-request-id": "8ad1759f-24c1-46a5-aef5-edd267e18870", + "x-ms-correlation-request-id": "8ad1759f-24c1-46a5-aef5-edd267e18870" + }, + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/globalParameters/default", + "name": "default", + "type": "Microsoft.DataFactory/factories/globalParameters", + "properties": { + "url": { + "value": "https://testuri.test", + "type": "String" + }, + "waitTime": { + "value": 5, + "type": "Int" + }, + "validADFOffice365Uris": { + "value": [ + "https://testuri.test", + "https://testuri.test" + ], + "type": "Array" + }, + "mySourceDatasetFolderPath": { + "value": "input", + "type": "String" + }, + "copyPipelineTest": { + "value": { + "mySourceDatasetFolderPath": "exampleInput/", + "mySinkDatasetFolderPath": "exampleOutput", + "testingEmptyContextParams": "" + }, + "type": "Object" + } + }, + "etag": "da00a1c3-0000-0400-0000-6241f3290000" + } + ] + } + } + } +} diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_Update.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_Update.json new file mode 100644 index 000000000000..54f696c43358 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/GlobalParameters_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "globalParameterName": "default", + "default": { + "properties": { + "waitTime": { + "value": 5, + "type": "Int" + } + } + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:40:14 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1186", + "x-ms-request-id": "373f1a49-685d-4c07-8857-0fcf1bcaffcb", + "x-ms-correlation-request-id": "373f1a49-685d-4c07-8857-0fcf1bcaffcb" + }, + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/globalParameters/default", + "name": "default", + "type": "Microsoft.DataFactory/factories/globalParameters", + "properties": { + "waitTime": { + "value": 5, + "type": "Int" + } + }, + "etag": "0a008ad4-0000-0000-0000-5b245c6e0000" + } + } + } +}