Factories - Get Data Plane Access

Referência

Serviço:: Data Factory

Versão da API:: 2018-06-01

Obter acesso ao Plano de Dados.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
factoryName	path	True	string	O nome da fábrica. Padrão Regex: `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	O nome do grupo de recursos. Padrão Regex: `^[-\w\._\(\)]+$`
subscriptionId	path	True	string	O identificador da subscrição.
api-version	query	True	string	A versão da API.

Corpo do Pedido

Name	Tipo	Description
accessResourcePath	string	O caminho do recurso para obter acesso em relação à fábrica. Atualmente, só é suportada uma cadeia vazia que corresponde ao recurso de fábrica.
expireTime	string	Tempo de expiração do token. A duração máxima do token é de oito horas e, por predefinição, o token irá expirar dentro de oito horas.
permissions	string	A cadeia com permissões para acesso ao Plano de Dados. Atualmente, só é suportado "r" que concede acesso só de leitura.
profileName	string	O nome do perfil. Atualmente, apenas a predefinição é suportada. O valor predefinido é DefaultProfile.
startTime	string	Hora de início do token. Se não for especificado, será utilizada a hora atual.

Respostas

Name	Tipo	Description
200 OK	AccessPolicyResponse	OK.
Other Status Codes	CloudError	Uma resposta de erro recebida do serviço Azure Data Factory.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Factories_GetDataPlaneAccess

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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": "**********"
}

Definições

Name	Description
AccessPolicyResponse	Obter definição de resposta de token só de leitura do Plano de Dados.
CloudError	O objeto que define a estrutura de uma resposta de erro Azure Data Factory.
UserAccessPolicy	Obter definição de pedido de token só de leitura do Plano de Dados.

AccessPolicyResponse

Obter definição de resposta de token só de leitura do Plano de Dados.

Name	Tipo	Description
accessToken	string	Token de acesso só de leitura do Plano de Dados.
dataPlaneUrl	string	URL da base de serviço do Plano de Dados.
policy	UserAccessPolicy	A política de acesso do utilizador.

CloudError

O objeto que define a estrutura de uma resposta de erro Azure Data Factory.

Name	Tipo	Description
error.code	string	Código de erro.
error.details	CloudError[]	Matriz com detalhes de erro adicionais.
error.message	string	Mensagem de erro.
error.target	string	Nome/caminho da propriedade no pedido associado ao erro.

UserAccessPolicy

Obter definição de pedido de token só de leitura do Plano de Dados.

Name	Tipo	Description
accessResourcePath	string	O caminho do recurso para obter acesso em relação à fábrica. Atualmente, só é suportada uma cadeia vazia que corresponde ao recurso de fábrica.
expireTime	string	Tempo de expiração do token. A duração máxima do token é de oito horas e, por predefinição, o token irá expirar dentro de oito horas.
permissions	string	A cadeia com permissões para acesso ao Plano de Dados. Atualmente, só é suportado "r" que concede acesso só de leitura.
profileName	string	O nome do perfil. Atualmente, apenas a predefinição é suportada. O valor predefinido é DefaultProfile.
startTime	string	Hora de início do token. Se não for especificado, será utilizada a hora atual.