Factories - Get Data Plane Access

Référence

Service:: Data Factory

Version d'API:: 2018-06-01

Obtenir l’accès au plan de données.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getDataPlaneAccess?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	Type	Description
accessResourcePath	string	Chemin d’accès aux ressources pour obtenir l’accès par rapport à la fabrique. Actuellement, seule la chaîne vide est prise en charge, ce qui correspond à la ressource de fabrique.
expireTime	string	Heure d’expiration du jeton. La durée maximale du jeton est de huit heures et, par défaut, le jeton expirera dans huit heures.
permissions	string	Chaîne avec des autorisations pour l’accès au plan de données. Actuellement, seul « r » est pris en charge, ce qui accorde l’accès en lecture seule.
profileName	string	Nom du profil. Actuellement, seule la valeur par défaut est prise en charge. La valeur par défaut est DefaultProfile.
startTime	string	Heure de début du jeton. Si elle n’est pas spécifiée, l’heure actuelle sera utilisée.

Réponses

Nom	Type	Description
200 OK	AccessPolicyResponse	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_GetDataPlaneAccess

Exemple de requête

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

{
  "permissions": "r",
  "accessResourcePath": "",
  "profileName": "DefaultProfile",
  "startTime": "2018-11-10T02:46:20.2659347Z",
  "expireTime": "2018-11-10T09:46:20.2659347Z"
}


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

/**
 * Samples for Factories GetDataPlaneAccess.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * Factories_GetDataPlaneAccess.json
     */
    /**
     * Sample code: Factories_GetDataPlaneAccess.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void factoriesGetDataPlaneAccess(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.factories().getDataPlaneAccessWithResponse("exampleResourceGroup", "exampleFactoryName",
            new UserAccessPolicy().withPermissions("r").withAccessResourcePath("").withProfileName("DefaultProfile")
                .withStartTime("2018-11-10T02:46:20.2659347Z").withExpireTime("2018-11-10T09:46:20.2659347Z"),
            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

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_data_plane_access.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_data_plane_access(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        policy={
            "accessResourcePath": "",
            "expireTime": "2018-11-10T09:46:20.2659347Z",
            "permissions": "r",
            "profileName": "DefaultProfile",
            "startTime": "2018-11-10T02:46:20.2659347Z",
        },
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_GetDataPlaneAccess.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

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_GetDataPlaneAccess.json
func ExampleFactoriesClient_GetDataPlaneAccess() {
	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().GetDataPlaneAccess(ctx, "exampleResourceGroup", "exampleFactoryName", armdatafactory.UserAccessPolicy{
		AccessResourcePath: to.Ptr(""),
		ExpireTime:         to.Ptr("2018-11-10T09:46:20.2659347Z"),
		Permissions:        to.Ptr("r"),
		ProfileName:        to.Ptr("DefaultProfile"),
		StartTime:          to.Ptr("2018-11-10T02:46:20.2659347Z"),
	}, 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.AccessPolicyResponse = armdatafactory.AccessPolicyResponse{
	// 	AccessToken: to.Ptr("**********"),
	// 	DataPlaneURL: to.Ptr("https://rpeastus.svc.datafactory.azure.com:4433"),
	// 	Policy: &armdatafactory.UserAccessPolicy{
	// 		AccessResourcePath: to.Ptr(""),
	// 		ExpireTime: to.Ptr("2018-11-10T09:46:20.2659347Z"),
	// 		Permissions: to.Ptr("r"),
	// 		ProfileName: to.Ptr("DefaultProfile"),
	// 		StartTime: to.Ptr("2018-11-10T02:46:20.2659347Z"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { DataFactoryManagementClient } = require("@azure/arm-datafactory");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get Data Plane access.
 *
 * @summary Get Data Plane access.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_GetDataPlaneAccess.json
 */
async function factoriesGetDataPlaneAccess() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const policy = {
    accessResourcePath: "",
    expireTime: "2018-11-10T09:46:20.2659347Z",
    permissions: "r",
    profileName: "DefaultProfile",
    startTime: "2018-11-10T02:46:20.2659347Z",
  };
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.factories.getDataPlaneAccess(resourceGroupName, factoryName, policy);
  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

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_GetDataPlaneAccess.json
// this example is just showing the usage of "Factories_GetDataPlaneAccess" 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
DataFactoryDataPlaneUserAccessPolicy policy = new DataFactoryDataPlaneUserAccessPolicy()
{
    Permissions = "r",
    AccessResourcePath = "",
    ProfileName = "DefaultProfile",
    StartOn = DateTimeOffset.Parse("2018-11-10T02:46:20.2659347Z"),
    ExpireOn = DateTimeOffset.Parse("2018-11-10T09:46:20.2659347Z"),
};
DataFactoryDataPlaneAccessPolicyResult result = await dataFactory.GetDataPlaneAccessAsync(policy);

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: Wed, 07 Nov 2018 03:41:57 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 11996
x-ms-request-id: 82bc20d2-4bec-496d-a1c8-3f7746fed307
x-ms-correlation-request-id: 82bc20d2-4bec-496d-a1c8-3f7746fed307

{
  "policy": {
    "permissions": "r",
    "accessResourcePath": "",
    "profileName": "DefaultProfile",
    "startTime": "2018-11-10T02:46:20.2659347Z",
    "expireTime": "2018-11-10T09:46:20.2659347Z"
  },
  "dataPlaneUrl": "https://rpeastus.svc.datafactory.azure.com:4433",
  "accessToken": "**********"
}

Définitions

Nom	Description
AccessPolicyResponse	Obtenez la définition de réponse de jeton en lecture seule du plan de données.
CloudError	Objet qui définit la structure d’une réponse d’erreur Azure Data Factory.
UserAccessPolicy	Obtenez la définition de demande de jeton en lecture seule du plan de données.

AccessPolicyResponse

Obtenez la définition de réponse de jeton en lecture seule du plan de données.

Nom	Type	Description
accessToken	string	Jeton d’accès en lecture seule au plan de données.
dataPlaneUrl	string	URL de base du service De plan de données.
policy	UserAccessPolicy	Stratégie d’accès utilisateur.

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.

UserAccessPolicy

Obtenez la définition de demande de jeton en lecture seule du plan de données.

Nom	Type	Description
accessResourcePath	string	Chemin d’accès aux ressources pour obtenir l’accès par rapport à la fabrique. Actuellement, seule la chaîne vide est prise en charge, ce qui correspond à la ressource de fabrique.
expireTime	string	Heure d’expiration du jeton. La durée maximale du jeton est de huit heures et, par défaut, le jeton expirera dans huit heures.
permissions	string	Chaîne avec des autorisations pour l’accès au plan de données. Actuellement, seul « r » est pris en charge, ce qui accorde l’accès en lecture seule.
profileName	string	Nom du profil. Actuellement, seule la valeur par défaut est prise en charge. La valeur par défaut est DefaultProfile.
startTime	string	Heure de début du jeton. Si elle n’est pas spécifiée, l’heure actuelle sera utilisée.