Exports - Get

Operace pro získání exportu pro definovaný obor podle názvu exportu

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}

Parametry identifikátoru URI

Name In Required Type Description
exportName
path True
  • string

Název exportu

scope
path True
  • string

Obor přidružený k operacím exportu Patří sem "/subscriptions/{subscriptionId}/" pro obor předplatného "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" pro obor skupiny prostředků, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" pro obor účtu pro fakturaci a "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" pro obor oddělení "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}" pro rozsah EnrollmentAccount, "/Providers/Microsoft.Management/managementGroups/{managementGroupId}" pro obor skupiny pro správu, "/Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" pro obor billingProfile, "/Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}" pro obor invoiceSection a "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}" specifické pro partnery.

api-version
query True
  • string

Verze rozhraní API, která se má použít s požadavkem klienta Aktuální verze je 2020-06-01.

$expand
query
  • string

Dá se použít k rozšíření vlastností v rámci exportu. V současné době se podporuje jenom ' runHistory ' a vrátí informace pro posledních 10 spuštění exportu.

Odpovědi

Name Type Description
200 OK

OK. Požadavek byl úspěšný.

Other Status Codes

Chybová odezva popisující, proč se operace nezdařila

Zabezpečení

azure_auth

Azure Active Directory tok OAuth2.

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

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

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"
          ]
        }
      }
    }
  }
}

Definice

CommonExportProperties

Společné vlastnosti exportu

ErrorDetails

Podrobnosti o chybě

ErrorResponse

Chybová odezva indikuje, že služba nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě.

Některé chybové odpovědi:

  • 429 TooManyRequests-požadavek je omezený. Zkuste to znovu, až po uplynutí časového limitu zadaného v hlavičce x-MS-ratelimit-Microsoft. spotřeb-Retry-After.

  • 503 ServiceUnavailable-služba je dočasně nedostupná. Opakujte akci po čekání po dobu zadanou v hlavičce "opakovat po".

ExecutionStatus

Poslední známý stav spuštění exportu

ExecutionType

Typ spuštění exportu.

Export

Prostředek exportu.

ExportDataset

Definice pro data v exportu

ExportDatasetConfiguration

Konfigurace exportu sady dat. Povoluje výběr sloupců pro export. Pokud není zadaný, export bude obsahovat všechny dostupné sloupce.

ExportDefinition

Definice exportu.

ExportDeliveryDestination

Informace o cíli pro doručení exportu. Pokud chcete přístup k účtu úložiště zpřístupnit, musíte zaregistrovat předplatné účtu u poskytovatele prostředků Microsoft. CostManagementExports. To se vyžaduje jednou pro každé předplatné. Při vytváření exportu v Azure Portal se tento postup provádí automaticky, ale uživatelé rozhraní API musí předplatné zaregistrovat. Další informace najdete v tématu https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .

ExportDeliveryInfo

Informace o doručení související s exportem.

ExportExecution

Spuštění exportu.

ExportExecutionListResult

Výsledek výpisu historie spouštění exportu

ExportRecurrencePeriod

Počáteční a koncové datum pro plán opakování.

ExportSchedule

Plán přidružený k exportu

ExportTimePeriod

Rozsah kalendářních dat pro data v exportu. Mělo by se zadat jenom s časovým obdobím nastaveným na Custom. Maximální rozsah dat je 3 měsíce.

ExportType

Typ exportu. Všimněte si, že "Usage" je ekvivalentem "ActualCost" a vztahuje se na exporty, které ještě neposkytují data pro poplatky nebo amortizaci pro rezervace služeb.

FormatType

Formát doručování exportu. Aktuálně je podporován pouze formát CSV.

GranularityType

Členitost řádků v exportu. V současné době je podporována pouze možnost denní.

RecurrenceType

Opakování plánu.

StatusType

Stav plánu exportu. Pokud je možnost neaktivní, je plán exportu pozastaven.

TimeframeType

Časový rámec pro vyžádání dat pro export. Pokud je vlastní, musí se zadat konkrétní časové období.

CommonExportProperties

Společné vlastnosti exportu

Name Type Description
definition

Má definici pro export.

deliveryInfo

Obsahuje informace o doručení pro export.

format

Formát doručování exportu. Aktuálně je podporován pouze formát CSV.

nextRunTimeEstimate
  • string

Pokud má export aktivní plán, poskytuje odhad času příštího spuštění.

runHistory

V případě potřeby má poslední historii spuštění exportu.

ErrorDetails

Podrobnosti o chybě

Name Type Description
code
  • string

Kód chyby

message
  • string

Chybová zpráva indikující, proč se operace nezdařila.

ErrorResponse

Chybová odezva indikuje, že služba nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě.

Některé chybové odpovědi:

  • 429 TooManyRequests-požadavek je omezený. Zkuste to znovu, až po uplynutí časového limitu zadaného v hlavičce x-MS-ratelimit-Microsoft. spotřeb-Retry-After.

  • 503 ServiceUnavailable-služba je dočasně nedostupná. Opakujte akci po čekání po dobu zadanou v hlavičce "opakovat po".

Name Type Description
error

Podrobnosti o chybě

ExecutionStatus

Poslední známý stav spuštění exportu

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

ExecutionType

Typ spuštění exportu.

Name Type Description
OnDemand
  • string
Scheduled
  • string

Export

Prostředek exportu.

Name Type Description
eTag
  • string

Značka eTag prostředku Pro zpracování souběžného scénáře aktualizace se pomocí tohoto pole určí, jestli uživatel aktualizuje nejnovější verzi nebo ne.

id
  • string

ID prostředku

name
  • string

Název prostředku

properties.definition

Má definici pro export.

properties.deliveryInfo

Obsahuje informace o doručení pro export.

properties.format

Formát doručování exportu. Aktuálně je podporován pouze formát CSV.

properties.nextRunTimeEstimate
  • string

Pokud má export aktivní plán, poskytuje odhad času příštího spuštění.

properties.runHistory

V případě potřeby má poslední historii spuštění exportu.

properties.schedule

Obsahuje informace o plánu pro export.

type
  • string

Typ prostředku.

ExportDataset

Definice pro data v exportu

Name Type Description
configuration

Konfigurace exportu sady dat.

granularity

Členitost řádků v exportu. V současné době je podporována pouze možnost denní.

ExportDatasetConfiguration

Konfigurace exportu sady dat. Povoluje výběr sloupců pro export. Pokud není zadaný, export bude obsahovat všechny dostupné sloupce.

Name Type Description
columns
  • string[]

Pole názvů sloupců, které se mají zahrnout do exportu Pokud není zadaný, export bude obsahovat všechny dostupné sloupce. Dostupné sloupce se můžou lišit podle zákaznického kanálu (příklady najdete v tématu).

ExportDefinition

Definice exportu.

Name Type Description
dataSet

Definice pro data v exportu

timePeriod

Má časové období pro vyžádání dat pro export.

timeframe

Časový rámec pro vyžádání dat pro export. Pokud je vlastní, musí se zadat konkrétní časové období.

type

Typ exportu. Všimněte si, že "Usage" je ekvivalentem "ActualCost" a vztahuje se na exporty, které ještě neposkytují data pro poplatky nebo amortizaci pro rezervace služeb.

ExportDeliveryDestination

Informace o cíli pro doručení exportu. Pokud chcete přístup k účtu úložiště zpřístupnit, musíte zaregistrovat předplatné účtu u poskytovatele prostředků Microsoft. CostManagementExports. To se vyžaduje jednou pro každé předplatné. Při vytváření exportu v Azure Portal se tento postup provádí automaticky, ale uživatelé rozhraní API musí předplatné zaregistrovat. Další informace najdete v tématu https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .

Name Type Description
container
  • string

Název kontejneru, do kterého budou odesílány exporty.

resourceId
  • string

ID prostředku účtu úložiště, kam se budou doručovat exporty

rootFolderPath
  • string

Název adresáře, do kterého budou odesílány exporty.

ExportDeliveryInfo

Informace o doručení související s exportem.

Name Type Description
destination

Obsahuje cíl pro doručení exportu.

ExportExecution

Spuštění exportu.

Name Type Description
eTag
  • string

Značka eTag prostředku Pro zpracování souběžného scénáře aktualizace se pomocí tohoto pole určí, jestli uživatel aktualizuje nejnovější verzi nebo ne.

id
  • string

ID prostředku

name
  • string

Název prostředku

properties.error

Podrobnosti o jakékoli chybě

properties.executionType

Typ spuštění exportu.

properties.fileName
  • string

Název exportovaného souboru.

properties.processingEndTime
  • string

Čas, kdy bylo spuštění exportu dokončeno.

properties.processingStartTime
  • string

Čas, kdy byl export vybrán, aby byl proveden.

properties.runSettings

Nastavení exportu, která byla platná pro toto spuštění.

properties.status

Poslední známý stav spuštění exportu

properties.submittedBy
  • string

Identifikátor entity, která provedla export. Pro spouštění OnDemand je to e-mail uživatele. V případě naplánovaných spuštění je systém.

properties.submittedTime
  • string

Čas, kdy byl export zařazen do fronty, aby byl proveden.

type
  • string

Typ prostředku.

ExportExecutionListResult

Výsledek výpisu historie spouštění exportu

Name Type Description
value

Seznam spuštění exportu.

ExportRecurrencePeriod

Počáteční a koncové datum pro plán opakování.

Name Type Description
from
  • string

Počáteční datum opakování.

to
  • string

Koncové datum opakování.

ExportSchedule

Plán přidružený k exportu

Name Type Description
recurrence

Opakování plánu.

recurrencePeriod

Má počáteční a koncové datum opakování. Počáteční datum musí být v budoucnosti. Je-li k dispozici, datum ukončení musí být pozdější než počáteční datum.

status

Stav plánu exportu. Pokud je možnost neaktivní, je plán exportu pozastaven.

ExportTimePeriod

Rozsah kalendářních dat pro data v exportu. Mělo by se zadat jenom s časovým obdobím nastaveným na Custom. Maximální rozsah dat je 3 měsíce.

Name Type Description
from
  • string

Počáteční datum pro export dat.

to
  • string

Koncové datum pro export dat.

ExportType

Typ exportu. Všimněte si, že "Usage" je ekvivalentem "ActualCost" a vztahuje se na exporty, které ještě neposkytují data pro poplatky nebo amortizaci pro rezervace služeb.

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

FormatType

Formát doručování exportu. Aktuálně je podporován pouze formát CSV.

Name Type Description
Csv
  • string

GranularityType

Členitost řádků v exportu. V současné době je podporována pouze možnost denní.

Name Type Description
Daily
  • string

RecurrenceType

Opakování plánu.

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

StatusType

Stav plánu exportu. Pokud je možnost neaktivní, je plán exportu pozastaven.

Name Type Description
Active
  • string
Inactive
  • string

TimeframeType

Časový rámec pro vyžádání dat pro export. Pokud je vlastní, musí se zadat konkrétní časové období.

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