Factories - Get

Servicio:

Data Factory

Versión de la API:

2018-06-01

Obtiene un generador.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nombre de fábrica.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Nombre del grupo de recursos.
subscriptionId	path	True	string	Identificador de la suscripción.
api-version	query	True	string	La versión de la API.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-None-Match		string	ETag de la entidad factory. Solo se debe especificar para get. Si el ETag coincide con la etiqueta de entidad existente, o si se proporcionó *, no se devolverá ningún contenido.

Respuestas

Nombre	Tipo	Description
200 OK	Factory	De acuerdo.
Other Status Codes		No modificado.
Other Status Codes	CloudError	Respuesta de error recibida del servicio Azure Data Factory.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Factories_Get

Solicitud de ejemplo

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

Respuesta de muestra

status code:

304

status code:

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

Definiciones

Nombre	Description
CloudError	Objeto que define la estructura de una respuesta de error de Azure Data Factory.
CMKIdentityDefinition	Identidad administrada usada para CMK.
EncryptionConfiguration	Definición de CMK para la fábrica.
Factory	Tipo de recurso factory.
FactoryGitHubConfiguration	Información del repositorio de GitHub de Factory.
FactoryIdentity	Propiedades de identidad del recurso de fábrica.
FactoryIdentityType	Tipo de identidad.
FactoryVSTSConfiguration	Información del repositorio VSTS de Factory.
GitHubClientSecret	Información de secretos de cliente para la configuración del repositorio bring your own app de factory.
GlobalParameterSpecification	Definición de un único parámetro para una entidad.
GlobalParameterType	Tipo de parámetro global.
PublicNetworkAccess	Indica si se permite o no el acceso a la red pública para la factoría de datos.
PurviewConfiguration	Configuración de Purview.
UserAssignedIdentitySpecification	Definición de una identidad asignada por el usuario único para un generador.

CloudError

Object

Objeto que define la estructura de una respuesta de error de Azure Data Factory.

Nombre	Tipo	Description
error.code	string	Código de error.
error.details	CloudError[]	Matriz con detalles de error adicionales.
error.message	string	Mensaje de error.
error.target	string	Nombre o ruta de acceso de propiedad en la solicitud asociada al error.

CMKIdentityDefinition

Object

Identidad administrada usada para CMK.

Nombre	Tipo	Description
userAssignedIdentity	string	Identificador de recurso de la identidad asignada por el usuario para autenticarse en el almacén de claves del cliente.

EncryptionConfiguration

Object

Definición de CMK para la fábrica.

Nombre	Tipo	Description
identity	CMKIdentityDefinition	Identidad asignada por el usuario que se usará para autenticarse en el almacén de claves del cliente. Si no se proporciona Managed Service Identity, se usará.
keyName	string	Nombre de la clave en Azure Key Vault que se usará como clave administrada por el cliente.
keyVersion	string	Versión de la clave usada para CMK. Si no se proporciona, se usará la versión más reciente.
vaultBaseUrl	string	Dirección URL de Azure Key Vault que se usa para CMK.

Factory

Object

Tipo de recurso factory.

Nombre	Tipo	Description
eTag	string	Etag identifica el cambio en el recurso.
id	string	Identificador de recurso.
identity	FactoryIdentity	Identidad de servicio administrada de la factoría.
location	string	Ubicación del recurso.
name	string	Nombre del recurso.
properties.createTime	string (date-time)	Hora en que se creó el generador en formato ISO8601.
properties.encryption	EncryptionConfiguration	Propiedades para habilitar la clave administrada por el cliente para el generador.
properties.globalParameters	<string,  GlobalParameterSpecification>	Lista de parámetros de fábrica.
properties.provisioningState	string	Estado de aprovisionamiento de fábrica, ejemplo Correcto.
properties.publicNetworkAccess	PublicNetworkAccess	Indica si se permite o no el acceso a la red pública para la factoría de datos.
properties.purviewConfiguration	PurviewConfiguration	Información de Purview de la fábrica.
properties.repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Información del repositorio de Git del generador.
properties.version	string	Versión del generador.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso.

FactoryGitHubConfiguration

Object

Información del repositorio de GitHub de Factory.

Nombre	Tipo	Description
accountName	string	Nombre de cuenta.
clientId	string	GitHub traiga su propio identificador de cliente de aplicación.
clientSecret	GitHubClientSecret	GitHub traiga su propia información del secreto de cliente de la aplicación.
collaborationBranch	string	Rama de colaboración.
disablePublish	boolean	Deshabilite la operación de publicación manual en ADF Studio para favorecer la publicación automatizada.
hostName	string	Nombre de host de GitHub Enterprise. Por ejemplo: https://github.mydomain.com
lastCommitId	string	Último identificador de confirmación.
repositoryName	string	Nombre del repositorio.
rootFolder	string	Carpeta raíz.
type	string: FactoryGitHubConfiguration	Tipo de configuración del repositorio.

FactoryIdentity

Object

Propiedades de identidad del recurso de fábrica.

Nombre	Tipo	Description
principalId	string (uuid)	Identificador de entidad de seguridad de la identidad.
tenantId	string (uuid)	Identificador de inquilino del cliente de la identidad.
type	FactoryIdentityType	Tipo de identidad.
userAssignedIdentities	<string,  UserAssignedIdentitySpecification>	Lista de identidades asignadas por el usuario para el generador.

FactoryIdentityType

Enumeración

Tipo de identidad.

Valor	Description
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

FactoryVSTSConfiguration

Object

Información del repositorio VSTS de Factory.

Nombre	Tipo	Description
accountName	string	Nombre de cuenta.
collaborationBranch	string	Rama de colaboración.
disablePublish	boolean	Deshabilite la operación de publicación manual en ADF Studio para favorecer la publicación automatizada.
lastCommitId	string	Último identificador de confirmación.
projectName	string	Nombre del proyecto de VSTS.
repositoryName	string	Nombre del repositorio.
rootFolder	string	Carpeta raíz.
tenantId	string	Identificador de inquilino de VSTS.
type	string: FactoryVSTSConfiguration	Tipo de configuración del repositorio.

GitHubClientSecret

Object

Información de secretos de cliente para la configuración del repositorio bring your own app de factory.

Nombre	Tipo	Description
byoaSecretAkvUrl	string	Traiga su propia dirección URL de AKV del secreto de cliente de la aplicación.
byoaSecretName	string	Traiga su propio nombre de secreto de cliente de aplicación en AKV.

GlobalParameterSpecification

Object

Definición de un único parámetro para una entidad.

Nombre	Tipo	Description
type	GlobalParameterType	Tipo de parámetro global.
value	object	Valor del parámetro.

GlobalParameterType

Enumeración

Tipo de parámetro global.

Valor	Description
Array
Bool
Float
Int
Object
String

PublicNetworkAccess

Enumeración

Indica si se permite o no el acceso a la red pública para la factoría de datos.

Valor	Description
Disabled
Enabled

PurviewConfiguration

Object

Configuración de Purview.

Nombre	Tipo	Description
purviewResourceId	string	Identificador de recurso de Purview.

UserAssignedIdentitySpecification

Object

Definición de una identidad asignada por el usuario único para un generador.