Exports - Get

A megadott hatókör exportálásának az exportálási név alapján való lekérésére szolgáló művelet.

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports/{exportName}?api-version=2020-06-01
GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports/{exportName}?api-version=2020-06-01&$expand={$expand}

URI-paraméterek

Name In Required Type Description
exportName
path True
  • string

Exportálás neve.

scope
path True
  • string

Az exportálási műveletekhez társított hatókör. Ez magában foglalja az előfizetések hatókörének "/subscriptions/{subscriptionId}/", a "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" a resourceGroup hatókörét, a Számlázási fiók hatókörét és a "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" osztály hatókörét, a/Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId} "EnrollmentAccount", "/Providers/Microsoft.Management/managementGroups/{managementGroupId} for felügyeleti csoport hatóköre,"/Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} ", billingProfile hatókör,"/Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId} ", invoiceSection és"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId} "esetében a partnerek számára.

api-version
query True
  • string

Az ügyfél-kérelemmel használandó API verziója. Az aktuális verzió 2020-06-01.

$expand
query
  • string

A tulajdonságok exportáláson belüli kibontására használható. Jelenleg csak az "Runhistory (" támogatott, és az Exportálás utolsó 10 végrehajtásának adatait fogja visszaadni.

Válaszok

Name Type Description
200 OK

OK gombra. A kérelem sikeres volt.

Other Status Codes

Hiba történt a művelet hibája miatt.

Biztonság

azure_auth

Azure Active Directory OAuth2 folyamat.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation felhasználói fiók megszemélyesítése

Példák

ExportGetByBillingAccount
ExportGetByDepartment
ExportGetByEnrollmentAccount
ExportGetByManagementGroup
ExportGetByResourceGroup
ExportGetBySubscription

ExportGetByBillingAccount

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport?api-version=2020-06-01

Sample Response

{
  "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2020-05-01T00:00:00Z",
        "to": "2020-05-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetByDepartment

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport?api-version=2020-06-01

Sample Response

{
  "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-06-30T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetByEnrollmentAccount

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport?api-version=2020-06-01

Sample Response

{
  "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2019-09-01T00:00:00Z",
        "to": "2019-10-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetByManagementGroup

Sample Request

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport?api-version=2020-06-01

Sample Response

{
  "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2019-09-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "UsageDate",
            "MeterId",
            "InstanceId",
            "ResourceLocation",
            "UsageQuantity"
          ]
        }
      }
    }
  }
}

ExportGetByResourceGroup

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport?api-version=2020-06-01

Sample Response

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-06-30T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetBySubscription

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport?api-version=2020-06-01

Sample Response

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2019-06-01T00:00:00Z",
        "to": "2019-07-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Definíciók

CommonExportProperties

Az Exportálás általános tulajdonságai.

ErrorDetails

A hiba részletei.

ErrorResponse

A hiba azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérelmet. Az ok a hibaüzenetben található.

Néhány hiba:

  • 429 TooManyRequests – a kérelem szabályozva van. Próbálja megismételni az "x-MS-ratelimit-Microsoft. felhasználási-újrapróbálkozási" fejlécben megadott idő várakozását.

  • 503 ServiceUnavailable – a szolgáltatás átmenetileg nem érhető el. Próbálja megismételni az újrapróbálkozást követő fejlécben megadott idő várakozását.

ExecutionStatus

Az Exportálás végrehajtásának utolsó ismert állapota.

ExecutionType

Az Exportálás végrehajtásának típusa.

Export

Exportálási erőforrás.

ExportDataset

Az exportálásban szereplő adatdefiníció.

ExportDatasetConfiguration

Az adatkészlet exportálása konfiguráció. Lehetővé teszi az oszlopok kiválasztását az exportáláshoz. Ha nincs megadva, az Exportálás az összes elérhető oszlopot tartalmazza.

ExportDefinition

Az Exportálás definíciója.

ExportDeliveryDestination

Az Exportálás kézbesítésének célhelye. A Storage-fiókhoz való hozzáférés engedélyezéséhez regisztrálnia kell a fiók előfizetését a Microsoft. CostManagementExports erőforrás-szolgáltatóval. Ez egy előfizetés után egyszer szükséges. Az Azure Portal exportálásának létrehozásakor a rendszer automatikusan végrehajtja az előfizetést, azonban az API-felhasználóknak regisztrálniuk kell. További információ: https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .

ExportDeliveryInfo

Az exportáláshoz társított kézbesítési információ.

ExportExecution

Exportálási végrehajtás.

ExportExecutionListResult

Az Exportálás végrehajtási előzményeinek listázásának eredménye.

ExportRecurrencePeriod

Az ismétlődési ütemterv kezdő és záró dátuma.

ExportSchedule

Az exportáláshoz társított ütemterv.

ExportTimePeriod

Az exportálásban szereplő adatok dátumtartomány. Ezt csak az "egyéni" időkeretre vonatkozó beállítással lehet megadni. A maximális dátumtartomány 3 hónap.

ExportType

Az Exportálás típusa. Vegye figyelembe, hogy a "használat" egyenértékű a "ActualCost" értékkel, és olyan exportálásra vonatkozik, amely még nem biztosít adatokat a szolgáltatási foglalások költségeinek vagy amortizációjának.

FormatType

A továbbított exportálás formátuma. Jelenleg csak a "CSV" támogatott.

GranularityType

A sorok részletessége az exportálásban. Jelenleg csak a "Daily" támogatott.

RecurrenceType

Az ütemterv ismétlődése.

StatusType

Az exportálási ütemterv állapota. Ha az "inaktív", az exportálási ütemterv szüneteltetve van.

TimeframeType

Az exportálási adathúzás időkerete. Ha az egyéni érték van megadva, akkor meg kell adni egy adott időszakot.

CommonExportProperties

Az Exportálás általános tulajdonságai.

Name Type Description
definition

Az Exportálás definíciója.

deliveryInfo

Kézbesítési információkkal rendelkezik az exportáláshoz.

format

A továbbított exportálás formátuma. Jelenleg csak a "CSV" támogatott.

nextRunTimeEstimate
  • string

Ha az Exportálás aktív ütemtervet tartalmaz, a a következő végrehajtási idő becslését adja meg.

runHistory

Ha a rendszer kéri, az exportáláshoz a legutóbbi végrehajtási előzmények szerepelnek.

ErrorDetails

A hiba részletei.

Name Type Description
code
  • string

Hibakód.

message
  • string

Hibaüzenet, amely azt jelzi, hogy a művelet miért nem sikerült.

ErrorResponse

A hiba azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérelmet. Az ok a hibaüzenetben található.

Néhány hiba:

  • 429 TooManyRequests – a kérelem szabályozva van. Próbálja megismételni az "x-MS-ratelimit-Microsoft. felhasználási-újrapróbálkozási" fejlécben megadott idő várakozását.

  • 503 ServiceUnavailable – a szolgáltatás átmenetileg nem érhető el. Próbálja megismételni az újrapróbálkozást követő fejlécben megadott idő várakozását.

Name Type Description
error

A hiba részletei.

ExecutionStatus

Az Exportálás végrehajtásának utolsó ismert állapota.

Name Type Description
Completed
  • string
DataNotAvailable
  • string
Failed
  • string
InProgress
  • string
NewDataNotAvailable
  • string
Queued
  • string
Timeout
  • string

ExecutionType

Az Exportálás végrehajtásának típusa.

Name Type Description
OnDemand
  • string
Scheduled
  • string

Export

Exportálási erőforrás.

Name Type Description
eTag
  • string

az erőforrás eTag. Az egyidejű frissítési forgatókönyvek kezeléséhez ezt a mezőt fogja használni a rendszer annak meghatározására, hogy a felhasználó frissíti-e a legújabb verziót.

id
  • string

Erőforrás-azonosító.

name
  • string

Az erőforrás neve.

properties.definition

Az Exportálás definíciója.

properties.deliveryInfo

Kézbesítési információkkal rendelkezik az exportáláshoz.

properties.format

A továbbított exportálás formátuma. Jelenleg csak a "CSV" támogatott.

properties.nextRunTimeEstimate
  • string

Ha az Exportálás aktív ütemtervet tartalmaz, a a következő végrehajtási idő becslését adja meg.

properties.runHistory

Ha a rendszer kéri, az exportáláshoz a legutóbbi végrehajtási előzmények szerepelnek.

properties.schedule

Ütemezett adatokat tartalmaz az exportáláshoz.

type
  • string

Erőforrástípus.

ExportDataset

Az exportálásban szereplő adatdefiníció.

Name Type Description
configuration

Az adatkészlet exportálása konfiguráció.

granularity

A sorok részletessége az exportálásban. Jelenleg csak a "Daily" támogatott.

ExportDatasetConfiguration

Az adatkészlet exportálása konfiguráció. Lehetővé teszi az oszlopok kiválasztását az exportáláshoz. Ha nincs megadva, az Exportálás az összes elérhető oszlopot tartalmazza.

Name Type Description
columns
  • string[]

Az exportálásban szerepeltetni kívánt oszlopnevek tömbje. Ha nincs megadva, az Exportálás az összes elérhető oszlopot tartalmazza. Az elérhető oszlopok különbözőek lehetnek az ügyfél csatornájában (lásd a példákat).

ExportDefinition

Az Exportálás definíciója.

Name Type Description
dataSet

Az exportálásban szereplő adatdefiníció.

timePeriod

Az exportáláshoz szükséges adathúzási időtartam.

timeframe

Az exportálási adathúzás időkerete. Ha az egyéni érték van megadva, akkor meg kell adni egy adott időszakot.

type

Az Exportálás típusa. Vegye figyelembe, hogy a "használat" egyenértékű a "ActualCost" értékkel, és olyan exportálásra vonatkozik, amely még nem biztosít adatokat a szolgáltatási foglalások költségeinek vagy amortizációjának.

ExportDeliveryDestination

Az Exportálás kézbesítésének célhelye. A Storage-fiókhoz való hozzáférés engedélyezéséhez regisztrálnia kell a fiók előfizetését a Microsoft. CostManagementExports erőforrás-szolgáltatóval. Ez egy előfizetés után egyszer szükséges. Az Azure Portal exportálásának létrehozásakor a rendszer automatikusan végrehajtja az előfizetést, azonban az API-felhasználóknak regisztrálniuk kell. További információ: https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .

Name Type Description
container
  • string

Annak a tárolónak a neve, ahová az Exportálás fel lesz töltve.

resourceId
  • string

Annak a Storage-fióknak az erőforrás-azonosítója, amelyben az Exportálás történik.

rootFolderPath
  • string

Annak a könyvtárnak a neve, ahová az Exportálás fel lesz töltve.

ExportDeliveryInfo

Az exportáláshoz társított kézbesítési információ.

Name Type Description
destination

Az Exportálás kézbesítésének célhelye.

ExportExecution

Exportálási végrehajtás.

Name Type Description
id
  • string

Erőforrás-azonosító.

name
  • string

Az erőforrás neve.

properties.error

A hibák részletei.

properties.executionType

Az Exportálás végrehajtásának típusa.

properties.fileName
  • string

Az exportált fájl neve.

properties.processingEndTime
  • string

Az Exportálás végrehajtásának időpontja.

properties.processingStartTime
  • string

Az Exportálás befejezésének időpontja.

properties.runSettings

A végrehajtáshoz érvényben lévő exportálási beállítások.

properties.status

Az Exportálás végrehajtásának utolsó ismert állapota.

properties.submittedBy
  • string

Az exportálást futtató entitás azonosítója. A OnDemand végrehajtásához ez a felhasználói e-mail cím. Ütemezett végrehajtás esetén ez a "rendszer".

properties.submittedTime
  • string

Az Exportálás várólistára helyezésének időpontja.

tags
  • object

Erőforrás-címkék.

type
  • string

Erőforrástípus.

ExportExecutionListResult

Az Exportálás végrehajtási előzményeinek listázásának eredménye.

Name Type Description
value

Az exportálási végrehajtások listája.

ExportRecurrencePeriod

Az ismétlődési ütemterv kezdő és záró dátuma.

Name Type Description
from
  • string

Az ismétlődés kezdési dátuma.

to
  • string

Az ismétlődés befejezési dátuma.

ExportSchedule

Az exportáláshoz társított ütemterv.

Name Type Description
recurrence

Az ütemterv ismétlődése.

recurrencePeriod

Az ismétlődés kezdési és befejezési dátuma. A kezdő dátumnak a jövőben kell lennie. Ha van ilyen, a befejezési dátumnak a kezdő dátumnál nagyobbnak kell lennie.

status

Az exportálási ütemterv állapota. Ha az "inaktív", az exportálási ütemterv szüneteltetve van.

ExportTimePeriod

Az exportálásban szereplő adatok dátumtartomány. Ezt csak az "egyéni" időkeretre vonatkozó beállítással lehet megadni. A maximális dátumtartomány 3 hónap.

Name Type Description
from
  • string

Az adatok exportálásának kezdő dátuma.

to
  • string

Az adatok exportálásának befejezési dátuma.

ExportType

Az Exportálás típusa. Vegye figyelembe, hogy a "használat" egyenértékű a "ActualCost" értékkel, és olyan exportálásra vonatkozik, amely még nem biztosít adatokat a szolgáltatási foglalások költségeinek vagy amortizációjának.

Name Type Description
ActualCost
  • string
AmortizedCost
  • string
Usage
  • string

FormatType

A továbbított exportálás formátuma. Jelenleg csak a "CSV" támogatott.

Name Type Description
Csv
  • string

GranularityType

A sorok részletessége az exportálásban. Jelenleg csak a "Daily" támogatott.

Name Type Description
Daily
  • string

RecurrenceType

Az ütemterv ismétlődése.

Name Type Description
Annually
  • string
Daily
  • string
Monthly
  • string
Weekly
  • string

StatusType

Az exportálási ütemterv állapota. Ha az "inaktív", az exportálási ütemterv szüneteltetve van.

Name Type Description
Active
  • string
Inactive
  • string

TimeframeType

Az exportálási adathúzás időkerete. Ha az egyéni érték van megadva, akkor meg kell adni egy adott időszakot.

Name Type Description
BillingMonthToDate
  • string
Custom
  • string
MonthToDate
  • string
TheLastBillingMonth
  • string
TheLastMonth
  • string
WeekToDate
  • string