Factories - Get

Dienst:

Data Factory

API-Version:

2018-06-01

Ruft eine Factory ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Der Werksname.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Der Ressourcengruppenname.
subscriptionId	path	True	string	Der Abonnementbezeichner.
api-version	query	True	string	Die API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-None-Match		string	ETag der Factoryentität. Sollte nur für get angegeben werden. Wenn das ETag mit dem vorhandenen Entitätstag übereinstimmt oder wenn * angegeben wurde, werden keine Inhalte zurückgegeben.

Antworten

Name	Typ	Beschreibung
200 OK	Factory	OKAY.
Other Status Codes		Nicht geändert.
Other Status Codes	CloudError	Eine Fehlerantwort, die vom Azure Data Factory-Dienst empfangen wurde.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Factories_Get

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName?api-version=2018-06-01

Java

/**
 * Samples for Factories GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Get.json
     */
    /**
     * Sample code: Factories_Get.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void factoriesGet(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.factories().getByResourceGroupWithResponse("exampleResourceGroup", "exampleFactoryName", null,
            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_get.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.get(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Get.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/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_Get.json
func ExampleFactoriesClient_Get() {
	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().Get(ctx, "exampleResourceGroup", "exampleFactoryName", &armdatafactory.FactoriesClientGetOptions{IfNoneMatch: 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("\"00004004-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"),
	// 		PurviewConfiguration: &armdatafactory.PurviewConfiguration{
	// 			PurviewResourceID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Purview/accounts/examplePurview"),
	// 		},
	// 		RepoConfiguration: &armdatafactory.FactoryVSTSConfiguration{
	// 			Type: to.Ptr("FactoryVSTSConfiguration"),
	// 			AccountName: to.Ptr("ADF"),
	// 			CollaborationBranch: to.Ptr("master"),
	// 			LastCommitID: to.Ptr(""),
	// 			RepositoryName: to.Ptr("repo"),
	// 			RootFolder: to.Ptr("/"),
	// 			ProjectName: to.Ptr("project"),
	// 			TenantID: to.Ptr(""),
	// 		},
	// 		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 Gets a factory.
 *
 * @summary Gets a factory.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_Get.json
 */
async function factoriesGet() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.factories.get(resourceGroupName, factoryName);
  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_Get.json
// this example is just showing the usage of "Factories_Get" 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
DataFactoryResource result = await dataFactory.GetAsync();

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

Beispiel für eine Antwort

Statuscode:

304

Statuscode:

200

Date: Tue, 19 Jun 2018 05:41:50 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14994
x-ms-request-id: d84e59aa-718c-4b1a-951c-076ffff766c8
x-ms-correlation-request-id: d84e59aa-718c-4b1a-951c-076ffff766c8

{
  "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",
    "purviewConfiguration": {
      "purviewResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Purview/accounts/examplePurview"
    },
    "repoConfiguration": {
      "type": "FactoryVSTSConfiguration",
      "projectName": "project",
      "tenantId": "",
      "accountName": "ADF",
      "repositoryName": "repo",
      "collaborationBranch": "master",
      "rootFolder": "/",
      "lastCommitId": ""
    }
  },
  "eTag": "\"00004004-0000-0000-0000-5b28979e0000\"",
  "location": "East US",
  "tags": {
    "exampleTag": "exampleValue"
  }
}

Definitionen

Name	Beschreibung
CloudError	Das Objekt, das die Struktur einer Azure Data Factory-Fehlerantwort definiert.
CMKIdentityDefinition	Verwaltete Identität, die für CMK verwendet wird.
EncryptionConfiguration	Definition von CMK für die Fabrik.
Factory	Factory-Ressourcentyp.
FactoryGitHubConfiguration	GitHub-Repositoryinformationen der Factory.
FactoryIdentity	Identitätseigenschaften der Factoryressource.
FactoryIdentityType	Der Identitätstyp.
FactoryVSTSConfiguration	VSTS-Repositoryinformationen der Factory.
GitHubClientSecret	Geheime Clientschlüsselinformationen für die Factory bringen Ihre eigene App-Repositorykonfiguration mit.
GlobalParameterSpecification	Definition eines einzelnen Parameters für eine Entität.
GlobalParameterType	Globaler Parametertyp.
PublicNetworkAccess	Gibt an, ob der Zugriff auf öffentliche Netzwerke für die Datenfactory zulässig ist.
PurviewConfiguration	Purview-Konfiguration.
UserAssignedIdentitySpecification	Definition einer einzelnen zugewiesenen Identität eines Benutzers für eine Factory.

CloudError

Objekt

Das Objekt, das die Struktur einer Azure Data Factory-Fehlerantwort definiert.

Name	Typ	Beschreibung
error.code	string	Fehlercode.
error.details	CloudError[]	Array mit zusätzlichen Fehlerdetails.
error.message	string	Fehlermeldung.
error.target	string	Eigenschaftsname/Pfad in Anforderung, die fehler zugeordnet ist.

CMKIdentityDefinition

Objekt

Verwaltete Identität, die für CMK verwendet wird.

Name	Typ	Beschreibung
userAssignedIdentity	string	Die Ressourcen-ID der vom Benutzer zugewiesenen Identität zur Authentifizierung beim Schlüsseltresor des Kunden.

EncryptionConfiguration

Objekt

Definition von CMK für die Fabrik.

Name	Typ	Beschreibung
identity	CMKIdentityDefinition	Dem Benutzer zugewiesene Identität, die für die Authentifizierung beim Schlüsseltresor des Kunden verwendet werden soll. Wenn keine verwaltete Dienstidentität verwendet wird.
keyName	string	Der Name des Schlüssels in Azure Key Vault, der als vom Kunden verwalteter Schlüssel verwendet werden soll.
keyVersion	string	Die Version des für CMK verwendeten Schlüssels. Falls nicht angegeben, wird die neueste Version verwendet.
vaultBaseUrl	string	Die URL des azure Key Vault, der für CMK verwendet wird.

Factory

Objekt

Factory-Ressourcentyp.

Name	Typ	Beschreibung
eTag	string	Etag identifiziert Änderungen in der Ressource.
id	string	Der Ressourcenbezeichner.
identity	FactoryIdentity	Verwaltete Dienstidentität der Factory.
location	string	Der Ressourcenspeicherort.
name	string	Der Ressourcenname.
properties.createTime	string (date-time)	Der Zeitpunkt, zu dem die Factory im ISO8601 Format erstellt wurde.
properties.encryption	EncryptionConfiguration	Eigenschaften zum Aktivieren des vom Kunden verwalteten Schlüssels für die Factory.
properties.globalParameters	<string,  GlobalParameterSpecification>	Liste der Parameter für die Factory.
properties.provisioningState	string	Factorybereitstellungsstatus, Beispiel erfolgreich.
properties.publicNetworkAccess	PublicNetworkAccess	Gibt an, ob der Zugriff auf öffentliche Netzwerke für die Datenfactory zulässig ist.
properties.purviewConfiguration	PurviewConfiguration	Bereinigungsinformationen der Fabrik.
properties.repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Git-Repositoryinformationen der Factory.
properties.version	string	Version der Factory.
tags	object	Die Ressourcentags.
type	string	Der Ressourcentyp.

FactoryGitHubConfiguration

Objekt

GitHub-Repositoryinformationen der Factory.

Name	Typ	Beschreibung
accountName	string	Kontenbezeichnung.
clientId	string	GitHub bringt Ihre eigene App-Client-ID mit.
clientSecret	GitHubClientSecret	GitHub bringt Ihre eigenen geheimen Informationen zum App-Clientschlüssel mit.
collaborationBranch	string	Verzweigung für die Zusammenarbeit.
disablePublish	boolean	Deaktivieren Sie den manuellen Veröffentlichungsvorgang in ADF Studio, um die automatisierte Veröffentlichung zu bevorzugen.
hostName	string	GitHub Enterprise-Hostname. Beispiel: https://github.mydomain.com
lastCommitId	string	Letzte Commit-ID.
repositoryName	string	Repositoryname.
rootFolder	string	Stammordner.
type	string: FactoryGitHubConfiguration	Typ der Repositorykonfiguration.

FactoryIdentity

Objekt

Identitätseigenschaften der Factoryressource.

Name	Typ	Beschreibung
principalId	string (uuid)	Die Prinzipal-ID der Identität.
tenantId	string (uuid)	Die Clientmandanten-ID der Identität.
type	FactoryIdentityType	Der Identitätstyp.
userAssignedIdentities	<string,  UserAssignedIdentitySpecification>	Liste der vom Benutzer zugewiesenen Identitäten für die Factory.

FactoryIdentityType

Enumeration

Der Identitätstyp.

Wert	Beschreibung
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

FactoryVSTSConfiguration

Objekt

VSTS-Repositoryinformationen der Factory.

Name	Typ	Beschreibung
accountName	string	Kontenbezeichnung.
collaborationBranch	string	Verzweigung für die Zusammenarbeit.
disablePublish	boolean	Deaktivieren Sie den manuellen Veröffentlichungsvorgang in ADF Studio, um die automatisierte Veröffentlichung zu bevorzugen.
lastCommitId	string	Letzte Commit-ID.
projectName	string	VSTS-Projektname.
repositoryName	string	Repositoryname.
rootFolder	string	Stammordner.
tenantId	string	VSTS-Mandanten-ID.
type	string: FactoryVSTSConfiguration	Typ der Repositorykonfiguration.

GitHubClientSecret

Objekt

Geheime Clientschlüsselinformationen für die Factory bringen Ihre eigene App-Repositorykonfiguration mit.

Name	Typ	Beschreibung
byoaSecretAkvUrl	string	Bringen Sie Ihre eigene geheime AKV-URL des App-Clientschlüssels mit.
byoaSecretName	string	Bringen Sie Ihren eigenen geheimen App-Clientschlüsselnamen in AKV ein.

GlobalParameterSpecification

Objekt

Definition eines einzelnen Parameters für eine Entität.

Name	Typ	Beschreibung
type	GlobalParameterType	Globaler Parametertyp.
value	object	Wert des Parameters.

GlobalParameterType

Enumeration

Globaler Parametertyp.

Wert	Beschreibung
Array
Bool
Float
Int
Object
String

PublicNetworkAccess

Enumeration

Gibt an, ob der Zugriff auf öffentliche Netzwerke für die Datenfactory zulässig ist.

Wert	Beschreibung
Disabled
Enabled

PurviewConfiguration

Objekt

Purview-Konfiguration.

Name	Typ	Beschreibung
purviewResourceId	string	Purview-Ressourcen-ID.

UserAssignedIdentitySpecification

Objekt

Definition einer einzelnen zugewiesenen Identität eines Benutzers für eine Factory.