你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Factories - Update

服务:

Data Factory

API 版本:

2018-06-01

更新工厂。

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

URI 参数

名称	在	必需	类型	说明
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	工厂名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	资源组名称。
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 版本。

请求正文

名称	类型	说明
identity	FactoryIdentity	工厂的托管服务标识。
properties.publicNetworkAccess	PublicNetworkAccess	是否允许对数据工厂进行公用网络访问。
tags	object	资源标记。

响应

名称	类型	说明
200 OK	Factory	还行。
Other Status Codes	CloudError	从 Azure 数据工厂服务收到的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Factories_Update

示例请求

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.Threading.Tasks;
using Azure.Core;
using Azure.Core.Expressions.DataFactory;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
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

示例响应

状态代码:

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"
  }
}

定义

名称	说明
CloudError	定义 Azure 数据工厂错误响应结构的对象。
CMKIdentityDefinition	用于 CMK 的托管标识。
EncryptionConfiguration	工厂的 CMK 定义。
Factory	工厂资源类型。
FactoryGitHubConfiguration	工厂的 GitHub 存储库信息。
FactoryIdentity	工厂资源的标识属性。
FactoryIdentityType	标识类型。
FactoryUpdateParameters	用于更新工厂资源的参数。
FactoryVSTSConfiguration	工厂的 VSTS 存储库信息。
GitHubClientSecret	工厂自带应用存储库配置的客户端机密信息。
GlobalParameterSpecification	为实体定义单个参数。
GlobalParameterType	全局参数类型。
PublicNetworkAccess	是否允许对数据工厂进行公用网络访问。
PurviewConfiguration	Purview 配置。
UserAssignedIdentitySpecification	为工厂分配的单个用户标识的定义。

CloudError

Object

定义 Azure 数据工厂错误响应结构的对象。

名称	类型	说明
error.code	string	错误代码。
error.details	CloudError[]	包含其他错误详细信息的数组。
error.message	string	错误信息。
error.target	string	与错误关联的请求中的属性名称/路径。

CMKIdentityDefinition

Object

用于 CMK 的托管标识。

名称	类型	说明
userAssignedIdentity	string	要向客户的密钥保管库进行身份验证的用户分配标识的资源 ID。

EncryptionConfiguration

Object

工厂的 CMK 定义。

名称	类型	说明
identity	CMKIdentityDefinition	用户分配的标识用于对客户的密钥保管库进行身份验证。 如果未提供托管服务标识，将使用该标识。
keyName	string	用作客户管理的密钥的 Azure Key Vault 中的密钥的名称。
keyVersion	string	用于 CMK 的密钥的版本。 如果未提供，将使用最新版本。
vaultBaseUrl	string	用于 CMK 的 Azure Key Vault 的 URL。

Factory

Object

工厂资源类型。

名称	类型	说明
eTag	string	Etag 标识资源中的更改。
id	string	资源标识符。
identity	FactoryIdentity	工厂的托管服务标识。
location	string	资源位置。
name	string	资源名称。
properties.createTime	string (date-time)	以ISO8601格式创建工厂的时间。
properties.encryption	EncryptionConfiguration	为工厂启用客户管理的密钥的属性。
properties.globalParameters	<string,  GlobalParameterSpecification>	工厂的参数列表。
properties.provisioningState	string	工厂预配状态，示例成功。
properties.publicNetworkAccess	PublicNetworkAccess	是否允许对数据工厂进行公用网络访问。
properties.purviewConfiguration	PurviewConfiguration	工厂的 Purview 信息。
properties.repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	工厂的 Git 存储库信息。
properties.version	string	工厂的版本。
tags	object	资源标记。
type	string	资源类型。

FactoryGitHubConfiguration

Object

工厂的 GitHub 存储库信息。

名称	类型	说明
accountName	string	帐户名称。
clientId	string	GitHub 自带应用客户端 ID。
clientSecret	GitHubClientSecret	GitHub 自带应用客户端机密信息。
collaborationBranch	string	协作分支。
disablePublish	boolean	在 ADF Studio 中禁用手动发布操作，以支持自动发布。
hostName	string	GitHub Enterprise 主机名。 例如：https://github.mydomain.com
lastCommitId	string	上次提交 ID。
repositoryName	string	存储库名称。
rootFolder	string	根文件夹。
type	string: FactoryGitHubConfiguration	存储库配置的类型。

FactoryIdentity

Object

工厂资源的标识属性。

名称	类型	说明
principalId	string (uuid)	标识的主体 ID。
tenantId	string (uuid)	标识的客户端租户 ID。
type	FactoryIdentityType	标识类型。
userAssignedIdentities	<string,  UserAssignedIdentitySpecification>	工厂的用户分配标识列表。

FactoryIdentityType

枚举

标识类型。

值	说明
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

FactoryUpdateParameters

Object

用于更新工厂资源的参数。

名称	类型	说明
identity	FactoryIdentity	工厂的托管服务标识。
properties.publicNetworkAccess	PublicNetworkAccess	是否允许对数据工厂进行公用网络访问。
tags	object	资源标记。

FactoryVSTSConfiguration

Object

工厂的 VSTS 存储库信息。

名称	类型	说明
accountName	string	帐户名称。
collaborationBranch	string	协作分支。
disablePublish	boolean	在 ADF Studio 中禁用手动发布操作，以支持自动发布。
lastCommitId	string	上次提交 ID。
projectName	string	VSTS 项目名称。
repositoryName	string	存储库名称。
rootFolder	string	根文件夹。
tenantId	string	VSTS 租户 ID。
type	string: FactoryVSTSConfiguration	存储库配置的类型。

GitHubClientSecret

Object

工厂自带应用存储库配置的客户端机密信息。

名称	类型	说明
byoaSecretAkvUrl	string	自带应用客户端机密 AKV URL。
byoaSecretName	string	在 AKV 中自带应用客户端机密名称。

GlobalParameterSpecification

Object

为实体定义单个参数。

名称	类型	说明
type	GlobalParameterType	全局参数类型。
value	object	参数的值。

GlobalParameterType

枚举

全局参数类型。

值	说明
Array
Bool
Float
Int
Object
String

PublicNetworkAccess

枚举

是否允许对数据工厂进行公用网络访问。

值	说明
Disabled
Enabled

PurviewConfiguration

Object

Purview 配置。

名称	类型	说明
purviewResourceId	string	Purview 资源 ID。

UserAssignedIdentitySpecification

Object

为工厂分配的单个用户标识的定义。