Factories - Configure Factory Repo

Служба:: Data Factory

Версия API:: 2018-06-01

Обновляет сведения о репозитории фабрики.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/configureFactoryRepo?api-version=2018-06-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
locationId	path	True	string	Идентификатор расположения.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
factoryResourceId	string	Идентификатор ресурса фабрики.
repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Сведения о репозитории Git фабрики.

Ответы

Имя	Тип	Описание
200 OK	Factory	Запрос выполнен успешно.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Factories_ConfigureFactoryRepo

Образец запроса

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/providers/Microsoft.DataFactory/locations/East US/configureFactoryRepo?api-version=2018-06-01

{
  "factoryResourceId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName",
  "repoConfiguration": {
    "type": "FactoryVSTSConfiguration",
    "accountName": "ADF",
    "collaborationBranch": "master",
    "lastCommitId": "",
    "projectName": "project",
    "repositoryName": "repo",
    "rootFolder": "/",
    "tenantId": ""
  }
}


import com.azure.resourcemanager.datafactory.models.FactoryRepoUpdate;
import com.azure.resourcemanager.datafactory.models.FactoryVstsConfiguration;

/**
 * Samples for Factories ConfigureFactoryRepo.
 */
public final class Main {
    /*
     * x-ms-original-file: 2018-06-01/Factories_ConfigureFactoryRepo.json
     */
    /**
     * Sample code: Factories_ConfigureFactoryRepo.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void factoriesConfigureFactoryRepo(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.factories().configureFactoryRepoWithResponse("East US", new FactoryRepoUpdate().withFactoryResourceId(
            "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName")
            .withRepoConfiguration(new FactoryVstsConfiguration().withAccountName("ADF").withRepositoryName("repo")
                .withCollaborationBranch("master").withRootFolder("/").withLastCommitId("").withProjectName("project")
                .withTenantId("")),
            com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python factories_configure_factory_repo.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.configure_factory_repo(
        location_id="East US",
        factory_repo_update={
            "factoryResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName",
            "repoConfiguration": {
                "accountName": "ADF",
                "collaborationBranch": "master",
                "lastCommitId": "",
                "projectName": "project",
                "repositoryName": "repo",
                "rootFolder": "/",
                "tenantId": "",
                "type": "FactoryVSTSConfiguration",
            },
        },
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/examples/Factories_ConfigureFactoryRepo.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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
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/DataFactory/stable/2018-06-01/examples/Factories_ConfigureFactoryRepo.json
// this example is just showing the usage of "Factories_ConfigureFactoryRepo" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
AzureLocation locationId = new AzureLocation("East US");
FactoryRepoContent content = new FactoryRepoContent
{
    FactoryResourceId = new ResourceIdentifier("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName"),
    RepoConfiguration = new FactoryVstsConfiguration("ADF", "repo", "master", "/", "project")
    {
        TenantId = Guid.Parse(""),
        LastCommitId = "",
    },
};
DataFactoryResource result = await subscriptionResource.ConfigureFactoryRepoInformationAsync(locationId, content);

// 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-correlation-request-id: c63640bd-3e5f-4ee0-bae1-cea74f761a7d
x-ms-ratelimit-remaining-subscription-writes: 1191
x-ms-request-id: c63640bd-3e5f-4ee0-bae1-cea74f761a7d

{
  "name": "exampleFactoryName",
  "type": "Microsoft.DataFactory/factories",
  "eTag": "\"00004004-0000-0000-0000-5b28979e0000\"",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName",
  "location": "East US",
  "properties": {
    "createTime": "2018-06-19T05:41:50.0041314Z",
    "provisioningState": "Succeeded",
    "repoConfiguration": {
      "type": "FactoryVSTSConfiguration",
      "accountName": "ADF",
      "collaborationBranch": "master",
      "lastCommitId": "",
      "projectName": "project",
      "repositoryName": "repo",
      "rootFolder": "/",
      "tenantId": ""
    },
    "version": "2018-06-01"
  },
  "tags": {
    "exampleTag": "exampleValue"
  }
}

Определения

Имя	Описание
CloudError	Объект, определяющий структуру ответа об ошибке Фабрики данных Azure.
CMKIdentityDefinition	Управляемое удостоверение, используемое для CMK.
createdByType	Тип удостоверения, создавшего ресурс.
EncryptionConfiguration	Определение CMK для фабрики.
Factory	Тип ресурса фабрики.
FactoryGitHubConfiguration	Сведения о репозитории GitHub фабрики.
FactoryIdentity	Свойства удостоверений ресурса фабрики.
FactoryIdentityType	Тип удостоверения.
FactoryRepoUpdate	Сведения о репозитории Git фабрики.
FactoryVSTSConfiguration	Сведения о репозитории VSTS фабрики.
GitHubClientSecret	Сведения о секрете клиента для фабрики содержат собственную конфигурацию репозитория приложений.
GlobalParameterSpecification	Определение одного параметра для сущности.
GlobalParameterType	Глобальный тип параметра.
PublicNetworkAccess	Допускается ли доступ к общедоступной сети для фабрики данных.
PurviewConfiguration	Конфигурация Purview.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

CloudError

Объект

Объект, определяющий структуру ответа об ошибке Фабрики данных Azure.

Имя	Тип	Описание
error.code	string	Код ошибки.
error.details	CloudError[]	Массив с дополнительными сведениями об ошибке.
error.message	string	Сообщение об ошибке.
error.target	string	Имя или путь свойства в запросе, связанном с ошибкой.

CMKIdentityDefinition

Объект

Управляемое удостоверение, используемое для CMK.

Имя	Тип	Описание
userAssignedIdentity	string	Идентификатор ресурса назначаемого пользователем удостоверения для проверки подлинности в хранилище ключей клиента.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

EncryptionConfiguration

Объект

Определение CMK для фабрики.

Имя	Тип	Описание
identity	CMKIdentityDefinition	Назначаемое пользователем удостоверение для проверки подлинности в хранилище ключей клиента. Если не предоставлено управляемое удостоверение службы, будет использоваться.
keyName	string	Имя ключа в Azure Key Vault, используемого в качестве управляемого ключа клиента.
keyVersion	string	Версия ключа, используемого для CMK. Если это не указано, будет использоваться последняя версия.
vaultBaseUrl	string	URL-адрес Azure Key Vault, используемый для CMK.

Factory

Объект

Тип ресурса фабрики.

Имя	Тип	Описание
eTag	string	Если eTag указан в тексте ответа, он также может быть предоставлен в виде заголовка для обычного соглашения etag. Теги сущностей используются для сравнения двух или нескольких сущностей из одного запрошенного ресурса. HTTP/1.1 использует теги сущностей в etag (раздел 14.19), If-Match (раздел 14.24), If-None-Match (раздел 14.26) и If-Range (раздел 14.27).
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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	Версия фабрики.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

FactoryGitHubConfiguration

Объект

Сведения о репозитории GitHub фабрики.

Имя	Тип	Описание
accountName	string	Имя учетной записи.
clientId	string	GitHub приносит собственный идентификатор клиента приложения.
clientSecret	GitHubClientSecret	GitHub приносит собственные сведения о секрете клиента приложения.
collaborationBranch	string	Ветвь совместной работы.
disablePublish	boolean	Отключите операцию публикации вручную в студии ADF, чтобы использовать автоматическую публикацию.
hostName	string	Имя узла GitHub Enterprise. Например: `https://github.mydomain.com`
lastCommitId	string	Идентификатор последней фиксации.
repositoryName	string	Имя репозитория.
rootFolder	string	Корневая папка.
type	string: FactoryGitHubConfiguration	Тип конфигурации репозитория.

FactoryIdentity

Объект

Свойства удостоверений ресурса фабрики.

Имя	Тип	Описание
principalId	string (uuid)	Идентификатор субъекта удостоверения.
tenantId	string (uuid)	Идентификатор клиента удостоверения.
type	FactoryIdentityType	Тип удостоверения.
userAssignedIdentities		Список назначенных пользователем удостоверений для фабрики.

FactoryIdentityType

Перечисление

Тип удостоверения.

Значение	Описание
SystemAssigned	Системное назначение
UserAssigned	UserAssigned
SystemAssigned,UserAssigned	SystemAssigned,UserAssigned

FactoryRepoUpdate

Объект

Сведения о репозитории Git фабрики.

Имя	Тип	Описание
factoryResourceId	string	Идентификатор ресурса фабрики.
repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Сведения о репозитории Git фабрики.

FactoryVSTSConfiguration

Объект

Сведения о репозитории VSTS фабрики.

Имя	Тип	Описание
accountName	string	Имя учетной записи.
collaborationBranch	string	Ветвь совместной работы.
disablePublish	boolean	Отключите операцию публикации вручную в студии ADF, чтобы использовать автоматическую публикацию.
lastCommitId	string	Идентификатор последней фиксации.
projectName	string	Имя проекта VSTS.
repositoryName	string	Имя репозитория.
rootFolder	string	Корневая папка.
tenantId	string	Идентификатор клиента VSTS.
type	string: FactoryVSTSConfiguration	Тип конфигурации репозитория.

GitHubClientSecret

Объект

Сведения о секрете клиента для фабрики содержат собственную конфигурацию репозитория приложений.

Имя	Тип	Описание
byoaSecretAkvUrl	string	Доведите URL-адрес AKV секрета клиента приложения.
byoaSecretName	string	Приведите собственное имя секрета клиента приложения в AKV.

GlobalParameterSpecification

Объект

Определение одного параметра для сущности.

Имя	Тип	Описание
type	GlobalParameterType	Глобальный тип параметра.
value		Значение параметра.

GlobalParameterType

Перечисление

Глобальный тип параметра.

Значение	Описание
Object	Объект
String	String
Int	Int
Float	Тип с плавающей запятой
Bool	Булев
Array	Массив

PublicNetworkAccess

Перечисление

Допускается ли доступ к общедоступной сети для фабрики данных.

Значение	Описание
Enabled	Enabled
Disabled	Disabled

PurviewConfiguration

Объект

Конфигурация Purview.

Имя	Тип	Описание
purviewResourceId	string	Идентификатор ресурса Purview.

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Factories - Configure Factory Repo

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

Factories_ConfigureFactoryRepo

Образец запроса

Пример ответа

Определения

CloudError

CMKIdentityDefinition

createdByType

EncryptionConfiguration

Factory

FactoryGitHubConfiguration

FactoryIdentity

FactoryIdentityType

FactoryRepoUpdate

FactoryVSTSConfiguration

GitHubClientSecret

GlobalParameterSpecification

GlobalParameterType

PublicNetworkAccess

PurviewConfiguration

systemData