Factories - Update

Service:

Data Factory

API Version:

2018-06-01

Updates a factory.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}?api-version=2018-06-01

URI Parameters

Name	In	Required	Type	Description
factoryName	path	True	string	The factory name. Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	The resource group name. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	The API version.

Request Body

Name	Type	Description
identity	FactoryIdentity	Managed service identity of the factory.
properties.publicNetworkAccess	PublicNetworkAccess	Whether or not public network access is allowed for the data factory.
tags	object	The resource tags.

Responses

Name	Type	Description
200 OK	Factory	OK.
Other Status Codes	CloudError	An error response received from the Azure Data Factory service.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Factories_Update

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName?api-version=2018-06-01

{
  "tags": {
    "exampleTag": "exampleValue"
  }
}

Java

import com.azure.resourcemanager.datafactory.models.Factory;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Factories Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Update.json
     */
    /**
     * Sample code: Factories_Update.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void factoriesUpdate(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        Factory resource = manager.factories().getByResourceGroupWithResponse("exampleResourceGroup",
            "exampleFactoryName", null, com.azure.core.util.Context.NONE).getValue();
        resource.update().withTags(mapOf("exampleTag", "exampleValue")).apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python factories_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.factories.update(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        factory_update_parameters={"tags": {"exampleTag": "exampleValue"}},
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Update.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdatafactory_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datafactory/armdatafactory/v9"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ab04533261eff228f28e08900445d0edef3eb70c/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Update.json
func ExampleFactoriesClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatafactory.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewFactoriesClient().Update(ctx, "exampleResourceGroup", "exampleFactoryName", armdatafactory.FactoryUpdateParameters{
		Tags: map[string]*string{
			"exampleTag": to.Ptr("exampleValue"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Factory = armdatafactory.Factory{
	// 	Name: to.Ptr("exampleFactoryName"),
	// 	Type: to.Ptr("Microsoft.DataFactory/factories"),
	// 	ETag: to.Ptr("\"00003f04-0000-0000-0000-5b28979e0000\""),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName"),
	// 	Location: to.Ptr("East US"),
	// 	Tags: map[string]*string{
	// 		"exampleTag": to.Ptr("exampleValue"),
	// 	},
	// 	Properties: &armdatafactory.FactoryProperties{
	// 		CreateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-06-19T05:41:50.004Z"); return t}()),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		Version: to.Ptr("2018-06-01"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DataFactoryManagementClient } = require("@azure/arm-datafactory");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates a factory.
 *
 * @summary Updates a factory.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Update.json
 */
async function factoriesUpdate() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const factoryUpdateParameters = {
    tags: { exampleTag: "exampleValue" },
  };
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.factories.update(
    resourceGroupName,
    factoryName,
    factoryUpdateParameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Core.Expressions.DataFactory;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Update.json
// this example is just showing the usage of "Factories_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataFactoryResource created on azure
// for more information of creating DataFactoryResource, please refer to the document of DataFactoryResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
ResourceIdentifier dataFactoryResourceId = DataFactoryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName);
DataFactoryResource dataFactory = client.GetDataFactoryResource(dataFactoryResourceId);

// invoke the operation
DataFactoryPatch patch = new DataFactoryPatch()
{
    Tags =
    {
    ["exampleTag"] = "exampleValue",
    },
};
DataFactoryResource result = await dataFactory.UpdateAsync(patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataFactoryData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

Date: Tue, 19 Jun 2018 05:41:50 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1192
x-ms-request-id: 699c67a6-fef5-40c9-bc73-d571d09783c3
x-ms-correlation-request-id: 699c67a6-fef5-40c9-bc73-d571d09783c3

{
  "name": "exampleFactoryName",
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName",
  "type": "Microsoft.DataFactory/factories",
  "properties": {
    "provisioningState": "Succeeded",
    "createTime": "2018-06-19T05:41:50.0041314Z",
    "version": "2018-06-01"
  },
  "eTag": "\"00003f04-0000-0000-0000-5b28979e0000\"",
  "location": "East US",
  "tags": {
    "exampleTag": "exampleValue"
  }
}

Definitions

Name	Description
CloudError	The object that defines the structure of an Azure Data Factory error response.
CMKIdentityDefinition	Managed Identity used for CMK.
EncryptionConfiguration	Definition of CMK for the factory.
Factory	Factory resource type.
FactoryGitHubConfiguration	Factory's GitHub repo information.
FactoryIdentity	Identity properties of the factory resource.
FactoryIdentityType	The identity type.
FactoryUpdateParameters	Parameters for updating a factory resource.
FactoryVSTSConfiguration	Factory's VSTS repo information.
GitHubClientSecret	Client secret information for factory's bring your own app repository configuration.
GlobalParameterSpecification	Definition of a single parameter for an entity.
GlobalParameterType	Global Parameter type.
PublicNetworkAccess	Whether or not public network access is allowed for the data factory.
PurviewConfiguration	Purview configuration.
UserAssignedIdentitySpecification	Definition of a single user assigned identity for a factory.

CloudError

The object that defines the structure of an Azure Data Factory error response.

Name	Type	Description
error.code	string	Error code.
error.details	CloudError[]	Array with additional error details.
error.message	string	Error message.
error.target	string	Property name/path in request associated with error.

CMKIdentityDefinition

Managed Identity used for CMK.

Name	Type	Description
userAssignedIdentity	string	The resource id of the user assigned identity to authenticate to customer's key vault.

EncryptionConfiguration

Definition of CMK for the factory.

Name	Type	Description
identity	CMKIdentityDefinition	User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used.
keyName	string	The name of the key in Azure Key Vault to use as Customer Managed Key.
keyVersion	string	The version of the key used for CMK. If not provided, latest version will be used.
vaultBaseUrl	string	The url of the Azure Key Vault used for CMK.

Factory

Factory resource type.

Name	Type	Description
eTag	string	Etag identifies change in the resource.
id	string	The resource identifier.
identity	FactoryIdentity	Managed service identity of the factory.
location	string	The resource location.
name	string	The resource name.
properties.createTime	string	Time the factory was created in ISO8601 format.
properties.encryption	EncryptionConfiguration	Properties to enable Customer Managed Key for the factory.
properties.globalParameters	<string,  GlobalParameterSpecification>	List of parameters for factory.
properties.provisioningState	string	Factory provisioning state, example Succeeded.
properties.publicNetworkAccess	PublicNetworkAccess	Whether or not public network access is allowed for the data factory.
properties.purviewConfiguration	PurviewConfiguration	Purview information of the factory.
properties.repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Git repo information of the factory.
properties.version	string	Version of the factory.
tags	object	The resource tags.
type	string	The resource type.

FactoryGitHubConfiguration

Factory's GitHub repo information.

Name	Type	Description
accountName	string	Account name.
clientId	string	GitHub bring your own app client id.
clientSecret	GitHubClientSecret	GitHub bring your own app client secret information.
collaborationBranch	string	Collaboration branch.
disablePublish	boolean	Disable manual publish operation in ADF studio to favor automated publish.
hostName	string	GitHub Enterprise host name. For example: https://github.mydomain.com
lastCommitId	string	Last commit id.
repositoryName	string	Repository name.
rootFolder	string	Root folder.
type	string: FactoryGitHubConfiguration	Type of repo configuration.

FactoryIdentity

Identity properties of the factory resource.

Name	Type	Description
principalId	string	The principal id of the identity.
tenantId	string	The client tenant id of the identity.
type	FactoryIdentityType	The identity type.
userAssignedIdentities	<string,  UserAssignedIdentitySpecification>	List of user assigned identities for the factory.

FactoryIdentityType

The identity type.

Name	Type	Description
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

FactoryUpdateParameters

Parameters for updating a factory resource.

Name	Type	Description
identity	FactoryIdentity	Managed service identity of the factory.
properties.publicNetworkAccess	PublicNetworkAccess	Whether or not public network access is allowed for the data factory.
tags	object	The resource tags.

FactoryVSTSConfiguration

Factory's VSTS repo information.

Name	Type	Description
accountName	string	Account name.
collaborationBranch	string	Collaboration branch.
disablePublish	boolean	Disable manual publish operation in ADF studio to favor automated publish.
lastCommitId	string	Last commit id.
projectName	string	VSTS project name.
repositoryName	string	Repository name.
rootFolder	string	Root folder.
tenantId	string	VSTS tenant id.
type	string: FactoryVSTSConfiguration	Type of repo configuration.

GitHubClientSecret

Client secret information for factory's bring your own app repository configuration.

Name	Type	Description
byoaSecretAkvUrl	string	Bring your own app client secret AKV URL.
byoaSecretName	string	Bring your own app client secret name in AKV.

GlobalParameterSpecification

Definition of a single parameter for an entity.

Name	Type	Description
type	GlobalParameterType	Global Parameter type.
value	object	Value of parameter.

GlobalParameterType

Global Parameter type.

Name	Type	Description
Array	string
Bool	string
Float	string
Int	string
Object	string
String	string

PublicNetworkAccess

Whether or not public network access is allowed for the data factory.

Name	Type	Description
Disabled	string
Enabled	string

PurviewConfiguration

Purview configuration.

Name	Type	Description
purviewResourceId	string	Purview resource id.

UserAssignedIdentitySpecification

Definition of a single user assigned identity for a factory.