Factories - Get Git Hub Access Token

Dienst:

Data Factory

API-Version:

2018-06-01

Abrufen des GitHub-Zugriffstokens.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Der Werksname.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Der Ressourcengruppenname.
subscriptionId	path	True	string	Der Abonnementbezeichner.
api-version	query	True	string	Die API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
gitHubAccessCode	True	string	GitHub-Zugriffscode.
gitHubAccessTokenBaseUrl	True	string	GitHub-Zugriffstokenbasis-URL.
gitHubClientId		string	GitHub-Anwendungsclient-ID.
gitHubClientSecret		GitHubClientSecret	GitHub bringt Ihre eigenen geheimen Informationen zum App-Clientschlüssel mit.

Antworten

Name	Typ	Beschreibung
200 OK	GitHubAccessTokenResponse	OKAY.
Other Status Codes	CloudError	Eine Fehlerantwort, die vom Azure Data Factory-Dienst empfangen wurde.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Factories_GetGitHubAccessToken

Beispielanforderung

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

Java

import com.azure.resourcemanager.datafactory.models.GitHubAccessTokenRequest;

/**
 * Samples for Factories GetGitHubAccessToken.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * Factories_GetGitHubAccessToken.json
     */
    /**
     * Sample code: Factories_GetGitHubAccessToken.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void factoriesGetGitHubAccessToken(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.factories().getGitHubAccessTokenWithResponse("exampleResourceGroup", "exampleFactoryName",
            new GitHubAccessTokenRequest().withGitHubAccessCode("fakeTokenPlaceholder").withGitHubClientId("some")
                .withGitHubAccessTokenBaseUrl("fakeTokenPlaceholder"),
            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_git_hub_access_token.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_git_hub_access_token(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        git_hub_access_token_request={
            "gitHubAccessCode": "some",
            "gitHubAccessTokenBaseUrl": "some",
            "gitHubClientId": "some",
        },
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_GetGitHubAccessToken.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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datafactory/armdatafactory/v10"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/8eb3f7a4f66d408152c32b9d647e59147172d533/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_GetGitHubAccessToken.json
func ExampleFactoriesClient_GetGitHubAccessToken() {
	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().GetGitHubAccessToken(ctx, "exampleResourceGroup", "exampleFactoryName", armdatafactory.GitHubAccessTokenRequest{
		GitHubAccessCode:         to.Ptr("some"),
		GitHubAccessTokenBaseURL: to.Ptr("some"),
		GitHubClientID:           to.Ptr("some"),
	}, 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.GitHubAccessTokenResponse = armdatafactory.GitHubAccessTokenResponse{
	// 	GitHubAccessToken: to.Ptr("myAccessTokenExample"),
	// }
}

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 Get GitHub Access Token.
 *
 * @summary Get GitHub Access Token.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_GetGitHubAccessToken.json
 */
async function factoriesGetGitHubAccessToken() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const gitHubAccessTokenRequest = {
    gitHubAccessCode: "some",
    gitHubAccessTokenBaseUrl: "some",
    gitHubClientId: "some",
  };
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.factories.getGitHubAccessToken(
    resourceGroupName,
    factoryName,
    gitHubAccessTokenRequest,
  );
  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_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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
CloudError	Das Objekt, das die Struktur einer Azure Data Factory-Fehlerantwort definiert.
GitHubAccessTokenRequest	Abrufen der GitHub-Zugriffstokenanforderungsdefinition.
GitHubAccessTokenResponse	Abrufen der Antwortdefinition des GitHub-Zugriffstokens.
GitHubClientSecret	Geheime Clientschlüsselinformationen für die Factory bringen Ihre eigene App-Repositorykonfiguration mit.

CloudError

Objekt

Das Objekt, das die Struktur einer Azure Data Factory-Fehlerantwort definiert.

Name	Typ	Beschreibung
error.code	string	Fehlercode.
error.details	CloudError[]	Array mit zusätzlichen Fehlerdetails.
error.message	string	Fehlermeldung.
error.target	string	Eigenschaftsname/Pfad in Anforderung, die fehler zugeordnet ist.

GitHubAccessTokenRequest

Objekt

Abrufen der GitHub-Zugriffstokenanforderungsdefinition.

Name	Typ	Beschreibung
gitHubAccessCode	string	GitHub-Zugriffscode.
gitHubAccessTokenBaseUrl	string	GitHub-Zugriffstokenbasis-URL.
gitHubClientId	string	GitHub-Anwendungsclient-ID.
gitHubClientSecret	GitHubClientSecret	GitHub bringt Ihre eigenen geheimen Informationen zum App-Clientschlüssel mit.

GitHubAccessTokenResponse

Objekt

Abrufen der Antwortdefinition des GitHub-Zugriffstokens.

Name	Typ	Beschreibung
gitHubAccessToken	string	GitHub-Zugriffstoken.

GitHubClientSecret

Objekt

Geheime Clientschlüsselinformationen für die Factory bringen Ihre eigene App-Repositorykonfiguration mit.

Name	Typ	Beschreibung
byoaSecretAkvUrl	string	Bringen Sie Ihre eigene geheime AKV-URL des App-Clientschlüssels mit.
byoaSecretName	string	Bringen Sie Ihren eigenen geheimen App-Clientschlüsselnamen in AKV ein.