Factories - Get Git Hub Access Token

Service:

Data Factory

Version d'API:

2018-06-01

Obtenez le jeton d’accès GitHub.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
factoryName	path	True	string	Nom de la fabrique. Modèle d’expression régulière: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	Nom du groupe de ressources. Modèle d’expression régulière: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Identificateur de l’abonnement.
api-version	query	True	string	Version de l'API.

Corps de la demande

Nom	Obligatoire	Type	Description
gitHubAccessCode	True	string	Code d’accès GitHub.
gitHubAccessTokenBaseUrl	True	string	URL de base du jeton d’accès GitHub.
gitHubClientId		string	ID client de l’application GitHub.
gitHubClientSecret		GitHubClientSecret	GitHub apporte vos propres informations de secret client d’application.

Réponses

Nom	Type	Description
200 OK	GitHubAccessTokenResponse	OK.
Other Status Codes	CloudError	Réponse d’erreur reçue du service Azure Data Factory.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Factories_GetGitHubAccessToken

Exemple de requête

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/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_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.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Core.Expressions.DataFactory;
using Azure.Identity;
using Azure.ResourceManager.DataFactory.Models;
using Azure.ResourceManager.Resources;
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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
CloudError	Objet qui définit la structure d’une réponse d’erreur Azure Data Factory.
GitHubAccessTokenRequest	Obtenez la définition de demande de jeton d’accès GitHub.
GitHubAccessTokenResponse	Obtenez la définition de réponse du jeton d’accès GitHub.
GitHubClientSecret	Les informations de secret client pour la fabrique apportent votre propre configuration de référentiel d’applications.

CloudError

Objet qui définit la structure d’une réponse d’erreur Azure Data Factory.

Nom	Type	Description
error.code	string	Code d’erreur.
error.details	CloudError[]	Tableau avec des détails d’erreur supplémentaires.
error.message	string	Message d’erreur.
error.target	string	Nom de propriété/chemin d’accès dans la requête associée à l’erreur.

GitHubAccessTokenRequest

Obtenez la définition de demande de jeton d’accès GitHub.

Nom	Type	Description
gitHubAccessCode	string	Code d’accès GitHub.
gitHubAccessTokenBaseUrl	string	URL de base du jeton d’accès GitHub.
gitHubClientId	string	ID client de l’application GitHub.
gitHubClientSecret	GitHubClientSecret	GitHub apporte vos propres informations de secret client d’application.

GitHubAccessTokenResponse

Obtenez la définition de réponse du jeton d’accès GitHub.

Nom	Type	Description
gitHubAccessToken	string	Jeton d’accès GitHub.

GitHubClientSecret

Les informations de secret client pour la fabrique apportent votre propre configuration de référentiel d’applications.

Nom	Type	Description
byoaSecretAkvUrl	string	Apportez votre propre URL AKV de secret client d’application.
byoaSecretName	string	Apportez votre propre nom de secret client d’application dans AKV.