Factories - Get

Serviço:

Data Factory

Versão da API:

2018-06-01

Obtém uma fábrica.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	O nome da fábrica.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	O nome do grupo de recursos.
subscriptionId	path	True	string	O identificador de assinatura.
api-version	query	True	string	A versão da API.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-None-Match		string	ETag da entidade fabril. Só deve ser especificado para get. Se a ETag corresponder à tag de entidade existente, ou se * foi fornecido, nenhum conteúdo será retornado.

Respostas

Name	Tipo	Description
200 OK	Factory	OK.
Other Status Codes		Não modificado.
Other Status Codes	CloudError	Uma resposta de erro recebida do serviço Azure Data Factory.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Factories_Get

Pedido de amostra

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

Resposta da amostra

Código de estado:

304

Código de estado:

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

Definições

Name	Description
CloudError	O objeto que define a estrutura de uma resposta de erro do Azure Data Factory.
CMKIdentityDefinition	Identidade gerenciada usada para CMK.
EncryptionConfiguration	Definição de CMK para a fábrica.
Factory	Tipo de recurso de fábrica.
FactoryGitHubConfiguration	Informações de repositório do GitHub da fábrica.
FactoryIdentity	Propriedades de identidade do recurso de fábrica.
FactoryIdentityType	O tipo de identidade.
FactoryVSTSConfiguration	Informações de repositório VSTS da fábrica.
GitHubClientSecret	Informações secretas do cliente para a configuração do repositório de aplicativos da fábrica.
GlobalParameterSpecification	Definição de um único parâmetro para uma entidade.
GlobalParameterType	Tipo de parâmetro global.
PublicNetworkAccess	Se o acesso à rede pública é permitido ou não para o data factory.
PurviewConfiguration	Configuração de purview.
UserAssignedIdentitySpecification	Definição de uma identidade atribuída a um único usuário para uma fábrica.

CloudError

Object

O objeto que define a estrutura de uma resposta de erro do Azure Data Factory.

Name	Tipo	Description
error.code	string	Código de erro.
error.details	CloudError[]	Matriz com detalhes de erro adicionais.
error.message	string	Mensagem de erro.
error.target	string	Nome/caminho da propriedade na solicitação associada ao erro.

CMKIdentityDefinition

Object

Identidade gerenciada usada para CMK.

Name	Tipo	Description
userAssignedIdentity	string	A ID do recurso da identidade atribuída ao usuário para autenticar no cofre de chaves do cliente.

EncryptionConfiguration

Object

Definição de CMK para a fábrica.

Name	Tipo	Description
identity	CMKIdentityDefinition	Identidade atribuída pelo usuário a ser usada para autenticar no cofre de chaves do cliente. Se não for fornecida, a Identidade do Serviço Gerenciado será usada.
keyName	string	O nome da chave no Cofre de Chaves do Azure a ser usada como Chave Gerenciada pelo Cliente.
keyVersion	string	A versão da chave usada para CMK. Se não for fornecida, será utilizada a versão mais recente.
vaultBaseUrl	string	A url do Cofre da Chave do Azure usado para CMK.

Factory

Object

Tipo de recurso de fábrica.

Name	Tipo	Description
eTag	string	Etag identifica a alteração no recurso.
id	string	O identificador de recurso.
identity	FactoryIdentity	Identidade de serviço gerenciado da fábrica.
location	string	A localização do recurso.
name	string	O nome do recurso.
properties.createTime	string (date-time)	Tempo em que a fábrica foi criada em formato ISO8601.
properties.encryption	EncryptionConfiguration	Propriedades para habilitar a Chave Gerenciada pelo Cliente para a fábrica.
properties.globalParameters	<string,  GlobalParameterSpecification>	Lista de parâmetros para fábrica.
properties.provisioningState	string	Estado de provisionamento de fábrica, exemplo Bem-sucedido.
properties.publicNetworkAccess	PublicNetworkAccess	Se o acesso à rede pública é permitido ou não para o data factory.
properties.purviewConfiguration	PurviewConfiguration	Informações de purview da fábrica.
properties.repoConfiguration	FactoryRepoConfiguration: FactoryGitHubConfiguration FactoryVSTSConfiguration	Git repo informações da fábrica.
properties.version	string	Versão da fábrica.
tags	object	As tags de recurso.
type	string	O tipo de recurso.

FactoryGitHubConfiguration

Object

Informações de repositório do GitHub da fábrica.

Name	Tipo	Description
accountName	string	Nome da conta.
clientId	string	O GitHub traz seu próprio ID de cliente de aplicativo.
clientSecret	GitHubClientSecret	O GitHub traz suas próprias informações secretas do cliente do aplicativo.
collaborationBranch	string	Ramo de colaboração.
disablePublish	boolean	Desative a operação de publicação manual no estúdio ADF para favorecer a publicação automatizada.
hostName	string	Nome do host do GitHub Enterprise. Por exemplo: https://github.mydomain.com
lastCommitId	string	Última confirmação id.
repositoryName	string	Nome do repositório.
rootFolder	string	Pasta raiz.
type	string: FactoryGitHubConfiguration	Tipo de configuração de repo.

FactoryIdentity

Object

Propriedades de identidade do recurso de fábrica.

Name	Tipo	Description
principalId	string (uuid)	O id principal da identidade.
tenantId	string (uuid)	O ID do locatário do cliente da identidade.
type	FactoryIdentityType	O tipo de identidade.
userAssignedIdentities	<string,  UserAssignedIdentitySpecification>	Lista de identidades atribuídas pelo usuário para a fábrica.

FactoryIdentityType

Enumeração

O tipo de identidade.

Valor	Description
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

FactoryVSTSConfiguration

Object

Informações de repositório VSTS da fábrica.

Name	Tipo	Description
accountName	string	Nome da conta.
collaborationBranch	string	Ramo de colaboração.
disablePublish	boolean	Desative a operação de publicação manual no estúdio ADF para favorecer a publicação automatizada.
lastCommitId	string	Última confirmação id.
projectName	string	Nome do projeto VSTS.
repositoryName	string	Nome do repositório.
rootFolder	string	Pasta raiz.
tenantId	string	ID do locatário VSTS.
type	string: FactoryVSTSConfiguration	Tipo de configuração de repo.

GitHubClientSecret

Object

Informações secretas do cliente para a configuração do repositório de aplicativos da fábrica.

Name	Tipo	Description
byoaSecretAkvUrl	string	Traga seu próprio URL AKV secreto do cliente de aplicativo.
byoaSecretName	string	Traga o nome secreto do seu próprio cliente de aplicativo no AKV.

GlobalParameterSpecification

Object

Definição de um único parâmetro para uma entidade.

Name	Tipo	Description
type	GlobalParameterType	Tipo de parâmetro global.
value	object	Valor do parâmetro.

GlobalParameterType

Enumeração

Tipo de parâmetro global.

Valor	Description
Array
Bool
Float
Int
Object
String

PublicNetworkAccess

Enumeração

Se o acesso à rede pública é permitido ou não para o data factory.

Valor	Description
Disabled
Enabled

PurviewConfiguration

Object

Configuração de purview.

Name	Tipo	Description
purviewResourceId	string	ID do recurso Purview.

UserAssignedIdentitySpecification

Object

Definição de uma identidade atribuída a um único usuário para uma fábrica.