Delen via


Integration Runtime Object Metadata - Get

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
pattern: ^[-\w\._\(\)]+$

De naam van de resourcegroep.

subscriptionId
path True

string

De abonnement-ID.

api-version
query True

string

De API-versie.

Aanvraagbody

Name Type Description
metadataPath

string

Pad naar metagegevens.

Antwoorden

Name Type Description
200 OK

SsisObjectMetadataListResponse

OK.

Other Status Codes

CloudError

Er is een foutbericht ontvangen van de Azure Data Factory-service.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

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-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/testactivityv2/getObjectMetadata?api-version=2018-06-01

{
  "metadataPath": "ssisFolders"
}

Voorbeeldrespons

Date: Mon, 03 Dec 2018 06:24:54 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1198
x-ms-request-id: 0cbc67c4-60e7-4d49-97d9-e4bc4f9851cd
x-ms-correlation-request-id: 0cbc67c4-60e7-4d49-97d9-e4bc4f9851cd
{
  "value": [
    {
      "id": 1,
      "type": "Folder",
      "name": "TestFolder",
      "description": ""
    },
    {
      "id": 2,
      "type": "Folder",
      "name": "EnvironmentFolder",
      "description": ""
    },
    {
      "id": 3,
      "type": "Folder",
      "name": "ActivityTest",
      "description": ""
    },
    {
      "id": 4,
      "type": "Folder",
      "name": "这是文件夹",
      "description": ""
    },
    {
      "id": 5,
      "type": "Folder",
      "name": "1"
    },
    {
      "id": 6,
      "type": "Folder",
      "name": "2"
    },
    {
      "id": 7,
      "type": "Folder",
      "name": "3"
    },
    {
      "id": 8,
      "type": "Folder",
      "name": "4"
    },
    {
      "id": 9,
      "type": "Folder",
      "name": "5"
    },
    {
      "id": 10,
      "type": "Folder",
      "name": "6"
    },
    {
      "id": 11,
      "type": "Folder",
      "name": "7"
    },
    {
      "id": 12,
      "type": "Folder",
      "name": "8"
    },
    {
      "id": 13,
      "type": "Folder",
      "name": "9"
    },
    {
      "id": 14,
      "type": "Folder",
      "name": "10"
    },
    {
      "id": 15,
      "type": "Folder",
      "name": "11"
    },
    {
      "id": 16,
      "type": "Folder",
      "name": "12"
    },
    {
      "id": 17,
      "type": "Folder",
      "name": "13"
    },
    {
      "id": 18,
      "type": "Folder",
      "name": "14"
    },
    {
      "id": 19,
      "type": "Folder",
      "name": "15"
    },
    {
      "id": 20,
      "type": "Folder",
      "name": "16"
    },
    {
      "id": 21,
      "type": "Folder",
      "name": "17"
    },
    {
      "id": 22,
      "type": "Folder",
      "name": "18"
    },
    {
      "id": 23,
      "type": "Folder",
      "name": "19"
    },
    {
      "id": 24,
      "type": "Folder",
      "name": "20"
    },
    {
      "id": 25,
      "type": "Folder",
      "name": "21"
    },
    {
      "id": 26,
      "type": "Folder",
      "name": "22"
    },
    {
      "id": 27,
      "type": "Folder",
      "name": "23"
    },
    {
      "id": 28,
      "type": "Folder",
      "name": "24"
    },
    {
      "id": 29,
      "type": "Folder",
      "name": "25"
    },
    {
      "id": 30,
      "type": "Folder",
      "name": "26"
    },
    {
      "id": 31,
      "type": "Folder",
      "name": "27"
    },
    {
      "id": 32,
      "type": "Folder",
      "name": "28"
    },
    {
      "id": 33,
      "type": "Folder",
      "name": "29"
    },
    {
      "id": 34,
      "type": "Folder",
      "name": "30"
    },
    {
      "id": 35,
      "type": "Folder",
      "name": "31"
    },
    {
      "id": 36,
      "type": "Folder",
      "name": "32"
    },
    {
      "id": 37,
      "type": "Folder",
      "name": "33"
    },
    {
      "id": 38,
      "type": "Folder",
      "name": "34"
    },
    {
      "id": 39,
      "type": "Folder",
      "name": "35"
    },
    {
      "id": 40,
      "type": "Folder",
      "name": "36"
    },
    {
      "id": 41,
      "type": "Folder",
      "name": "37"
    },
    {
      "id": 42,
      "type": "Folder",
      "name": "38"
    },
    {
      "id": 43,
      "type": "Folder",
      "name": "39"
    },
    {
      "id": 44,
      "type": "Folder",
      "name": "40"
    },
    {
      "id": 45,
      "type": "Folder",
      "name": "41"
    },
    {
      "id": 46,
      "type": "Folder",
      "name": "42"
    },
    {
      "id": 47,
      "type": "Folder",
      "name": "43"
    },
    {
      "id": 48,
      "type": "Folder",
      "name": "44"
    },
    {
      "id": 49,
      "type": "Folder",
      "name": "45"
    },
    {
      "id": 50,
      "type": "Folder",
      "name": "46"
    },
    {
      "id": 51,
      "type": "Folder",
      "name": "47"
    },
    {
      "id": 52,
      "type": "Folder",
      "name": "48"
    },
    {
      "id": 53,
      "type": "Folder",
      "name": "49"
    },
    {
      "id": 54,
      "type": "Folder",
      "name": "50"
    },
    {
      "id": 55,
      "type": "Folder",
      "name": "51"
    },
    {
      "id": 56,
      "type": "Folder",
      "name": "52"
    },
    {
      "id": 57,
      "type": "Folder",
      "name": "53"
    },
    {
      "id": 58,
      "type": "Folder",
      "name": "54"
    },
    {
      "id": 59,
      "type": "Folder",
      "name": "55"
    },
    {
      "id": 60,
      "type": "Folder",
      "name": "56"
    },
    {
      "id": 61,
      "type": "Folder",
      "name": "57"
    },
    {
      "id": 62,
      "type": "Folder",
      "name": "58"
    },
    {
      "id": 63,
      "type": "Folder",
      "name": "59"
    },
    {
      "id": 64,
      "type": "Folder",
      "name": "60"
    },
    {
      "id": 65,
      "type": "Folder",
      "name": "61"
    },
    {
      "id": 66,
      "type": "Folder",
      "name": "62"
    },
    {
      "id": 67,
      "type": "Folder",
      "name": "63"
    },
    {
      "id": 68,
      "type": "Folder",
      "name": "64"
    },
    {
      "id": 69,
      "type": "Folder",
      "name": "65"
    },
    {
      "id": 70,
      "type": "Folder",
      "name": "66"
    },
    {
      "id": 71,
      "type": "Folder",
      "name": "67"
    },
    {
      "id": 72,
      "type": "Folder",
      "name": "68"
    },
    {
      "id": 73,
      "type": "Folder",
      "name": "69"
    },
    {
      "id": 74,
      "type": "Folder",
      "name": "70"
    },
    {
      "id": 75,
      "type": "Folder",
      "name": "71"
    },
    {
      "id": 76,
      "type": "Folder",
      "name": "72"
    },
    {
      "id": 77,
      "type": "Folder",
      "name": "73"
    },
    {
      "id": 78,
      "type": "Folder",
      "name": "74"
    },
    {
      "id": 79,
      "type": "Folder",
      "name": "75"
    },
    {
      "id": 80,
      "type": "Folder",
      "name": "76"
    },
    {
      "id": 81,
      "type": "Folder",
      "name": "77"
    },
    {
      "id": 82,
      "type": "Folder",
      "name": "78"
    },
    {
      "id": 83,
      "type": "Folder",
      "name": "79"
    },
    {
      "id": 84,
      "type": "Folder",
      "name": "80"
    },
    {
      "id": 85,
      "type": "Folder",
      "name": "81"
    },
    {
      "id": 86,
      "type": "Folder",
      "name": "82"
    },
    {
      "id": 87,
      "type": "Folder",
      "name": "83"
    },
    {
      "id": 88,
      "type": "Folder",
      "name": "84"
    },
    {
      "id": 89,
      "type": "Folder",
      "name": "85"
    },
    {
      "id": 90,
      "type": "Folder",
      "name": "86"
    },
    {
      "id": 91,
      "type": "Folder",
      "name": "87"
    },
    {
      "id": 92,
      "type": "Folder",
      "name": "88"
    },
    {
      "id": 93,
      "type": "Folder",
      "name": "89"
    },
    {
      "id": 94,
      "type": "Folder",
      "name": "90"
    },
    {
      "id": 95,
      "type": "Folder",
      "name": "91"
    },
    {
      "id": 96,
      "type": "Folder",
      "name": "92"
    },
    {
      "id": 97,
      "type": "Folder",
      "name": "93"
    },
    {
      "id": 98,
      "type": "Folder",
      "name": "94"
    },
    {
      "id": 99,
      "type": "Folder",
      "name": "95"
    },
    {
      "id": 100,
      "type": "Folder",
      "name": "96"
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/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-12345678abc%2fdatafactories%2f6C8E7C90-FD45-4010-8B7C-B5227D0F0CB7%2fintegrationruntimes%2fTESTACTIVITYV2%2fgetSsisObjectMetadata%3f%24skipToken%3dc3Npc0ZvbGRlcnNAQDIwMTgtMTEtMjlUMDM6NTk6MzIuMDQ1Mzc1MiswMDowMEBAZm9sZGVyQEAwMDAwMDAwMDAwMDAwMDAwMTAx0%26api-version%3d1.0"
}

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

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

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

Name Type Description
metadataPath

string

Pad naar metagegevens.

SsisEnvironment

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

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

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

Een lijst met metagegevens van SSIS-objecten.

Name Type Description
nextLink

string

De koppeling naar de volgende pagina met resultaten, als er nog resterende resultaten bestaan.

value SsisObjectMetadata[]:

Lijst met metagegevens van SSIS-objecten.

SsisObjectMetadataType

Het type metagegevens van SSIS-objecten.

Waarde Description
Environment
Folder
Package
Project

SsisPackage

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

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

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 project

type string:

Project

Type metagegevens.

version

integer (int64)

Projectversie.

SsisVariable

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.