Factories - Configure Factory Repo

Služba:

Data Factory

Verze rozhraní API:

2018-06-01

Aktualizuje informace o úložišti továrny.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
locationId	path	True	string	Identifikátor umístění.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
factoryResourceId	string	ID prostředku továrny.
repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Informace o úložišti Git pro továrnu

Odpovědi

Name	Typ	Description
200 OK	Factory	Požadavek byl úspěšný.
Other Status Codes	CloudError	Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Factories_ConfigureFactoryRepo

Ukázkový požadavek

HTTP

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

Java

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

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_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

dotnet

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
CloudError	Objekt, který definuje strukturu chybové odpovědi služby Azure Data Factory.
CMKIdentityDefinition	Spravovaná identita používaná pro CMK.
createdByType	Typ identity, která prostředek vytvořila.
EncryptionConfiguration	Definice CMK pro továrnu.
Factory	Typ prostředku továrny
FactoryGitHubConfiguration	Informace o úložišti GitHubu pro továrnu
FactoryIdentity	Vlastnosti identity prostředku továrny
FactoryIdentityType	Typ identity.
FactoryRepoUpdate	Informace o úložišti Git factory
FactoryVSTSConfiguration	Informace o úložišti VSTS továrny
GitHubClientSecret	Informace o tajných klíčích klienta pro vlastní konfiguraci úložiště aplikací v továrně
GlobalParameterSpecification	Definice jednoho parametru pro entitu
GlobalParameterType	Globální typ parametru.
PublicNetworkAccess	Určuje, jestli je pro datovou továrnu povolený přístup k veřejné síti nebo ne.
PurviewConfiguration	Konfigurace Purview
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

CloudError

Objekt

Objekt, který definuje strukturu chybové odpovědi služby Azure Data Factory.

Name	Typ	Description
error.code	string	Kód chyby
error.details	CloudError[]	Pole s dalšími podrobnostmi o chybě
error.message	string	Zpráva o chybě.
error.target	string	Název vlastnosti nebo cesta v požadavku přidruženém k chybě.

CMKIdentityDefinition

Objekt

Spravovaná identita používaná pro CMK.

Name	Typ	Description
userAssignedIdentity	string	ID prostředku identity přiřazené uživatelem pro ověření v trezoru klíčů zákazníka.

createdByType

Výčet

Typ identity, která prostředek vytvořila.

Hodnota	Description
User
Application
ManagedIdentity
Key

EncryptionConfiguration

Objekt

Definice CMK pro továrnu.

Name	Typ	Description
identity	CMKIdentityDefinition	Identita přiřazená uživatelem, která se má použít k ověření v trezoru klíčů zákazníka. Pokud není k dispozici identita spravované služby, použije se.
keyName	string	Název klíče ve službě Azure Key Vault, který se použije jako klíč spravovaný zákazníkem.
keyVersion	string	Verze klíče použitého pro CMK. Pokud není k dispozici, použije se nejnovější verze.
vaultBaseUrl	string	Adresa URL služby Azure Key Vault použitá pro CMK.

Factory

Objekt

Typ prostředku továrny

Name	Typ	Description
eTag	string	Pokud je v textu odpovědi uvedena značka eTag, může být také poskytována jako hlavička podle normální konvence značky etag. Značky entit se používají k porovnání dvou nebo více entit ze stejného požadovaného prostředku. HTTP/1.1 používá značky entit v etagu (oddíl 14.19), If-Match (oddíl 14.24), If-None-Match (oddíl 14.26) a If-Range (oddíl 14.27).
id	string (arm-id)	Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	FactoryIdentity	Identita spravované služby objektu pro vytváření
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.createTime	string (date-time)	Čas vytvoření továrny ve formátu ISO8601
properties.encryption	EncryptionConfiguration	Vlastnosti pro povolení klíče spravovaného zákazníkem pro továrnu
properties.globalParameters	<string,  GlobalParameterSpecification>	Seznam parametrů pro továrnu
properties.provisioningState	string	Stav zřizování továrny, příklad Byl úspěšný.
properties.publicNetworkAccess	PublicNetworkAccess	Určuje, jestli je pro datovou továrnu povolený přístup k veřejné síti nebo ne.
properties.purviewConfiguration	PurviewConfiguration	Purview informace o továrně.
properties.repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Informace o úložišti Git pro továrnu
properties.version	string	Verze továrny.
systemData	systemData	Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.
tags	object	Značky prostředků
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

FactoryGitHubConfiguration

Objekt

Informace o úložišti GitHubu pro továrnu

Name	Typ	Description
accountName	string	Název účtu
clientId	string	GitHub přináší vlastní ID klienta aplikace.
clientSecret	GitHubClientSecret	GitHub přináší vlastní informace o tajných klíči klienta aplikace.
collaborationBranch	string	Větev pro spolupráci.
disablePublish	boolean	Zakažte operaci ručního publikování v ADF Studiu, abyste upřednostňovali automatizované publikování.
hostName	string	Název hostitele GitHub Enterprise Příklad: https://github.mydomain.com
lastCommitId	string	ID posledního potvrzení.
repositoryName	string	Název úložiště
rootFolder	string	Kořenová složka.
type	string: FactoryGitHubConfiguration	Typ konfigurace úložiště

FactoryIdentity

Objekt

Vlastnosti identity prostředku továrny

Name	Typ	Description
principalId	string (uuid)	ID objektu zabezpečení identity.
tenantId	string (uuid)	ID tenanta klienta identity.
type	FactoryIdentityType	Typ identity.
userAssignedIdentities		Seznam identit přiřazených uživatelem pro továrnu

FactoryIdentityType

Výčet

Typ identity.

Hodnota	Description
SystemAssigned	Přiřazen systémem
UserAssigned	Přiřazeno uživatelem
SystemAssigned,UserAssigned	SystémPřiřazené,Přiřazené uživatelem

FactoryRepoUpdate

Objekt

Informace o úložišti Git factory

Name	Typ	Description
factoryResourceId	string	ID prostředku továrny.
repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Informace o úložišti Git pro továrnu

FactoryVSTSConfiguration

Objekt

Informace o úložišti VSTS továrny

Name	Typ	Description
accountName	string	Název účtu
collaborationBranch	string	Větev pro spolupráci.
disablePublish	boolean	Zakažte operaci ručního publikování v ADF Studiu, abyste upřednostňovali automatizované publikování.
lastCommitId	string	ID posledního potvrzení.
projectName	string	Název projektu VSTS
repositoryName	string	Název úložiště
rootFolder	string	Kořenová složka.
tenantId	string	ID tenanta VSTS
type	string: FactoryVSTSConfiguration	Typ konfigurace úložiště

GitHubClientSecret

Objekt

Informace o tajných klíčích klienta pro vlastní konfiguraci úložiště aplikací v továrně

Name	Typ	Description
byoaSecretAkvUrl	string	Přineste si vlastní adresu URL tajného klíče klienta aplikace AKV.
byoaSecretName	string	Přineste si vlastní název tajného klíče klienta aplikace v AKV.

GlobalParameterSpecification

Objekt

Definice jednoho parametru pro entitu

Name	Typ	Description
type	GlobalParameterType	Globální typ parametru.
value		Hodnota parametru.

GlobalParameterType

Výčet

Globální typ parametru.

Hodnota	Description
Object	Objekt
String	String
Int	Int
Float	Plovat
Bool	Booleovská hodnota
Array	Pole

PublicNetworkAccess

Výčet

Určuje, jestli je pro datovou továrnu povolený přístup k veřejné síti nebo ne.

Hodnota	Description
Enabled	Enabled
Disabled	Disabled

PurviewConfiguration

Objekt

Konfigurace Purview

Name	Typ	Description
purviewResourceId	string	Id prostředku Purview

systemData

Objekt

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.