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=2021-10-01
GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports/{exportName}?api-version=2021-10-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. To zahrnuje rozsah předplatného /subscriptions/{subscriptionId}/. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} pro obor resourceGroup, /providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId} pro rozsah fakturačního účtu a /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId} pro obor oddělení, /providers/Microsoft.Billing/billingAccounts/{billingAccounts}/enrollmentAccounts/{ enrollmentAccountId} pro obor EnrollmentAccount, /providers/Microsoft.Management/managementGroups/{managementGroupId} pro obor skupiny pro správu, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} pro rozsah billingProfile, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId} pro rozsah 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.

$expand
query
  • string

Lze použít k rozbalení vlastností v rámci exportu. V současné době se podporuje pouze 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

Odpověď na chybu popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory Flow 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=2021-10-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=2021-10-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=2021-10-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=2021-10-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=2021-10-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=2021-10-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á odpověď značí, ž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ý. Opakujte akci po čekání na čas zadaný v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.

  • 503 ServiceUnavailable – Služba je dočasně nedostupná. Po uplynutí časového limitu uvedeného v hlavičce Retry-After zkuste operaci zopakovat.

ExecutionStatus

Poslední známý stav provádění exportu.

ExecutionType

Typ provádění exportu.

Export

Prostředek exportu

ExportDataset

Definice dat v exportu.

ExportDatasetConfiguration

Konfigurace exportu datové sady Umožňuje výběr sloupců pro export. Pokud ho nezadáte, export bude obsahovat všechny dostupné sloupce.

ExportDefinition

Definice exportu.

ExportDeliveryDestination

To představuje umístění účtu úložiště objektů blob, kde se budou doručovat exporty nákladů. Cíl můžete nakonfigurovat dvěma způsoby. Doporučeným přístupem pro většinu zákazníků je zadat ID prostředku účtu úložiště. To vyžaduje jednorázovou registraci předplatného účtu u poskytovatele prostředků Microsoft.CostManagementExports, aby služba Cost Management mohla získat přístup k úložišti. Při vytváření exportu v Azure Portal se tato registrace provádí automaticky, ale uživatelé rozhraní API možná budou muset předplatné zaregistrovat explicitně (další informace najdete v tématu https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Další způsob konfigurace cíle je dostupný jenom partnerům s plánem Smlouva s partnerem Microsoftu, který jsou globálními správci svého fakturačního účtu. Tito partneři můžou místo zadání ID prostředku účtu úložiště zadat název účtu úložiště spolu s tokenem SAS pro daný účet. To umožňuje export nákladů do účtu úložiště v libovolném tenantovi. Token SAS by se měl vytvořit pro službu blob service s typy prostředků Service, Container/ Object a s oprávněními ke čtení, zápisu, odstranění, výpisu, přidání nebo vytvoření (další informace najdete v tématu https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).

ExportDeliveryInfo

Informace o doručení přidružené k exportu.

ExportExecution

Provádění exportu

ExportExecutionListResult

Výsledek výpisu historie spuš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 dat pro data v exportu. Tento parametr by měl být zadán pouze s časovým rámcem nastaveným na Vlastní. 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 za poplatky nebo amortizaci pro rezervace služeb.

FormatType

Formát doručovaného exportu V současné době se podporuje jenom csv.

GranularityType

Členitost řádků v exportu V současné době se podporuje pouze denní.

RecurrenceType

Opakování plánu.

StatusType

Stav plánu exportu Pokud je neaktivní, plán exportu se pozastaví.

TimeframeType

Časový rámec pro načítání dat pro export. Pokud je vlastní, je nutné zadat konkrétní časové období.

CommonExportProperties

Společné vlastnosti exportu.

Name Type Description
definition

Má definici exportu.

deliveryInfo

Obsahuje informace o doručení exportu.

format

Formát doručovaného exportu V současné době se podporuje jenom csv.

nextRunTimeEstimate
  • string

Pokud má export aktivní plán, zobrazí se odhad dalšího času spuštění.

partitionData
  • boolean

Pokud je hodnota true, exportovaná data se rozdělí podle velikosti a umístí se do adresáře objektů blob společně se souborem manifestu. Poznámka: Tato možnost je aktuálně dostupná pouze pro moderní obory obchodování.

runHistory

V případě potřeby má pro export nejnovější historii spuštění.

ErrorDetails

Podrobnosti o chybě.

Name Type Description
code
  • string

Kód chyby

message
  • string

Chybová zpráva označující, proč operace selhala.

ErrorResponse

Chybová odpověď značí, ž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ý. Opakujte akci po čekání na čas zadaný v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.

  • 503 ServiceUnavailable – Služba je dočasně nedostupná. Po uplynutí časového limitu uvedeného v hlavičce Retry-After zkuste operaci zopakovat.

Name Type Description
error

Podrobnosti o chybě.

ExecutionStatus

Poslední známý stav provádění exportu.

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

ExecutionType

Typ provádění exportu.

Name Type Description
OnDemand
  • string
Scheduled
  • string

Export

Prostředek exportu

Name Type Description
eTag
  • string

eTag prostředku. Pro zpracování scénáře souběžné aktualizace se toto pole použije k určení, jestli uživatel aktualizuje nejnovější verzi, nebo ne.

id
  • string

ID prostředku.

name
  • string

Název prostředku.

properties.definition

Má definici exportu.

properties.deliveryInfo

Obsahuje informace o doručení exportu.

properties.format

Formát doručovaného exportu V současné době se podporuje jenom csv.

properties.nextRunTimeEstimate
  • string

Pokud má export aktivní plán, zobrazí se odhad dalšího času spuštění.

properties.partitionData
  • boolean

Pokud je hodnota true, exportovaná data se rozdělí podle velikosti a umístí se do adresáře objektů blob společně se souborem manifestu. Poznámka: Tato možnost je aktuálně dostupná pouze pro moderní obory obchodování.

properties.runHistory

V případě potřeby má pro export nejnovější historii spuštění.

properties.schedule

Obsahuje informace o plánu exportu.

type
  • string

Typ prostředku.

ExportDataset

Definice dat v exportu.

Name Type Description
configuration

Konfigurace exportu datové sady

granularity

Členitost řádků v exportu V současné době se podporuje pouze denní.

ExportDatasetConfiguration

Konfigurace exportu datové sady Umožňuje výběr sloupců pro export. Pokud ho nezadáte, export bude obsahovat všechny dostupné sloupce.

Name Type Description
columns
  • string[]

Pole názvů sloupců, které se mají zahrnout do exportu. Pokud ho nezadáte, export bude obsahovat všechny dostupné sloupce. Dostupné sloupce se můžou lišit podle kanálu zákazníka (viz příklady).

ExportDefinition

Definice exportu.

Name Type Description
dataSet

Definice dat v exportu.

timePeriod

Má časové období pro načítání dat pro export.

timeframe

Časový rámec pro načítání dat pro export. Pokud je vlastní, je nutné 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 za poplatky nebo amortizaci pro rezervace služeb.

ExportDeliveryDestination

To představuje umístění účtu úložiště objektů blob, kde se budou doručovat exporty nákladů. Cíl můžete nakonfigurovat dvěma způsoby. Doporučeným přístupem pro většinu zákazníků je zadat ID prostředku účtu úložiště. To vyžaduje jednorázovou registraci předplatného účtu u poskytovatele prostředků Microsoft.CostManagementExports, aby služba Cost Management mohla získat přístup k úložišti. Při vytváření exportu v Azure Portal se tato registrace provádí automaticky, ale uživatelé rozhraní API možná budou muset předplatné zaregistrovat explicitně (další informace najdete v tématu https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Další způsob konfigurace cíle je dostupný jenom partnerům s plánem Smlouva s partnerem Microsoftu, který jsou globálními správci svého fakturačního účtu. Tito partneři můžou místo zadání ID prostředku účtu úložiště zadat název účtu úložiště spolu s tokenem SAS pro daný účet. To umožňuje export nákladů do účtu úložiště v libovolném tenantovi. Token SAS by se měl vytvořit pro službu blob service s typy prostředků Service, Container/ Object a s oprávněními ke čtení, zápisu, odstranění, výpisu, přidání nebo vytvoření (další informace najdete v tématu https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).

Name Type Description
container
  • string

Název kontejneru, ve kterém se exporty nahrají. Pokud kontejner neexistuje, vytvoří se.

resourceId
  • string

ID prostředku účtu úložiště, do kterého se exporty doručí. To není nutné, pokud je zadán sasToken a storageAccount.

rootFolderPath
  • string

Název adresáře, ve kterém se exporty nahrají.

sasToken
  • string

Token SAS pro účet úložiště. Pro omezenou sadu zákazníků Azure je možné místo id prostředku zadat společně s hodnotou storageAccount. Poznámka: Hodnota vrácená rozhraním API pro tuto vlastnost bude vždy obfuscována. Vrácení této obfuskované hodnoty nebude mít za následek aktualizaci tokenu SAS. Chcete-li tuto hodnotu aktualizovat, musí být zadán nový token SAS.

storageAccount
  • string

Účet úložiště, do kterého se exporty nahrají. Pro omezenou sadu zákazníků Azure je možné místo id prostředku zadat sasToken.

ExportDeliveryInfo

Informace o doručení přidružené k exportu.

Name Type Description
destination

Má cíl pro doručení exportu.

ExportExecution

Provádění exportu

Name Type Description
eTag
  • string

eTag prostředku. Pro zpracování scénáře souběžné aktualizace se toto pole použije k určení, 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 provádění exportu.

properties.fileName
  • string

Název exportovaného souboru.

properties.processingEndTime
  • string

Čas dokončení provádění exportu.

properties.processingStartTime
  • string

Čas, kdy byl export vyzvednut, aby se spustil.

properties.runSettings

Nastavení exportu, které se pro toto spuštění projevilo.

properties.status

Poslední známý stav provádění exportu.

properties.submittedBy
  • string

Identifikátor entity, která spustila export. U spuštění onDemand se jedná o e-mail uživatele. U plánovaných spuštění se jedná o systém.

properties.submittedTime
  • string

Čas, kdy byl export zařazen do fronty, který se má spustit.

type
  • string

Typ prostředku.

ExportExecutionListResult

Výsledek výpisu historie spuš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 budoucnu. Pokud je k dispozici, koncové datum musí být větší než počáteční datum.

status

Stav plánu exportu Pokud je neaktivní, plán exportu se pozastaví.

ExportTimePeriod

Rozsah dat pro data v exportu. Tento parametr by měl být zadán pouze s časovým rámcem nastaveným na Vlastní. Maximální rozsah dat je 3 měsíce.

Name Type Description
from
  • string

Počáteční datum exportu dat.

to
  • string

Koncové datum exportu dat.

ExportType

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

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

FormatType

Formát doručovaného exportu V současné době se podporuje jenom csv.

Name Type Description
Csv
  • string

GranularityType

Členitost řádků v exportu V současné době se podporuje pouze 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 neaktivní, plán exportu se pozastaví.

Name Type Description
Active
  • string
Inactive
  • string

TimeframeType

Časový rámec pro načítání dat pro export. Pokud je vlastní, je nutné zadat konkrétní časové období.

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