Factories - Configure Factory Repo

Layanan:: Data Factory

Versi API:: 2018-06-01

Memperbarui informasi repositori pabrik.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
locationId	path	True	string	Pengidentifikasi lokasi.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
factoryResourceId	string	Id sumber daya pabrik.
repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Informasi repositori Git dari pabrik.

Respons

Nama	Jenis	Deskripsi
200 OK	Factory	Permintaan telah berhasil.
Other Status Codes	CloudError	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Factories_ConfigureFactoryRepo

Permintaan sampel

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

Respon sampel

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

Definisi

Nama	Deskripsi
CloudError	Objek yang menentukan struktur respons kesalahan Azure Data Factory.
CMKIdentityDefinition	Identitas Terkelola yang digunakan untuk CMK.
createdByType	Jenis identitas yang membuat sumber daya.
EncryptionConfiguration	Definisi CMK untuk pabrik.
Factory	Jenis sumber daya pabrik.
FactoryGitHubConfiguration	Informasi repositori GitHub Pabrik.
FactoryIdentity	Properti identitas sumber daya pabrik.
FactoryIdentityType	Jenis identitas.
FactoryRepoUpdate	Informasi repositori git Factory.
FactoryVSTSConfiguration	Informasi repositori VSTS Factory.
GitHubClientSecret	Informasi rahasia klien untuk konfigurasi repositori aplikasi Anda sendiri.
GlobalParameterSpecification	Definisi parameter tunggal untuk entitas.
GlobalParameterType	Jenis Parameter Global.
PublicNetworkAccess	Apakah akses jaringan publik diizinkan atau tidak untuk pabrik data.
PurviewConfiguration	Konfigurasi Purview.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

CloudError

Objek

Objek yang menentukan struktur respons kesalahan Azure Data Factory.

Nama	Jenis	Deskripsi
error.code	string	Kode kesalahan.
error.details	CloudError[]	Array dengan detail kesalahan tambahan.
error.message	string	Pesan kesalahan.
error.target	string	Nama/jalur properti dalam permintaan yang terkait dengan kesalahan.

CMKIdentityDefinition

Objek

Identitas Terkelola yang digunakan untuk CMK.

Nama	Jenis	Deskripsi
userAssignedIdentity	string	Id sumber daya identitas yang ditetapkan pengguna untuk mengautentikasi ke brankas kunci pelanggan.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

EncryptionConfiguration

Objek

Definisi CMK untuk pabrik.

Nama	Jenis	Deskripsi
identity	CMKIdentityDefinition	Identitas yang ditetapkan pengguna untuk digunakan untuk mengautentikasi ke brankas kunci pelanggan. Jika tidak diberikan Identitas Layanan Terkelola akan digunakan.
keyName	string	Nama kunci di Azure Key Vault untuk digunakan sebagai Kunci yang Dikelola Pelanggan.
keyVersion	string	Versi kunci yang digunakan untuk CMK. Jika tidak disediakan, versi terbaru akan digunakan.
vaultBaseUrl	string	Url Azure Key Vault yang digunakan untuk CMK.

Factory

Objek

Jenis sumber daya pabrik.

Nama	Jenis	Deskripsi
eTag	string	Jika eTag disediakan dalam isi respons, eTag juga dapat disediakan sebagai header per konvensi etag normal. Tag entitas digunakan untuk membandingkan dua entitas atau lebih dari sumber daya yang diminta yang sama. HTTP/1.1 menggunakan tag entitas di bidang header etag (bagian 14.19), If-Match (bagian 14.24), Jika-None-Match (bagian 14.26), dan If-Range (bagian 14.27).
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	FactoryIdentity	Identitas layanan terkelola pabrik.
location	string	Lokasi geografis tempat sumber daya berada
name	string	Nama sumber daya
properties.createTime	string (date-time)	Waktu pabrik dibuat dalam format ISO8601.
properties.encryption	EncryptionConfiguration	Properti untuk mengaktifkan Kunci Terkelola Pelanggan untuk pabrik.
properties.globalParameters	<string, GlobalParameterSpecification>	Daftar parameter untuk pabrik.
properties.provisioningState	string	Status provisi pabrik, contoh Berhasil.
properties.publicNetworkAccess	PublicNetworkAccess	Apakah akses jaringan publik diizinkan atau tidak untuk pabrik data.
properties.purviewConfiguration	PurviewConfiguration	Informasi Purview pabrik.
properties.repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Informasi repositori Git dari pabrik.
properties.version	string	Versi pabrik.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
tags	object	Tag sumber daya.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

FactoryGitHubConfiguration

Objek

Informasi repositori GitHub Pabrik.

Nama	Jenis	Deskripsi
accountName	string	Nama akun.
clientId	string	GitHub membawa id klien aplikasi Anda sendiri.
clientSecret	GitHubClientSecret	GitHub membawa informasi rahasia klien aplikasi Anda sendiri.
collaborationBranch	string	Cabang kolaborasi.
disablePublish	boolean	Nonaktifkan operasi penerbitan manual di studio ADF untuk mendukung penerbitan otomatis.
hostName	string	Nama host GitHub Enterprise. Misalnya: `https://github.mydomain.com`
lastCommitId	string	Id penerapan terakhir.
repositoryName	string	Nama repositori.
rootFolder	string	Folder akar.
type	string: FactoryGitHubConfiguration	Jenis konfigurasi repositori.

FactoryIdentity

Objek

Properti identitas sumber daya pabrik.

Nama	Jenis	Deskripsi
principalId	string (uuid)	Id utama identitas.
tenantId	string (uuid)	Id penyewa klien identitas.
type	FactoryIdentityType	Jenis identitas.
userAssignedIdentities		Daftar identitas yang ditetapkan pengguna untuk pabrik.

FactoryIdentityType

Enumerasi

Jenis identitas.

Nilai	Deskripsi
SystemAssigned	DitugaskanSistem
UserAssigned	UserAssigned
SystemAssigned,UserAssigned	SistemTugas,Pengguna Ditetapkan

FactoryRepoUpdate

Objek

Informasi repositori git Factory.

Nama	Jenis	Deskripsi
factoryResourceId	string	Id sumber daya pabrik.
repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Informasi repositori Git dari pabrik.

FactoryVSTSConfiguration

Objek

Informasi repositori VSTS Factory.

Nama	Jenis	Deskripsi
accountName	string	Nama akun.
collaborationBranch	string	Cabang kolaborasi.
disablePublish	boolean	Nonaktifkan operasi penerbitan manual di studio ADF untuk mendukung penerbitan otomatis.
lastCommitId	string	Id penerapan terakhir.
projectName	string	Nama proyek VSTS.
repositoryName	string	Nama repositori.
rootFolder	string	Folder akar.
tenantId	string	Id penyewa VSTS.
type	string: FactoryVSTSConfiguration	Jenis konfigurasi repositori.

GitHubClientSecret

Objek

Informasi rahasia klien untuk konfigurasi repositori aplikasi Anda sendiri.

Nama	Jenis	Deskripsi
byoaSecretAkvUrl	string	Bawa URL AKV rahasia klien aplikasi Anda sendiri.
byoaSecretName	string	Bawa nama rahasia klien aplikasi Anda sendiri di AKV.

GlobalParameterSpecification

Objek

Definisi parameter tunggal untuk entitas.

Nama	Jenis	Deskripsi
type	GlobalParameterType	Jenis Parameter Global.
value		Nilai parameter.

GlobalParameterType

Enumerasi

Jenis Parameter Global.

Nilai	Deskripsi
Object	Objek
String	string
Int	Integer
Float	Mengapung
Bool	Bool
Array	Array

PublicNetworkAccess

Enumerasi

Apakah akses jaringan publik diizinkan atau tidak untuk pabrik data.

Nilai	Deskripsi
Enabled	Enabled
Disabled	Nonaktif

PurviewConfiguration

Objek

Konfigurasi Purview.

Nama	Jenis	Deskripsi
purviewResourceId	string	Id sumber daya Purview.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Stempel waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

Bagikan melalui

Factories - Configure Factory Repo

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

Factories_ConfigureFactoryRepo

Permintaan sampel

Respon sampel

Definisi

CloudError

CMKIdentityDefinition

createdByType

EncryptionConfiguration

Factory

FactoryGitHubConfiguration

FactoryIdentity

FactoryIdentityType

FactoryRepoUpdate

FactoryVSTSConfiguration

GitHubClientSecret

GlobalParameterSpecification

GlobalParameterType

PublicNetworkAccess

PurviewConfiguration

systemData