Sdílet prostřednictvím


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=2025-03-01
GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports/{exportName}?api-version=2025-03-01&$expand={$expand}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
exportName
path True

string

Název exportu.

scope
path True

string

Plně kvalifikovaný identifikátor Azure Resource Manageru prostředku.

api-version
query True

string

minLength: 1

Verze rozhraní API, která se má použít pro tuto operaci.

$expand
query

string

Lze použít k rozšíření 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 Typ Description
200 OK

Export

Operace Azure byla úspěšně dokončena.

Other Status Codes

ErrorResponse

Neočekávaná chybová odpověď

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

ExportGetByBillingAccount
ExportGetByDepartment
ExportGetByEnrollmentAccount
ExportGetByManagementGroup
ExportGetByResourceGroup
ExportGetBySubscription

ExportGetByBillingAccount

Ukázkový požadavek

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

Ukázková odpověď

{
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "eTag": "\"00000000-0000-0000-0000-000000000000\"",
  "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "format": "Csv",
    "compressionMode": "gzip",
    "dataOverwriteBehavior": "OverwritePreviousReport",
    "definition": {
      "type": "ActualCost",
      "dataSet": {
        "configuration": {
          "dataVersion": "2023-05-01"
        },
        "granularity": "Daily"
      },
      "timePeriod": {
        "from": "2020-05-01T00:00:00Z",
        "to": "2020-05-31T00:00:00Z"
      },
      "timeframe": "Custom"
    },
    "deliveryInfo": {
      "destination": {
        "container": "exports",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "rootFolderPath": "ad-hoc"
      }
    },
    "exportDescription": "This is a test export.",
    "partitionData": true
  }
}

ExportGetByDepartment

Ukázkový požadavek

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

Ukázková odpověď

{
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "eTag": "\"00000000-0000-0000-0000-000000000000\"",
  "id": "/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "format": "Csv",
    "compressionMode": "gzip",
    "dataOverwriteBehavior": "OverwritePreviousReport",
    "definition": {
      "type": "ActualCost",
      "dataSet": {
        "configuration": {
          "dataVersion": "2023-05-01"
        },
        "granularity": "Daily"
      },
      "timePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-06-30T00:00:00Z"
      },
      "timeframe": "Custom"
    },
    "deliveryInfo": {
      "destination": {
        "container": "exports",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "rootFolderPath": "ad-hoc"
      }
    },
    "exportDescription": "This is a test export.",
    "partitionData": true
  }
}

ExportGetByEnrollmentAccount

Ukázkový požadavek

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

Ukázková odpověď

{
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "eTag": "\"00000000-0000-0000-0000-000000000000\"",
  "id": "/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "format": "Csv",
    "compressionMode": "gzip",
    "dataOverwriteBehavior": "OverwritePreviousReport",
    "definition": {
      "type": "ActualCost",
      "dataSet": {
        "configuration": {
          "dataVersion": "2023-05-01"
        },
        "granularity": "Daily"
      },
      "timePeriod": {
        "from": "2019-09-01T00:00:00Z",
        "to": "2019-09-30T00:00:00Z"
      },
      "timeframe": "Custom"
    },
    "deliveryInfo": {
      "destination": {
        "container": "exports",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "rootFolderPath": "ad-hoc"
      }
    },
    "exportDescription": "This is a test export.",
    "partitionData": true
  }
}

ExportGetByManagementGroup

Ukázkový požadavek

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

Ukázková odpověď

{
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "eTag": "\"00000000-0000-0000-0000-000000000000\"",
  "id": "/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "format": "Csv",
    "compressionMode": "gzip",
    "dataOverwriteBehavior": "OverwritePreviousReport",
    "definition": {
      "type": "ActualCost",
      "dataSet": {
        "configuration": {
          "dataVersion": "2023-05-01"
        },
        "granularity": "Daily"
      },
      "timePeriod": {
        "from": "2019-09-01T00:00:00Z",
        "to": "2020-09-30T00:00:00Z"
      },
      "timeframe": "Custom"
    },
    "deliveryInfo": {
      "destination": {
        "container": "exports",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "rootFolderPath": "ad-hoc"
      }
    },
    "exportDescription": "This is a test export.",
    "partitionData": true
  }
}

ExportGetByResourceGroup

Ukázkový požadavek

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

Ukázková odpověď

{
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "eTag": "\"00000000-0000-0000-0000-000000000000\"",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "format": "Csv",
    "compressionMode": "gzip",
    "dataOverwriteBehavior": "OverwritePreviousReport",
    "definition": {
      "type": "ActualCost",
      "dataSet": {
        "configuration": {
          "dataVersion": "2023-05-01"
        },
        "granularity": "Daily"
      },
      "timePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-06-30T00:00:00Z"
      },
      "timeframe": "Custom"
    },
    "deliveryInfo": {
      "destination": {
        "container": "exports",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "rootFolderPath": "ad-hoc"
      }
    },
    "exportDescription": "This is a test export.",
    "partitionData": true
  }
}

ExportGetBySubscription

Ukázkový požadavek

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

Ukázková odpověď

{
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "eTag": "\"00000000-0000-0000-0000-000000000000\"",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "format": "Csv",
    "compressionMode": "gzip",
    "dataOverwriteBehavior": "OverwritePreviousReport",
    "definition": {
      "type": "ActualCost",
      "dataSet": {
        "configuration": {
          "dataVersion": "2023-05-01"
        },
        "granularity": "Daily"
      },
      "timePeriod": {
        "from": "2019-06-01T00:00:00Z",
        "to": "2019-06-30T00:00:00Z"
      },
      "timeframe": "Custom"
    },
    "deliveryInfo": {
      "destination": {
        "container": "exports",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "rootFolderPath": "ad-hoc"
      }
    },
    "exportDescription": "This is a test export.",
    "partitionData": true
  }
}

Definice

Name Description
CommonExportProperties

Společné vlastnosti exportu.

CompressionModeType

Umožňuje zákazníkům vybrat komprimovat data pro exporty. Toto nastavení povolí schéma komprese cílových souborů za běhu. Ve výchozím nastavení je nastavená hodnota Žádné. Gzip je pro csv a přichycení pro parquet.

createdByType

Typ identity, která prostředek vytvořila.

DataOverwriteBehaviorType

Povolit zákazníkům výběr přepsání dat (OverwritePreviousReport) pro exporty. Toto nastavení povolí přepsání dat za stejný měsíc v účtu úložiště zákazníka. Ve výchozím nastavení je nastavena možnost CreateNewReport.

DestinationType

Typ cíle doručení exportu. V současné době se podporuje jenom AzureBlob.

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\nNěkteré chybové odpovědi: \n\n * 429 TooManyRequests - Požadavky jsou omezeny. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after. \n\n * 503 Nedostupná služba - Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.

ExecutionStatus

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

ExecutionType

Typ spuštění exportu.

Export

Prostředek exportu.

ExportDataset

Definice dat v exportu.

ExportDatasetConfiguration

To je na cestě k vyřazení a nebude podporováno dále.

ExportDefinition

Definice exportu.

ExportDeliveryDestination

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 získala přístup k úložišti. Při vytváření exportu na webu 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 k dispozici pouze partnerům s plánem smlouvy s partnerem Microsoftu, kteří 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 se službou Service, kontejnerem nebo objektovými typy prostředků a s oprávněními ke čtení, zápisu, odstranění, 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.

ExportExecutionListResult

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

ExportRecurrencePeriod

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

ExportRun

Spuštění exportu

ExportSchedule

Plán přidružený k exportu.

ExportSuspensionContext

Vlastnosti spuštění exportu. To není v současné době obsazeno.

ExportTimePeriod

Rozsah kalendářních 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í časové období je 1 kalendářní měsíc.

ExportType

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

FilterItemNames

Název filtru. Tento typ definice exportu se v současné době podporuje jenom u doporučení ReservationRecommendations. Podporované názvy jsou ['ReservationScope', 'LookBackPeriod', 'ResourceType']

FilterItems

Bude obsahovat název a hodnotu filtru, se kterou chcete pracovat. Tento typ definice exportu se v současné době podporuje jenom u doporučení ReservationRecommendations.

FormatType

Formát doručované exportu.

GranularityType

Členitost řádků v exportu Ve většině případů se v současné době podporuje "Denně".

RecurrenceType

Opakování plánu.

StatusType

Stav plánu exportu Pokud je neaktivní, plán exportu se pozastaví. Pokud chcete povolit, aby byl export aktivní, a pak proveďte požadavek PUT.

SystemAssignedServiceIdentity

Identita spravované služby (přiřazená systémem nebo žádná)

SystemAssignedServiceIdentityType

Typ identity spravované služby (přiřazený systémem nebo žádný).

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

TimeframeType

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

CommonExportProperties

Společné vlastnosti exportu.

Name Typ Description
compressionMode

CompressionModeType

Umožňuje zákazníkům vybrat komprimovat data pro exporty. Toto nastavení povolí schéma komprese cílových souborů za běhu. Ve výchozím nastavení je nastavená hodnota Žádné. Gzip je pro csv a přichycení pro parquet.

dataOverwriteBehavior

DataOverwriteBehaviorType

Povolit zákazníkům výběr přepsání dat (OverwritePreviousReport) pro exporty. Toto nastavení povolí přepsání dat za stejný měsíc v účtu úložiště zákazníka. Ve výchozím nastavení je nastavena možnost CreateNewReport.

definition

ExportDefinition

Má definici pro export.

deliveryInfo

ExportDeliveryInfo

Obsahuje informace o doručení pro export.

exportDescription

string

Popis exportu nastavený zákazníkem při vytváření nebo aktualizaci exportu.

format

FormatType

Formát doručované exportu.

nextRunTimeEstimate

string (date-time)

Pokud má export aktivní plán, poskytne odhad příštího běhu.

partitionData

boolean

Pokud je nastavená hodnota true, exportovaná data se rozdělí podle velikosti a umístí se do adresáře objektů blob společně se souborem manifestu.

runHistory

ExportExecutionListResult

Pokud je to požadováno, obsahuje nejnovější historii spuštění pro export.

systemSuspensionContext

ExportSuspensionContext

Důvod pozastavení exportu, pokud je export ve stavu SystemSuspended. To není v současné době obsazeno.

CompressionModeType

Umožňuje zákazníkům vybrat komprimovat data pro exporty. Toto nastavení povolí schéma komprese cílových souborů za běhu. Ve výchozím nastavení je nastavená hodnota Žádné. Gzip je pro csv a přichycení pro parquet.

Hodnota Description
gzip
snappy
none

createdByType

Typ identity, která prostředek vytvořila.

Hodnota Description
User
Application
ManagedIdentity
Key

DataOverwriteBehaviorType

Povolit zákazníkům výběr přepsání dat (OverwritePreviousReport) pro exporty. Toto nastavení povolí přepsání dat za stejný měsíc v účtu úložiště zákazníka. Ve výchozím nastavení je nastavena možnost CreateNewReport.

Hodnota Description
OverwritePreviousReport
CreateNewReport

DestinationType

Typ cíle doručení exportu. V současné době se podporuje jenom AzureBlob.

Hodnota Description
AzureBlob

ErrorDetails

Podrobnosti o chybě.

Name Typ 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\nNěkteré chybové odpovědi: \n\n * 429 TooManyRequests - Požadavky jsou omezeny. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after. \n\n * 503 Nedostupná služba - Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.

Name Typ Description
error

ErrorDetails

Podrobnosti o chybě.

ExecutionStatus

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

Hodnota Description
Queued
InProgress
Completed
Failed
Timeout
NewDataNotAvailable
DataNotAvailable

ExecutionType

Typ spuštění exportu.

Hodnota Description
OnDemand
Scheduled

Export

Prostředek exportu.

Name Typ 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 (arm-id)

Plně kvalifikované ID prostředku pro prostředek. Např. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

SystemAssignedServiceIdentity

Spravovaná identita přidružená k exportu

location

string

Umístění spravované identity exportu. Vyžaduje se pouze při využití spravované identity.

name

string

Název prostředku

properties.compressionMode

CompressionModeType

Umožňuje zákazníkům vybrat komprimovat data pro exporty. Toto nastavení povolí schéma komprese cílových souborů za běhu. Ve výchozím nastavení je nastavená hodnota Žádné. Gzip je pro csv a přichycení pro parquet.

properties.dataOverwriteBehavior

DataOverwriteBehaviorType

Povolit zákazníkům výběr přepsání dat (OverwritePreviousReport) pro exporty. Toto nastavení povolí přepsání dat za stejný měsíc v účtu úložiště zákazníka. Ve výchozím nastavení je nastavena možnost CreateNewReport.

properties.definition

ExportDefinition

Má definici pro export.

properties.deliveryInfo

ExportDeliveryInfo

Obsahuje informace o doručení pro export.

properties.exportDescription

string

Popis exportu nastavený zákazníkem při vytváření nebo aktualizaci exportu.

properties.format

FormatType

Formát doručované exportu.

properties.nextRunTimeEstimate

string (date-time)

Pokud má export aktivní plán, poskytne odhad příštího běhu.

properties.partitionData

boolean

Pokud je nastavená hodnota true, exportovaná data se rozdělí podle velikosti a umístí se do adresáře objektů blob společně se souborem manifestu.

properties.runHistory

ExportExecutionListResult

Pokud je to požadováno, obsahuje nejnovější historii spuštění pro export.

properties.schedule

ExportSchedule

Obsahuje informace o plánu exportu.

properties.systemSuspensionContext

ExportSuspensionContext

Důvod pozastavení exportu, pokud je export ve stavu SystemSuspended. To není v současné době obsazeno.

systemData

systemData

Metadata služby Azure Resource Manager obsahující informace o tom, kdo jej vytvořil a upravil.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ExportDataset

Definice dat v exportu.

Name Typ Description
configuration

ExportDatasetConfiguration

Konfigurace exportu datové sady

granularity

GranularityType

Členitost řádků v exportu Ve většině případů se v současné době podporuje "Denně".

ExportDatasetConfiguration

To je na cestě k vyřazení a nebude podporováno dále.

Name Typ 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 kanálu zákazníka (viz příklady).

dataVersion

string

Datová verze vybraného pro export. Pokud ho nezadáte, export se ve výchozím nastavení použije k nejnovější verzi dat.

filters

FilterItems[]

Filtry přidružené k datovým sadám

ExportDefinition

Definice exportu.

Name Typ Description
dataSet

ExportDataset

Definice dat v exportu.

timePeriod

ExportTimePeriod

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

timeframe

TimeframeType

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

type

ExportType

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

ExportDeliveryDestination

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 získala přístup k úložišti. Při vytváření exportu na webu 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 k dispozici pouze partnerům s plánem smlouvy s partnerem Microsoftu, kteří 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 se službou Service, kontejnerem nebo objektovými typy prostředků a s oprávněními ke čtení, zápisu, odstranění, 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 Typ 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 se nevyžaduje, pokud je zadán sasToken a storageAccount.

rootFolderPath

string

Název adresáře, do kterého se exporty nahrají.

sasToken

string (password)

Token SAS pro účet úložiště. Pro omezenou sadu zákazníků Azure je možné místo id prostředku zadat parametr storageAccount. Poznámka: Hodnota vrácená rozhraním API pro tuto vlastnost bude vždy obfuskována. Vrácení stejné 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.

type

DestinationType

Typ cíle doručení exportu. V současné době se podporuje jenom AzureBlob.

ExportDeliveryInfo

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

Name Typ Description
destination

ExportDeliveryDestination

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

ExportExecutionListResult

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

Name Typ Description
value

ExportRun[]

Seznam spuštění exportu

ExportRecurrencePeriod

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

Name Typ Description
from

string (date-time)

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

to

string (date-time)

Koncové datum opakování.

ExportRun

Spuštění exportu

Name Typ 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.endDate

string (date-time)

Koncové datum a čas exportu.

properties.error

ErrorDetails

Podrobnosti o jakékoli chybě.

properties.executionType

ExecutionType

Typ spuštění exportu.

properties.fileName

string

Název exportovaného souboru.

properties.manifestFile

string

Umístění souboru manifestu (umístění identifikátoru URI) pro exportované soubory.

properties.processingEndTime

string (date-time)

Čas dokončení exportu

properties.processingStartTime

string (date-time)

Čas, kdy se export vyzvedl, aby se spustil.

properties.runSettings

CommonExportProperties

Nastavení exportu, která se pro toto spuštění projevila.

properties.startDate

string (date-time)

Počáteční datum a čas exportu.

properties.status

ExecutionStatus

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

properties.submittedBy

string

Identifikátor entity, která aktivovala export. Pro spuštění na vyžádání se jedná o e-mail uživatele. Pro naplánovaná spuštění se jedná o systém.

properties.submittedTime

string (date-time)

Čas, kdy se export zařadil do fronty, aby se spustil.

type

string

Typ zdroje.

ExportSchedule

Plán přidružený k exportu.

Name Typ Description
recurrence

RecurrenceType

Opakování plánu.

recurrencePeriod

ExportRecurrencePeriod

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

StatusType

Stav plánu exportu Pokud je neaktivní, plán exportu se pozastaví. Pokud chcete povolit, aby byl export aktivní, a pak proveďte požadavek PUT.

ExportSuspensionContext

Vlastnosti spuštění exportu. To není v současné době obsazeno.

Name Typ Description
suspensionCode

string

Kód pro pozastavení exportu.

suspensionReason

string

Podrobný důvod pozastavení vývozu.

suspensionTime

string (date-time)

Čas pozastavení exportu.

ExportTimePeriod

Rozsah kalendářních 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í časové období je 1 kalendářní měsíc.

Name Typ Description
from

string (date-time)

Počáteční datum exportu dat.

to

string (date-time)

Koncové datum exportu dat.

ExportType

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

Hodnota Description
Usage
ActualCost
AmortizedCost
FocusCost
PriceSheet
ReservationTransactions
ReservationRecommendations
ReservationDetails

FilterItemNames

Název filtru. Tento typ definice exportu se v současné době podporuje jenom u doporučení ReservationRecommendations. Podporované názvy jsou ['ReservationScope', 'LookBackPeriod', 'ResourceType']

Hodnota Description
ReservationScope
ResourceType
LookBackPeriod

FilterItems

Bude obsahovat název a hodnotu filtru, se kterou chcete pracovat. Tento typ definice exportu se v současné době podporuje jenom u doporučení ReservationRecommendations.

Name Typ Description
name

FilterItemNames

Název filtru. Tento typ definice exportu se v současné době podporuje jenom u doporučení ReservationRecommendations. Podporované názvy jsou ['ReservationScope', 'LookBackPeriod', 'ResourceType']

value

string

Hodnota, podle které chcete filtrovat. V současné době jsou podporované hodnoty pro každý název. Pro podporované hodnoty ReservationScope jsou podporované hodnoty ['Single', 'Shared'], pro podporované hodnoty LookBackPeriod jsou ['Last7Days', 'Last30Days', 'Last60Days'] a pro podporované hodnoty ResourceType jsou ['VirtualMachines', SQLDatabases, PostgreSQL, ManagedDisk, MySQL, RedHat, MariaDB, RedisCache, CosmosDB, SqlDataWarehouse, SUSELinux, AppService, BlockBlob, AzureDataExplorer, VMwareCloudSimple.

FormatType

Formát doručované exportu.

Hodnota Description
Csv
Parquet

GranularityType

Členitost řádků v exportu Ve většině případů se v současné době podporuje "Denně".

Hodnota Description
Daily
Monthly

RecurrenceType

Opakování plánu.

Hodnota Description
Daily
Weekly
Monthly
Annually

StatusType

Stav plánu exportu Pokud je neaktivní, plán exportu se pozastaví. Pokud chcete povolit, aby byl export aktivní, a pak proveďte požadavek PUT.

Hodnota Description
Active
Inactive

SystemAssignedServiceIdentity

Identita spravované služby (přiřazená systémem nebo žádná)

Name Typ Description
principalId

string (uuid)

ID instančního objektu identity přiřazené systémem. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.

tenantId

string (uuid)

ID tenanta přiřazené identity systému. Tato vlastnost bude poskytována pouze pro identitu přiřazenou systémem.

type

SystemAssignedServiceIdentityType

Typ identity spravované služby (přiřazený systémem nebo žádný).

SystemAssignedServiceIdentityType

Typ identity spravované služby (přiřazený systémem nebo žádný).

Hodnota Description
None
SystemAssigned

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string (date-time)

Časové razítko vytvoření prostředku (UTC).

createdBy

string

Identita, která prostředek vytvořila.

createdByType

createdByType

Typ identity, která prostředek vytvořila.

lastModifiedAt

string (date-time)

Časové razítko poslední změny zdroje (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

TimeframeType

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

Hodnota Description
MonthToDate
BillingMonthToDate
TheLastMonth
TheLastBillingMonth
WeekToDate
Custom
TheCurrentMonth