Factories - Get Git Hub Access Token

Usługa:

Data Factory

Wersja interfejsu API:

2018-06-01

Pobierz token dostępu usługi GitHub.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getGitHubAccessToken?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.

Treść żądania

Nazwa	Wymagane	Typ	Opis
gitHubAccessCode	True	string	Kod dostępu usługi GitHub.
gitHubAccessTokenBaseUrl	True	string	Podstawowy adres URL tokenu dostępu usługi GitHub.
gitHubClientId		string	Identyfikator klienta aplikacji usługi GitHub.
gitHubClientSecret		GitHubClientSecret	Usługa GitHub dostarcza własne informacje o wpisie tajnym klienta aplikacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GitHubAccessTokenResponse	OK.
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_GetGitHubAccessToken

Przykładowe zapytanie

HTTP

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

{
  "gitHubAccessCode": "some",
  "gitHubClientId": "some",
  "gitHubAccessTokenBaseUrl": "some"
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.DataFactory;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/examples/Factories_GetGitHubAccessToken.json
// this example is just showing the usage of "Factories_GetGitHubAccessToken" 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
GitHubAccessTokenContent content = new GitHubAccessTokenContent("some", new Uri("some"))
{
    GitHubClientId = "some",
};
GitHubAccessTokenResult result = await dataFactory.GetGitHubAccessTokenAsync(content);

Console.WriteLine($"Succeeded: {result}");

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:

200

Date: Fri, 7 Sep 2018 18:42:45 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 1199
x-ms-request-id: da630ed9-35e4-41cd-9f93-be14dbcbd099
x-ms-correlation-request-id: da630ed9-35e4-41cd-9f93-be14dbcbd099

{
  "gitHubAccessToken": "myAccessTokenExample"
}

Definicje

Nazwa	Opis
CloudError	Obiekt, który definiuje strukturę odpowiedzi błędu usługi Azure Data Factory.
GitHubAccessTokenRequest	Pobierz definicję żądania tokenu dostępu usługi GitHub.
GitHubAccessTokenResponse	Pobierz definicję odpowiedzi tokenu dostępu usługi GitHub.
GitHubClientSecret	Informacje o wpisie tajnym klienta dla konfiguracji repozytorium aplikacji bring your own app.

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.

GitHubAccessTokenRequest

Sprzeciwiać się

Pobierz definicję żądania tokenu dostępu usługi GitHub.

Nazwa	Typ	Opis
gitHubAccessCode	string	Kod dostępu usługi GitHub.
gitHubAccessTokenBaseUrl	string	Podstawowy adres URL tokenu dostępu usługi GitHub.
gitHubClientId	string	Identyfikator klienta aplikacji usługi GitHub.
gitHubClientSecret	GitHubClientSecret	Usługa GitHub dostarcza własne informacje o wpisie tajnym klienta aplikacji.

GitHubAccessTokenResponse

Sprzeciwiać się

Pobierz definicję odpowiedzi tokenu dostępu usługi GitHub.

Nazwa	Typ	Opis
gitHubAccessToken	string	Token dostępu usługi GitHub.

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.