Factories - Get

Service:: Data Factory

Version de l’API:: 2018-06-01

Obtient une fabrique.

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

Paramètres d’URI

Nom	Dans	Obligatoire	Type	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nom de la fabrique.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nom du groupe de ressources.
subscriptionId	path	True	string	Identificateur d’abonnement.
api-version	query	True	string	Version de l’API.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-None-Match		string	ETag de l’entité de fabrique. Doit être spécifié uniquement pour obtenir. Si l’ETag correspond à la balise d’entité existante ou si * a été fourni, aucun contenu n’est retourné.

Réponses

Nom	Type	Description
200 OK	Factory	D’ACCORD.
Other Status Codes		Non modifié.
Other Status Codes	CloudError	Réponse d’erreur reçue du service Azure Data Factory.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Couler: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Factories_Get

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
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_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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this DataFactoryResource
DataFactoryCollection collection = resourceGroupResource.GetDataFactories();

// invoke the operation
string factoryName = "exampleFactoryName";
NullableResponse<DataFactoryResource> response = await collection.GetIfExistsAsync(factoryName);
DataFactoryResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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

Exemple de réponse

Code d’état:: 304

Code d’état:: 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"
  }
}

Définitions

Nom	Description
CloudError	Objet qui définit la structure d’une réponse d’erreur Azure Data Factory.
CMKIdentityDefinition	Identité managée utilisée pour CMK.
EncryptionConfiguration	Définition de CMK pour la fabrique.
Factory	Type de ressource de fabrique.
FactoryGitHubConfiguration	Informations sur le dépôt GitHub de Factory.
FactoryIdentity	Propriétés d’identité de la ressource de fabrique.
FactoryIdentityType	Type d’identité.
FactoryVSTSConfiguration	Informations sur le dépôt VSTS de Factory.
GitHubClientSecret	Les informations de clé secrète client pour la configuration de votre propre référentiel d’applications sont fournies par la fabrique.
GlobalParameterSpecification	Définition d’un paramètre unique pour une entité.
GlobalParameterType	Type de paramètre global.
PublicNetworkAccess	Indique si l’accès au réseau public est autorisé pour la fabrique de données.
PurviewConfiguration	Configuration purview.
UserAssignedIdentitySpecification	Définition d’une identité affectée par l’utilisateur unique pour une fabrique.

CloudError

Objet

Objet qui définit la structure d’une réponse d’erreur Azure Data Factory.

Nom	Type	Description
error.code	string	Code d’erreur.
error.details	CloudError[]	Tableau avec des détails d’erreur supplémentaires.
error.message	string	Message d'erreur.
error.target	string	Nom/chemin de propriété dans la requête associée à l’erreur.

CMKIdentityDefinition

Objet

Identité managée utilisée pour CMK.

Nom	Type	Description
userAssignedIdentity	string	ID de ressource de l’identité affectée par l’utilisateur pour s’authentifier auprès du coffre de clés du client.

EncryptionConfiguration

Objet

Définition de CMK pour la fabrique.

Nom	Type	Description
identity	CMKIdentityDefinition	Identité affectée par l’utilisateur à utiliser pour s’authentifier auprès du coffre de clés du client. Si aucune identité de service managée n’est fournie, elle est utilisée.
keyName	string	Nom de la clé dans Azure Key Vault à utiliser comme clé gérée par le client.
keyVersion	string	Version de la clé utilisée pour CMK. S’il n’est pas fourni, la dernière version sera utilisée.
vaultBaseUrl	string	URL d’Azure Key Vault utilisée pour CMK.

Factory

Objet

Type de ressource de fabrique.

Nom	Type	Description
eTag	string	Etag identifie les modifications dans la ressource.
id	string	Identificateur de ressource.
identity	FactoryIdentity	Identité du service managé de la fabrique.
location	string	Emplacement de la ressource.
name	string	Nom de la ressource.
properties.createTime	string (date-time)	Heure de création de la fabrique au format ISO8601.
properties.encryption	EncryptionConfiguration	Propriétés permettant d’activer la clé gérée par le client pour la fabrique.
properties.globalParameters	<string, GlobalParameterSpecification>	Liste des paramètres pour la fabrique.
properties.provisioningState	string	État d’approvisionnement d’usine, exemple Réussi.
properties.publicNetworkAccess	PublicNetworkAccess	Indique si l’accès au réseau public est autorisé pour la fabrique de données.
properties.purviewConfiguration	PurviewConfiguration	Informations Purview de la fabrique.
properties.repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Informations sur le dépôt Git de la fabrique.
properties.version	string	Version de la fabrique.
tags	object	Balises de ressource.
type	string	Type de ressource.

FactoryGitHubConfiguration

Objet

Informations sur le dépôt GitHub de Factory.

Nom	Type	Description
accountName	string	Nom du compte.
clientId	string	GitHub apporte votre propre ID client d’application.
clientSecret	GitHubClientSecret	GitHub apporte vos propres informations de clé secrète client d’application.
collaborationBranch	string	Branche de collaboration.
disablePublish	boolean	Désactivez l’opération de publication manuelle dans ADF Studio pour favoriser la publication automatisée.
hostName	string	Nom d’hôte GitHub Enterprise. Par exemple : `https://github.mydomain.com`
lastCommitId	string	Dernier ID de validation.
repositoryName	string	Nom du référentiel.
rootFolder	string	Dossier racine.
type	string: FactoryGitHubConfiguration	Type de configuration du dépôt.

FactoryIdentity

Objet

Propriétés d’identité de la ressource de fabrique.

Nom	Type	Description
principalId	string (uuid)	ID principal de l’identité.
tenantId	string (uuid)	ID de locataire client de l’identité.
type	FactoryIdentityType	Type d’identité.
userAssignedIdentities	<string, UserAssignedIdentitySpecification>	Liste des identités affectées par l’utilisateur pour la fabrique.

FactoryIdentityType

Énumération

Type d’identité.

Valeur	Description
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

FactoryVSTSConfiguration

Objet

Informations sur le dépôt VSTS de Factory.

Nom	Type	Description
accountName	string	Nom du compte.
collaborationBranch	string	Branche de collaboration.
disablePublish	boolean	Désactivez l’opération de publication manuelle dans ADF Studio pour favoriser la publication automatisée.
lastCommitId	string	Dernier ID de validation.
projectName	string	Nom du projet VSTS.
repositoryName	string	Nom du référentiel.
rootFolder	string	Dossier racine.
tenantId	string	ID de locataire VSTS.
type	string: FactoryVSTSConfiguration	Type de configuration du dépôt.

GitHubClientSecret

Objet

Les informations de clé secrète client pour la configuration de votre propre référentiel d’applications sont fournies par la fabrique.

Nom	Type	Description
byoaSecretAkvUrl	string	Apportez votre propre URL AKV de secret client d’application.
byoaSecretName	string	Apportez votre propre nom de clé secrète client d’application dans AKV.

GlobalParameterSpecification

Objet

Définition d’un paramètre unique pour une entité.

Nom	Type	Description
type	GlobalParameterType	Type de paramètre global.
value	object	Valeur du paramètre.

GlobalParameterType

Énumération

Type de paramètre global.

Valeur	Description
Object
String
Int
Float
Bool
Array

PublicNetworkAccess

Énumération

Indique si l’accès au réseau public est autorisé pour la fabrique de données.

Valeur	Description
Enabled
Disabled

PurviewConfiguration

Objet

Configuration purview.

Nom	Type	Description
purviewResourceId	string	ID de ressource Purview.

UserAssignedIdentitySpecification

Objet

Définition d’une identité affectée par l’utilisateur unique pour une fabrique.

Partager via

Factories - Get

Paramètres d’URI

En-tête de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

Factories_Get

Demande d’échantillon

Exemple de réponse

Définitions

CloudError

CMKIdentityDefinition

EncryptionConfiguration

Factory

FactoryGitHubConfiguration

FactoryIdentity

FactoryIdentityType

FactoryVSTSConfiguration

GitHubClientSecret

GlobalParameterSpecification

GlobalParameterType

PublicNetworkAccess

PurviewConfiguration

UserAssignedIdentitySpecification