Factories - Get

Usługa:: Data Factory

Wersja interfejsu API:: 2018-06-01

Pobiera fabrykę.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nazwa fabryki.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nazwa grupy zasobów.
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-None-Match		string	Element ETag jednostki fabryki. Należy określić tylko polecenie get. Jeśli element ETag pasuje do istniejącego tagu jednostki lub jeśli * został podany, nie zostanie zwrócona żadna zawartość.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Factory	OK.
Other Status Codes		Niezmodyfikowane.
Other Status Codes	CloudError	Odebrano odpowiedź o błędzie z usługi Azure Data Factory.

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

Zakresów

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Przykładowa odpowiedź

Kod stanu:: 304

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

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.
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.
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.
UserAssignedIdentitySpecification	Definicja tożsamości przypisanej przez jednego użytkownika dla fabryki.

CloudError

Sprzeciwiać się

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

Sprzeciwiać się

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.

EncryptionConfiguration

Sprzeciwiać się

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

Sprzeciwiać się

Typ zasobu fabryki.

Nazwa	Typ	Opis
eTag	string	Element Etag identyfikuje zmiany w zasobie.
id	string	Identyfikator zasobu.
identity	FactoryIdentity	Tożsamość usługi zarządzanej fabryki.
location	string	Lokalizacja zasobu.
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.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

FactoryGitHubConfiguration

Sprzeciwiać się

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

Sprzeciwiać się

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	<string, UserAssignedIdentitySpecification>	Lista tożsamości przypisanych przez użytkownika dla fabryki.

FactoryIdentityType

Wyliczenie

Typ tożsamości.

Wartość	Opis
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

FactoryVSTSConfiguration

Sprzeciwiać się

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

Sprzeciwiać się

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

Sprzeciwiać się

Definicja pojedynczego parametru dla jednostki.

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

GlobalParameterType

Wyliczenie

Globalny typ parametru.

Wartość	Opis
Object
String
Int
Float
Bool
Array

PublicNetworkAccess

Wyliczenie

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

Wartość	Opis
Enabled
Disabled

PurviewConfiguration

Sprzeciwiać się

Konfiguracja usługi Purview.

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

UserAssignedIdentitySpecification

Sprzeciwiać się

Definicja tożsamości przypisanej przez jednego użytkownika dla fabryki.

Udostępnij przez

Factories - Get

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresów

Przykłady

Factories_Get

Przykładowe zapytanie

Przykładowa odpowiedź

Definicje

CloudError

CMKIdentityDefinition

EncryptionConfiguration

Factory

FactoryGitHubConfiguration

FactoryIdentity

FactoryIdentityType

FactoryVSTSConfiguration

GitHubClientSecret

GlobalParameterSpecification

GlobalParameterType

PublicNetworkAccess

PurviewConfiguration

UserAssignedIdentitySpecification