Integration Runtime Object Metadata - Get

Servicio:: Data Factory

Versión de la API:: 2018-06-01

Obtiene los metadatos de un objeto de SSIS Integration Runtime mediante la ruta de acceso especificada. La devolución es una lista de metadatos paginable.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nombre de fábrica.
integrationRuntimeName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Nombre del entorno de ejecución de integración.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
metadataPath	string	Ruta de acceso de metadatos.

Respuestas

Nombre	Tipo	Description
200 OK	SsisObjectMetadataListResponse	Operación de Azure completada con éxito.
Other Status Codes	CloudError	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

IntegrationRuntimeObjectMetadata_Get

Solicitud de ejemplo

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

{
  "metadataPath": "ssisFolders"
}


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

/**
 * Samples for IntegrationRuntimeObjectMetadata Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2018-06-01/IntegrationRuntimeObjectMetadata_Get.json
     */
    /**
     * Sample code: IntegrationRuntimeObjectMetadata_Get.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void
        integrationRuntimeObjectMetadataGet(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.integrationRuntimeObjectMetadatas().getWithResponse("exampleResourceGroup", "exampleFactoryName",
            "testactivityv2", new GetSsisObjectMetadataRequest().withMetadataPath("ssisFolders"),
            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 integration_runtime_object_metadata_get.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.integration_runtime_object_metadata.get(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        integration_runtime_name="testactivityv2",
    )
    print(response)


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

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

/**
 * This sample demonstrates how to get a SSIS integration runtime object metadata by specified path. The return is pageable metadata list.
 *
 * @summary get a SSIS integration runtime object metadata by specified path. The return is pageable metadata list.
 * x-ms-original-file: 2018-06-01/IntegrationRuntimeObjectMetadata_Get.json
 */
async function integrationRuntimeObjectMetadataGet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "12345678-1234-1234-1234-123456789012";
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.integrationRuntimeObjectMetadata.get(
    "exampleResourceGroup",
    "exampleFactoryName",
    "testactivityv2",
    { getMetadataRequest: { metadataPath: "ssisFolders" } },
  );
  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.Threading.Tasks;
using System.Xml;
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/IntegrationRuntimeObjectMetadata_Get.json
// this example is just showing the usage of "IntegrationRuntimeObjectMetadata_Get" 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 DataFactoryIntegrationRuntimeResource created on azure
// for more information of creating DataFactoryIntegrationRuntimeResource, please refer to the document of DataFactoryIntegrationRuntimeResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string integrationRuntimeName = "testactivityv2";
ResourceIdentifier dataFactoryIntegrationRuntimeResourceId = DataFactoryIntegrationRuntimeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, integrationRuntimeName);
DataFactoryIntegrationRuntimeResource dataFactoryIntegrationRuntime = client.GetDataFactoryIntegrationRuntimeResource(dataFactoryIntegrationRuntimeResourceId);

// invoke the operation and iterate over the result
GetSsisObjectMetadataContent content = new GetSsisObjectMetadataContent
{
    MetadataPath = "ssisFolders",
};
await foreach (SsisObjectMetadata item in dataFactoryIntegrationRuntime.GetAllIntegrationRuntimeObjectMetadataAsync(content: content))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

Respuesta de muestra

status code:: 200

Date: Mon, 03 Dec 2018 06:24:54 GMT
X-Content-Type-Options: nosniff
x-ms-correlation-request-id: 0cbc67c4-60e7-4d49-97d9-e4bc4f9851cd
x-ms-ratelimit-remaining-subscription-writes: 1198
x-ms-request-id: 0cbc67c4-60e7-4d49-97d9-e4bc4f9851cd

{
  "nextLink": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/testactivityv2/getObjectMetadata?api-version=2018-06-01&%24skipToken=https%3a%2f%2fwcu.frontend.clouddatahub.net%2fsubscriptions%2f12345678-1234-1234-1234-123456789012%2fdatafactories%2f6C8E7C90-FD45-4010-8B7C-B5227D0F0CB7%2fintegrationruntimes%2fTESTACTIVITYV2%2fgetSsisObjectMetadata%3f%24skipToken%3dc3Npc0ZvbGRlcnNAQDIwMTgtMTEtMjlUMDM6NTk6MzIuMDQ1Mzc1MiswMDowMEBAZm9sZGVyQEAwMDAwMDAwMDAwMDAwMDAwMTAx0%26api-version%3d1.0",
  "value": [
    {
      "name": "TestFolder",
      "type": "Folder",
      "description": "",
      "id": 1
    },
    {
      "name": "EnvironmentFolder",
      "type": "Folder",
      "description": "",
      "id": 2
    },
    {
      "name": "ActivityTest",
      "type": "Folder",
      "description": "",
      "id": 3
    },
    {
      "name": "这是文件夹",
      "type": "Folder",
      "description": "",
      "id": 4
    },
    {
      "name": "1",
      "type": "Folder",
      "id": 5
    },
    {
      "name": "2",
      "type": "Folder",
      "id": 6
    },
    {
      "name": "3",
      "type": "Folder",
      "id": 7
    },
    {
      "name": "4",
      "type": "Folder",
      "id": 8
    },
    {
      "name": "5",
      "type": "Folder",
      "id": 9
    },
    {
      "name": "6",
      "type": "Folder",
      "id": 10
    },
    {
      "name": "7",
      "type": "Folder",
      "id": 11
    },
    {
      "name": "8",
      "type": "Folder",
      "id": 12
    },
    {
      "name": "9",
      "type": "Folder",
      "id": 13
    },
    {
      "name": "10",
      "type": "Folder",
      "id": 14
    },
    {
      "name": "11",
      "type": "Folder",
      "id": 15
    },
    {
      "name": "12",
      "type": "Folder",
      "id": 16
    },
    {
      "name": "13",
      "type": "Folder",
      "id": 17
    },
    {
      "name": "14",
      "type": "Folder",
      "id": 18
    },
    {
      "name": "15",
      "type": "Folder",
      "id": 19
    },
    {
      "name": "16",
      "type": "Folder",
      "id": 20
    },
    {
      "name": "17",
      "type": "Folder",
      "id": 21
    },
    {
      "name": "18",
      "type": "Folder",
      "id": 22
    },
    {
      "name": "19",
      "type": "Folder",
      "id": 23
    },
    {
      "name": "20",
      "type": "Folder",
      "id": 24
    },
    {
      "name": "21",
      "type": "Folder",
      "id": 25
    },
    {
      "name": "22",
      "type": "Folder",
      "id": 26
    },
    {
      "name": "23",
      "type": "Folder",
      "id": 27
    },
    {
      "name": "24",
      "type": "Folder",
      "id": 28
    },
    {
      "name": "25",
      "type": "Folder",
      "id": 29
    },
    {
      "name": "26",
      "type": "Folder",
      "id": 30
    },
    {
      "name": "27",
      "type": "Folder",
      "id": 31
    },
    {
      "name": "28",
      "type": "Folder",
      "id": 32
    },
    {
      "name": "29",
      "type": "Folder",
      "id": 33
    },
    {
      "name": "30",
      "type": "Folder",
      "id": 34
    },
    {
      "name": "31",
      "type": "Folder",
      "id": 35
    },
    {
      "name": "32",
      "type": "Folder",
      "id": 36
    },
    {
      "name": "33",
      "type": "Folder",
      "id": 37
    },
    {
      "name": "34",
      "type": "Folder",
      "id": 38
    },
    {
      "name": "35",
      "type": "Folder",
      "id": 39
    },
    {
      "name": "36",
      "type": "Folder",
      "id": 40
    },
    {
      "name": "37",
      "type": "Folder",
      "id": 41
    },
    {
      "name": "38",
      "type": "Folder",
      "id": 42
    },
    {
      "name": "39",
      "type": "Folder",
      "id": 43
    },
    {
      "name": "40",
      "type": "Folder",
      "id": 44
    },
    {
      "name": "41",
      "type": "Folder",
      "id": 45
    },
    {
      "name": "42",
      "type": "Folder",
      "id": 46
    },
    {
      "name": "43",
      "type": "Folder",
      "id": 47
    },
    {
      "name": "44",
      "type": "Folder",
      "id": 48
    },
    {
      "name": "45",
      "type": "Folder",
      "id": 49
    },
    {
      "name": "46",
      "type": "Folder",
      "id": 50
    },
    {
      "name": "47",
      "type": "Folder",
      "id": 51
    },
    {
      "name": "48",
      "type": "Folder",
      "id": 52
    },
    {
      "name": "49",
      "type": "Folder",
      "id": 53
    },
    {
      "name": "50",
      "type": "Folder",
      "id": 54
    },
    {
      "name": "51",
      "type": "Folder",
      "id": 55
    },
    {
      "name": "52",
      "type": "Folder",
      "id": 56
    },
    {
      "name": "53",
      "type": "Folder",
      "id": 57
    },
    {
      "name": "54",
      "type": "Folder",
      "id": 58
    },
    {
      "name": "55",
      "type": "Folder",
      "id": 59
    },
    {
      "name": "56",
      "type": "Folder",
      "id": 60
    },
    {
      "name": "57",
      "type": "Folder",
      "id": 61
    },
    {
      "name": "58",
      "type": "Folder",
      "id": 62
    },
    {
      "name": "59",
      "type": "Folder",
      "id": 63
    },
    {
      "name": "60",
      "type": "Folder",
      "id": 64
    },
    {
      "name": "61",
      "type": "Folder",
      "id": 65
    },
    {
      "name": "62",
      "type": "Folder",
      "id": 66
    },
    {
      "name": "63",
      "type": "Folder",
      "id": 67
    },
    {
      "name": "64",
      "type": "Folder",
      "id": 68
    },
    {
      "name": "65",
      "type": "Folder",
      "id": 69
    },
    {
      "name": "66",
      "type": "Folder",
      "id": 70
    },
    {
      "name": "67",
      "type": "Folder",
      "id": 71
    },
    {
      "name": "68",
      "type": "Folder",
      "id": 72
    },
    {
      "name": "69",
      "type": "Folder",
      "id": 73
    },
    {
      "name": "70",
      "type": "Folder",
      "id": 74
    },
    {
      "name": "71",
      "type": "Folder",
      "id": 75
    },
    {
      "name": "72",
      "type": "Folder",
      "id": 76
    },
    {
      "name": "73",
      "type": "Folder",
      "id": 77
    },
    {
      "name": "74",
      "type": "Folder",
      "id": 78
    },
    {
      "name": "75",
      "type": "Folder",
      "id": 79
    },
    {
      "name": "76",
      "type": "Folder",
      "id": 80
    },
    {
      "name": "77",
      "type": "Folder",
      "id": 81
    },
    {
      "name": "78",
      "type": "Folder",
      "id": 82
    },
    {
      "name": "79",
      "type": "Folder",
      "id": 83
    },
    {
      "name": "80",
      "type": "Folder",
      "id": 84
    },
    {
      "name": "81",
      "type": "Folder",
      "id": 85
    },
    {
      "name": "82",
      "type": "Folder",
      "id": 86
    },
    {
      "name": "83",
      "type": "Folder",
      "id": 87
    },
    {
      "name": "84",
      "type": "Folder",
      "id": 88
    },
    {
      "name": "85",
      "type": "Folder",
      "id": 89
    },
    {
      "name": "86",
      "type": "Folder",
      "id": 90
    },
    {
      "name": "87",
      "type": "Folder",
      "id": 91
    },
    {
      "name": "88",
      "type": "Folder",
      "id": 92
    },
    {
      "name": "89",
      "type": "Folder",
      "id": 93
    },
    {
      "name": "90",
      "type": "Folder",
      "id": 94
    },
    {
      "name": "91",
      "type": "Folder",
      "id": 95
    },
    {
      "name": "92",
      "type": "Folder",
      "id": 96
    },
    {
      "name": "93",
      "type": "Folder",
      "id": 97
    },
    {
      "name": "94",
      "type": "Folder",
      "id": 98
    },
    {
      "name": "95",
      "type": "Folder",
      "id": 99
    },
    {
      "name": "96",
      "type": "Folder",
      "id": 100
    }
  ]
}

Definiciones

Nombre	Description
CloudError	Objeto que define la estructura de una respuesta de error de Azure Data Factory.
GetSsisObjectMetadataRequest	La carga de solicitud de obtención de metadatos de objeto SSIS.
SsisEnvironment	Entorno de Ssis.
SsisEnvironmentReference	Referencia del entorno de Ssis.
SsisFolder	Carpeta Ssis.
SsisObjectMetadataListResponse	Una lista de metadatos de objeto SSIS.
SsisObjectMetadataType	Tipo de metadatos del objeto SSIS.
SsisPackage	Paquete Ssis.
SsisParameter	Parámetro Ssis.
SsisProject	Proyecto de Ssis.
SsisVariable	Variable Ssis.

CloudError

Objeto

Objeto que define la estructura de una respuesta de error de Azure Data Factory.

Nombre	Tipo	Description
error.code	string	Código de error.
error.details	CloudError[]	Matriz con detalles de error adicionales.
error.message	string	Mensaje de error.
error.target	string	Nombre o ruta de acceso de propiedad en la solicitud asociada al error.

GetSsisObjectMetadataRequest

Objeto

La carga de solicitud de obtención de metadatos de objeto SSIS.

Nombre	Tipo	Description
metadataPath	string	Ruta de acceso de metadatos.

SsisEnvironment

Objeto

Entorno de Ssis.

Nombre	Tipo	Description
description	string	Descripción de los metadatos.
folderId	integer (int64)	Identificador de carpeta que contiene el entorno.
id	integer (int64)	Id. de metadatos.
name	string	Nombre de metadatos.
type	string: Environment	Tipo de metadatos.
variables	SsisVariable[]	Variable en el entorno

SsisEnvironmentReference

Objeto

Referencia del entorno de Ssis.

Nombre	Tipo	Description
environmentFolderName	string	Nombre de la carpeta del entorno.
environmentName	string	Nombre del entorno.
id	integer (int64)	Id. de referencia del entorno.
referenceType	string	Tipo de referencia

SsisFolder

Objeto

Carpeta Ssis.

Nombre	Tipo	Description
description	string	Descripción de los metadatos.
id	integer (int64)	Id. de metadatos.
name	string	Nombre de metadatos.
type	string: Folder	Tipo de metadatos.

SsisObjectMetadataListResponse

Objeto

Una lista de metadatos de objeto SSIS.

Nombre	Tipo	Description
nextLink	string (uri)	Vínculo a la página siguiente de elementos
value	SsisObjectMetadata[]: SsisEnvironment[] SsisFolder[] SsisPackage[] SsisProject[]	Los elementos SsisObjectMetadata de esta página

SsisObjectMetadataType

Enumeración

Tipo de metadatos del objeto SSIS.

Valor	Description
Folder	Folder
Project	Proyecto
Package	Package
Environment	Medio ambiente

SsisPackage

Objeto

Paquete Ssis.

Nombre	Tipo	Description
description	string	Descripción de los metadatos.
folderId	integer (int64)	Identificador de carpeta que contiene el paquete.
id	integer (int64)	Id. de metadatos.
name	string	Nombre de metadatos.
parameters	SsisParameter[]	Parámetros en el paquete
projectId	integer (int64)	Identificador de proyecto que contiene el paquete.
projectVersion	integer (int64)	Versión del proyecto que contiene el paquete.
type	string: Package	Tipo de metadatos.

SsisParameter

Objeto

Parámetro Ssis.

Nombre	Tipo	Description
dataType	string	Tipo de parámetro.
defaultValue	string	Valor predeterminado del parámetro.
description	string	Descripción del parámetro.
designDefaultValue	string	Diseñe el valor predeterminado del parámetro.
id	integer (int64)	Id. de parámetro.
name	string	Nombre del parámetro.
required	boolean	Indica si se requiere el parámetro .
sensitive	boolean	Si el parámetro es confidencial.
sensitiveDefaultValue	string	Valor confidencial predeterminado del parámetro.
valueSet	boolean	Conjunto de valores de parámetro.
valueType	string	Tipo de valor de parámetro.
variable	string	Variable de referencia de parámetros.

SsisProject

Objeto

Proyecto de Ssis.

Nombre	Tipo	Description
description	string	Descripción de los metadatos.
environmentRefs	SsisEnvironmentReference[]	Referencia del entorno en el proyecto
folderId	integer (int64)	Identificador de carpeta que contiene el proyecto.
id	integer (int64)	Id. de metadatos.
name	string	Nombre de metadatos.
parameters	SsisParameter[]	Parámetros en el proyecto
type	string: Project	Tipo de metadatos.
version	integer (int64)	Versión del proyecto.

SsisVariable

Objeto

Variable Ssis.

Nombre	Tipo	Description
dataType	string	Tipo de variable.
description	string	Descripción de las variables.
id	integer (int64)	Identificador de variable.
name	string	Nombre de variable.
sensitive	boolean	Si la variable es confidencial.
sensitiveValue	string	Valor sensible a variables.
value	string	Valor de variable.