Factories - Configure Factory Repo

Usługa:: Data Factory

Wersja interfejsu API:: 2018-06-01

Aktualizuje informacje o repozytorium fabryki.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
locationId	path	True	string	Identyfikator lokalizacji.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
factoryResourceId	string	Identyfikator zasobu fabryki.
repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Informacje o repozytorium Git fabryki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Factory	Żądanie zakończyło się pomyślnie.
Other Status Codes	CloudError	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Factories_ConfigureFactoryRepo

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
CloudError	Obiekt, który definiuje strukturę odpowiedzi błędu usługi Azure Data Factory.
CMKIdentityDefinition	Tożsamość zarządzana używana na potrzeby klucza zarządzanego.
createdByType	Typ tożsamości, która utworzyła zasób.
EncryptionConfiguration	Definicja klucza CMK dla fabryki.
Factory	Typ zasobu fabryki.
FactoryGitHubConfiguration	Informacje o repozytorium GitHub fabryki.
FactoryIdentity	Właściwości tożsamości zasobu fabryki.
FactoryIdentityType	Typ tożsamości.
FactoryRepoUpdate	Informacje o repozytorium Git fabryki.
FactoryVSTSConfiguration	Informacje o repozytorium VSTS fabryki.
GitHubClientSecret	Informacje o wpisie tajnym klienta dla konfiguracji repozytorium aplikacji bring your own app.
GlobalParameterSpecification	Definicja pojedynczego parametru dla jednostki.
GlobalParameterType	Globalny typ parametru.
PublicNetworkAccess	Niezależnie od tego, czy dostęp do sieci publicznej jest dozwolony dla fabryki danych.
PurviewConfiguration	Konfiguracja usługi Purview.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

CloudError

Objekt

Obiekt, który definiuje strukturę odpowiedzi błędu usługi Azure Data Factory.

Nazwa	Typ	Opis
error.code	string	Kod błędu.
error.details	CloudError[]	Tablica z dodatkowymi szczegółami błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Nazwa/ścieżka właściwości w żądaniu skojarzonym z błędem.

CMKIdentityDefinition

Objekt

Tożsamość zarządzana używana na potrzeby klucza zarządzanego.

Nazwa	Typ	Opis
userAssignedIdentity	string	Identyfikator zasobu tożsamości przypisanej przez użytkownika do uwierzytelniania w magazynie kluczy klienta.

createdByType

Wyliczenie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

EncryptionConfiguration

Objekt

Definicja klucza CMK dla fabryki.

Nazwa	Typ	Opis
identity	CMKIdentityDefinition	Tożsamość przypisana przez użytkownika do użycia do uwierzytelniania w magazynie kluczy klienta. Jeśli tożsamość usługi zarządzanej nie zostanie podana, zostanie użyta.
keyName	string	Nazwa klucza w usłudze Azure Key Vault do użycia jako klucz zarządzany przez klienta.
keyVersion	string	Wersja klucza używanego dla klucza CMK. Jeśli nie zostanie podana, zostanie użyta najnowsza wersja.
vaultBaseUrl	string	Adres URL usługi Azure Key Vault używany na potrzeby klucza zarządzanego przez klienta.

Factory

Objekt

Typ zasobu fabryki.

Nazwa	Typ	Opis
eTag	string	Jeśli element eTag jest podany w treści odpowiedzi, może być również podany jako nagłówek zgodnie z normalną konwencją etag. Tagi jednostek są używane do porównywania co najmniej dwóch jednostek z tego samego żądanego zasobu. Protokół HTTP/1.1 używa tagów jednostek w elemecie etag (sekcja 14.19), If-Match (sekcja 14.24), if-None-Match (sekcja 14.26) i If-Range (sekcja 14.27) pól nagłówka.
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	FactoryIdentity	Tożsamość usługi zarządzanej fabryki.
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.createTime	string (date-time)	Czas utworzenia fabryki w formacie ISO8601.
properties.encryption	EncryptionConfiguration	Właściwości umożliwiające włączenie klucza zarządzanego przez klienta dla fabryki.
properties.globalParameters	<string, GlobalParameterSpecification>	Lista parametrów fabryki.
properties.provisioningState	string	Stan aprowizacji fabryki, na przykład Powodzenie.
properties.publicNetworkAccess	PublicNetworkAccess	Niezależnie od tego, czy dostęp do sieci publicznej jest dozwolony dla fabryki danych.
properties.purviewConfiguration	PurviewConfiguration	Informacje o fabryce w usłudze Purview.
properties.repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Informacje o repozytorium Git fabryki.
properties.version	string	Wersja fabryki.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

FactoryGitHubConfiguration

Objekt

Informacje o repozytorium GitHub fabryki.

Nazwa	Typ	Opis
accountName	string	Nazwa konta.
clientId	string	Usługa GitHub przynieś własny identyfikator klienta aplikacji.
clientSecret	GitHubClientSecret	Usługa GitHub dostarcza własne informacje o wpisie tajnym klienta aplikacji.
collaborationBranch	string	Gałąź współpracy.
disablePublish	boolean	Wyłącz ręczną operację publikowania w programie ADF Studio, aby faworyzować automatyczne publikowanie.
hostName	string	Nazwa hosta usługi GitHub Enterprise. Na przykład: `https://github.mydomain.com`
lastCommitId	string	Identyfikator ostatniego zatwierdzenia.
repositoryName	string	Nazwa repozytorium.
rootFolder	string	Folder główny.
type	string: FactoryGitHubConfiguration	Typ konfiguracji repozytorium.

FactoryIdentity

Objekt

Właściwości tożsamości zasobu fabryki.

Nazwa	Typ	Opis
principalId	string (uuid)	Identyfikator podmiotu zabezpieczeń tożsamości.
tenantId	string (uuid)	Identyfikator dzierżawy klienta tożsamości.
type	FactoryIdentityType	Typ tożsamości.
userAssignedIdentities		Lista tożsamości przypisanych przez użytkownika dla fabryki.

FactoryIdentityType

Wyliczenie

Typ tożsamości.

Wartość	Opis
SystemAssigned	SystemowoPrzydzielony
UserAssigned	UserAssigned
SystemAssigned,UserAssigned	SystemPrzypisany,Przypisany przez użytkownika

FactoryRepoUpdate

Objekt

Informacje o repozytorium Git fabryki.

Nazwa	Typ	Opis
factoryResourceId	string	Identyfikator zasobu fabryki.
repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Informacje o repozytorium Git fabryki.

FactoryVSTSConfiguration

Objekt

Informacje o repozytorium VSTS fabryki.

Nazwa	Typ	Opis
accountName	string	Nazwa konta.
collaborationBranch	string	Gałąź współpracy.
disablePublish	boolean	Wyłącz ręczną operację publikowania w programie ADF Studio, aby faworyzować automatyczne publikowanie.
lastCommitId	string	Identyfikator ostatniego zatwierdzenia.
projectName	string	Nazwa projektu usługi VSTS.
repositoryName	string	Nazwa repozytorium.
rootFolder	string	Folder główny.
tenantId	string	Identyfikator dzierżawy usługi VSTS.
type	string: FactoryVSTSConfiguration	Typ konfiguracji repozytorium.

GitHubClientSecret

Objekt

Informacje o wpisie tajnym klienta dla konfiguracji repozytorium aplikacji bring your own app.

Nazwa	Typ	Opis
byoaSecretAkvUrl	string	Bring your own app client secret AKV URL (Używanie własnego adresu URL klucza tajnego klienta aplikacji).
byoaSecretName	string	Używanie własnej nazwy wpisu tajnego klienta aplikacji w usłudze AKV.

GlobalParameterSpecification

Objekt

Definicja pojedynczego parametru dla jednostki.

Nazwa	Typ	Opis
type	GlobalParameterType	Globalny typ parametru.
value		Wartość parametru.

GlobalParameterType

Wyliczenie

Globalny typ parametru.

Wartość	Opis
Object	Obiekt
String	Sznurek
Int	int
Float	Obrót
Bool	Bool
Array	Tablica

PublicNetworkAccess

Wyliczenie

Niezależnie od tego, czy dostęp do sieci publicznej jest dozwolony dla fabryki danych.

Wartość	Opis
Enabled	Enabled
Disabled	Wyłączony

PurviewConfiguration

Objekt

Konfiguracja usługi Purview.

Nazwa	Typ	Opis
purviewResourceId	string	Identyfikator zasobu usługi Purview.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Factories - Configure Factory Repo

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Factories_ConfigureFactoryRepo

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CloudError

CMKIdentityDefinition

createdByType

EncryptionConfiguration

Factory

FactoryGitHubConfiguration

FactoryIdentity

FactoryIdentityType

FactoryRepoUpdate

FactoryVSTSConfiguration

GitHubClientSecret

GlobalParameterSpecification

GlobalParameterType

PublicNetworkAccess

PurviewConfiguration

systemData