Integration Runtime Object Metadata - Get

Service:: Data Factory

API-versie:: 2018-06-01

Haal de metagegevens van een SSIS Integration Runtime-object op op basis van het opgegeven pad. De retour is een lijst met paginabare metagegevens.

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

URI-parameters

Name	In	Vereist	Type	Description
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	De naam van de fabriek.
integrationRuntimeName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	De naam van de integratieruntime.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
metadataPath	string	Pad naar metagegevens.

Antwoorden

Name	Type	Description
200 OK	SsisObjectMetadataListResponse	Azure-operatie succesvol voltooid.
Other Status Codes	CloudError	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

IntegrationRuntimeObjectMetadata_Get

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 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
    }
  ]
}

Definities

Name	Description
CloudError	Het object dat de structuur van een Azure Data Factory-foutreactie definieert.
GetSsisObjectMetadataRequest	De nettolading van de aanvraag voor het ophalen van SSIS-objectmetagegevens.
SsisEnvironment	Ssis-omgeving.
SsisEnvironmentReference	Naslaginformatie over de Ssis-omgeving.
SsisFolder	Ssis-map.
SsisObjectMetadataListResponse	Een lijst met metagegevens van SSIS-objecten.
SsisObjectMetadataType	Het type metagegevens van SSIS-objecten.
SsisPackage	Ssis-pakket.
SsisParameter	Ssis-parameter.
SsisProject	Ssis-project.
SsisVariable	Ssis-variabele.

CloudError

Object

Het object dat de structuur van een Azure Data Factory-foutreactie definieert.

Name	Type	Description
error.code	string	Foutcode.
error.details	CloudError[]	Matrix met aanvullende foutdetails.
error.message	string	Foutmelding.
error.target	string	Eigenschapsnaam/pad in aanvraag die is gekoppeld aan een fout.

GetSsisObjectMetadataRequest

Object

De nettolading van de aanvraag voor het ophalen van SSIS-objectmetagegevens.

Name	Type	Description
metadataPath	string	Pad naar metagegevens.

SsisEnvironment

Object

Ssis-omgeving.

Name	Type	Description
description	string	Beschrijving van metagegevens.
folderId	integer (int64)	Map-id die omgeving bevat.
id	integer (int64)	Metagegevens-id.
name	string	Naam van metagegevens.
type	string: Environment	Type metagegevens.
variables	SsisVariable[]	Variabele in omgeving

SsisEnvironmentReference

Object

Naslaginformatie over de Ssis-omgeving.

Name	Type	Description
environmentFolderName	string	Naam van omgevingsmap.
environmentName	string	Omgevingsnaam.
id	integer (int64)	Omgevingsreferentie-id.
referenceType	string	Verwijzingstype

SsisFolder

Object

Ssis-map.

Name	Type	Description
description	string	Beschrijving van metagegevens.
id	integer (int64)	Metagegevens-id.
name	string	Naam van metagegevens.
type	string: Folder	Type metagegevens.

SsisObjectMetadataListResponse

Object

Een lijst met metagegevens van SSIS-objecten.

Name	Type	Description
nextLink	string (uri)	De koppeling naar de volgende pagina met items
value	SsisObjectMetadata[]: SsisEnvironment[] SsisFolder[] SsisPackage[] SsisProject[]	De SsisObjectMetadata-items op deze pagina

SsisObjectMetadataType

Opsomming

Het type metagegevens van SSIS-objecten.

Waarde	Description
Folder	Folder
Project	Project
Package	Package
Environment	Milieu

SsisPackage

Object

Ssis-pakket.

Name	Type	Description
description	string	Beschrijving van metagegevens.
folderId	integer (int64)	Map-id die pakket bevat.
id	integer (int64)	Metagegevens-id.
name	string	Naam van metagegevens.
parameters	SsisParameter[]	Parameters in pakket
projectId	integer (int64)	Project-id die pakket bevat.
projectVersion	integer (int64)	Projectversie die pakket bevat.
type	string: Package	Type metagegevens.

SsisParameter

Object

Ssis-parameter.

Name	Type	Description
dataType	string	Parametertype.
defaultValue	string	Standaardwaarde van parameter.
description	string	Parameterbeschrijving.
designDefaultValue	string	Ontwerp de standaardwaarde van de parameter.
id	integer (int64)	Parameter-id.
name	string	Parameternaam.
required	boolean	Of de parameter is vereist.
sensitive	boolean	Of de parameter gevoelig is.
sensitiveDefaultValue	string	Standaardgevoelige waarde van parameter.
valueSet	boolean	Parameterwaardeset.
valueType	string	Parameterwaardetype.
variable	string	Parameterreferentievariabele.

SsisProject

Object

Ssis-project.

Name	Type	Description
description	string	Beschrijving van metagegevens.
environmentRefs	SsisEnvironmentReference[]	Omgevingsreferentie in project
folderId	integer (int64)	Map-id die project bevat.
id	integer (int64)	Metagegevens-id.
name	string	Naam van metagegevens.
parameters	SsisParameter[]	Parameters in het project
type	string: Project	Type metagegevens.
version	integer (int64)	Projectversie.

SsisVariable

Object

Ssis-variabele.

Name	Type	Description
dataType	string	Variabel type.
description	string	Beschrijving van variabele.
id	integer (int64)	Variabele-id.
name	string	Variabelenaam.
sensitive	boolean	Of variabele gevoelig is.
sensitiveValue	string	Variabele gevoelige waarde.
value	string	Variabele waarde.