Exports - Get

Service:: Cost Management

API Version:: 2020-06-01

Operacja pobierania eksportu dla zdefiniowanego zakresu przez nazwę eksportu.

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

With optional parameters:

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

Parametry identyfikatora URI

Name	In	Required	Type	Description
exportName	path	True	string	Nazwa eksportu.
scope	path	True	string	Zakres skojarzony z operacjami eksportu. Obejmuje to "/subscriptions/{subscriptionId}/" dla zakresu subskrypcji "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" dla zakresu grupy zasobów, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" dla zakresu konta rozliczeń i "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" dla zakresu działu, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}" dla zakresu EnrollmentAccount, "/providers/Microsoft.Management/managementGroups/{managementGroupId} dla zakresu grupy zarządzania,"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} "dla zakresu billingProfile,"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId} "dla zakresu invoiceSection oraz"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId} "dla partnerów.
api-version	query	True	string	Wersja interfejsu API, która ma być używana z żądaniem klienta. Bieżąca wersja to 2020-06-01.
$expand	query		string	Może służyć do rozszerzania właściwości w ramach eksportu. Obecnie jest obsługiwana tylko wartość "Runhistory (", która zwraca informacje dla ostatnich 10 wykonań eksportu.

Odpowiedzi

Name	Type	Description
200 OK	Export	OK. Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd z opisem przyczyny niepowodzenia operacji.

Zabezpieczenia

azure_auth

Azure Active Directory przepływ OAuth2.

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

Scopes

Name	Description
user_impersonation	Personifikuj konto użytkownika

Przykłady

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

Status code:: 200

{
  "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

Status code:: 200

{
  "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

Status code:: 200

{
  "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

Status code:: 200

{
  "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

Status code:: 200

{
  "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

Status code:: 200

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

Definicje

CommonExportProperties	Wspólne właściwości eksportu.
ErrorDetails	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Powód jest podany w komunikacie o błędzie. Niektóre odpowiedzi na błędy: 429 TooManyRequests — żądanie jest ograniczone. Ponów próbę po upływie czasu określonego w nagłówku "x-MS-ratelimit-Microsoft. zużycie-retry-After". 503 serviceniedostępny — usługa jest tymczasowo niedostępna. Ponów próbę po oczekiwaniu na czas określony w nagłówku "ponawianie po".
ExecutionStatus	Ostatni znany stan wykonania eksportu.
ExecutionType	Typ wykonania eksportu.
Export	Zasób eksportu.
ExportDataset	Definicja danych eksportu.
ExportDatasetConfiguration	Konfiguracja eksportu zestawu danych. Umożliwia wybranie kolumn do wyeksportowania. Jeśli nie zostanie podany, eksport obejmie wszystkie dostępne kolumny.
ExportDefinition	Definicja eksportu.
ExportDeliveryDestination	Informacje o miejscu docelowym dostarczania eksportu. Aby zezwolić na dostęp do konta magazynu, należy zarejestrować subskrypcję konta za pomocą dostawcy zasobów Microsoft. CostManagementExports. Jest to wymagane raz na subskrypcję. Podczas tworzenia eksportu w Azure Portal są one wykonywane automatycznie, jednak użytkownicy interfejsu API muszą zarejestrować subskrypcję. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .
ExportDeliveryInfo	Informacje o dostarczaniu skojarzone z eksportem.
ExportExecution	Wykonanie eksportu.
ExportExecutionListResult	Wynik tworzenia listy historii wykonywania eksportu.
ExportRecurrencePeriod	Data rozpoczęcia i zakończenia harmonogramu cyklu.
ExportSchedule	Harmonogram skojarzony z eksportem.
ExportTimePeriod	Zakres dat dla danych eksportu. Ta wartość powinna być określona tylko z przedziałem czasu ustawionym na wartość "Custom". Maksymalny zakres dat to 3 miesiące.
ExportType	Typ eksportu. Należy zauważyć, że element "Usage" jest odpowiednikiem "ActualCost" i ma zastosowanie do eksportów, które jeszcze nie zapewniają danych do naliczania opłat lub amortyzacji dla rezerwacji usług.
FormatType	Format dostarczanego eksportu. Obecnie jest obsługiwany tylko element "CSV".
GranularityType	Stopień szczegółowości wierszy eksportu. Obecnie jest obsługiwana tylko "dzienna".
RecurrenceType	Cykl harmonogramu.
StatusType	Stan harmonogramu eksportu. W przypadku braku nieaktywnego harmonogramu eksportu jest wstrzymany.
TimeframeType	Przedział czasu służący do ściągania danych eksportu. Jeśli jest to niestandardowa, należy podać określony przedział czasu.

CommonExportProperties

Wspólne właściwości eksportu.

Name	Type	Description
definition	ExportDefinition	Ma definicję eksportu.
deliveryInfo	ExportDeliveryInfo	Zawiera informacje o dostawie eksportu.
format	FormatType	Format dostarczanego eksportu. Obecnie jest obsługiwany tylko element "CSV".
nextRunTimeEstimate	string	Jeśli eksport ma aktywny harmonogram, program udostępnia oszacowanie czasu następnego wykonania.
runHistory	ExportExecutionListResult	Jeśli jest to wymagane, program ma najnowszą historię wykonywania eksportu.

ErrorDetails

Szczegóły błędu.

Name	Type	Description
code	string	Kod błędu.
message	string	Komunikat o błędzie informujący o tym, dlaczego operacja nie powiodła się.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Powód jest podany w komunikacie o błędzie.

Niektóre odpowiedzi na błędy:

429 TooManyRequests — żądanie jest ograniczone. Ponów próbę po upływie czasu określonego w nagłówku "x-MS-ratelimit-Microsoft. zużycie-retry-After".
503 serviceniedostępny — usługa jest tymczasowo niedostępna. Ponów próbę po oczekiwaniu na czas określony w nagłówku "ponawianie po".

Name	Type	Description
error	ErrorDetails	Szczegóły błędu.

ExecutionStatus

Ostatni znany stan wykonania eksportu.

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

ExecutionType

Typ wykonania eksportu.

Name	Type	Description
OnDemand	string
Scheduled	string

Export

Zasób eksportu.

Name	Type	Description
eTag	string	element eTag zasobu. Aby obsłużyć scenariusz współbieżnej aktualizacji, to pole będzie używane do określenia, czy użytkownik aktualizuje najnowszą wersję, czy nie.
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.definition	ExportDefinition	Ma definicję eksportu.
properties.deliveryInfo	ExportDeliveryInfo	Zawiera informacje o dostawie eksportu.
properties.format	FormatType	Format dostarczanego eksportu. Obecnie jest obsługiwany tylko element "CSV".
properties.nextRunTimeEstimate	string	Jeśli eksport ma aktywny harmonogram, program udostępnia oszacowanie czasu następnego wykonania.
properties.runHistory	ExportExecutionListResult	Jeśli jest to wymagane, program ma najnowszą historię wykonywania eksportu.
properties.schedule	ExportSchedule	Zawiera informacje dotyczące harmonogramu eksportu.
type	string	Typ zasobu.

ExportDataset

Definicja danych eksportu.

Name	Type	Description
configuration	ExportDatasetConfiguration	Konfiguracja eksportu zestawu danych.
granularity	GranularityType	Stopień szczegółowości wierszy eksportu. Obecnie jest obsługiwana tylko "dzienna".

ExportDatasetConfiguration

Konfiguracja eksportu zestawu danych. Umożliwia wybranie kolumn do wyeksportowania. Jeśli nie zostanie podany, eksport obejmie wszystkie dostępne kolumny.

Name	Type	Description
columns	string[]	Tablica nazw kolumn do uwzględnienia w wyeksportowaniu. Jeśli nie zostanie podany, eksport obejmie wszystkie dostępne kolumny. Dostępne kolumny mogą się różnić w zależności od kanału klienta (Zobacz przykłady).

ExportDefinition

Definicja eksportu.

Name	Type	Description
dataSet	ExportDataset	Definicja danych eksportu.
timePeriod	ExportTimePeriod	Zawiera okres pobierania danych do wyeksportowania.
timeframe	TimeframeType	Przedział czasu służący do ściągania danych eksportu. Jeśli jest to niestandardowa, należy podać określony przedział czasu.
type	ExportType	Typ eksportu. Należy zauważyć, że element "Usage" jest odpowiednikiem "ActualCost" i ma zastosowanie do eksportów, które jeszcze nie zapewniają danych do naliczania opłat lub amortyzacji dla rezerwacji usług.

ExportDeliveryDestination

Informacje o miejscu docelowym dostarczania eksportu. Aby zezwolić na dostęp do konta magazynu, należy zarejestrować subskrypcję konta za pomocą dostawcy zasobów Microsoft. CostManagementExports. Jest to wymagane raz na subskrypcję. Podczas tworzenia eksportu w Azure Portal są one wykonywane automatycznie, jednak użytkownicy interfejsu API muszą zarejestrować subskrypcję. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .

Name	Type	Description
container	string	Nazwa kontenera, w którym będą przekazywane eksporty.
resourceId	string	Identyfikator zasobu konta magazynu, w którym będą dostarczane operacje eksportowania.
rootFolderPath	string	Nazwa katalogu, w którym będą przekazywane eksporty.

ExportDeliveryInfo

Informacje o dostarczaniu skojarzone z eksportem.

Name	Type	Description
destination	ExportDeliveryDestination	Ma miejsce docelowe dla dostarczanego eksportu.

ExportExecution

Wykonanie eksportu.

Name	Type	Description
eTag	string	element eTag zasobu. Aby obsłużyć scenariusz współbieżnej aktualizacji, to pole będzie używane do określenia, czy użytkownik aktualizuje najnowszą wersję, czy nie.
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.error	ErrorDetails	Szczegóły dowolnego błędu.
properties.executionType	ExecutionType	Typ wykonania eksportu.
properties.fileName	string	Nazwa wyeksportowanego pliku.
properties.processingEndTime	string	Czas zakończenia wykonywania eksportu.
properties.processingStartTime	string	Czas, w którym został pobrany, aby można było wykonać eksport.
properties.runSettings	CommonExportProperties	Ustawienia eksportu, które obowiązywały dla tego wykonania.
properties.status	ExecutionStatus	Ostatni znany stan wykonania eksportu.
properties.submittedBy	string	Identyfikator jednostki, która wykonała eksport. W przypadku wykonań OnDemand jest to adres e-mail użytkownika. W przypadku planowanych wykonań jest to "system".
properties.submittedTime	string	Czas, w którym eksport został umieszczony w kolejce do wykonania.
type	string	Typ zasobu.

ExportExecutionListResult

Wynik tworzenia listy historii wykonywania eksportu.

Name	Type	Description
value	ExportExecution[]	Lista wykonań eksportu.

ExportRecurrencePeriod

Data rozpoczęcia i zakończenia harmonogramu cyklu.

Name	Type	Description
from	string	Data rozpoczęcia cyklu.
to	string	Data zakończenia cyklu.

ExportSchedule

Harmonogram skojarzony z eksportem.

Name	Type	Description
recurrence	RecurrenceType	Cykl harmonogramu.
recurrencePeriod	ExportRecurrencePeriod	Ma datę początkową i końcową cyklu. Data rozpoczęcia musi przypadać w przyszłości. Jeśli jest obecny, Data zakończenia musi być późniejsza niż data rozpoczęcia.
status	StatusType	Stan harmonogramu eksportu. W przypadku braku nieaktywnego harmonogramu eksportu jest wstrzymany.

ExportTimePeriod

Zakres dat dla danych eksportu. Ta wartość powinna być określona tylko z przedziałem czasu ustawionym na wartość "Custom". Maksymalny zakres dat to 3 miesiące.

Name	Type	Description
from	string	Data rozpoczęcia eksportowania danych.
to	string	Data zakończenia eksportowania danych.

ExportType

Typ eksportu. Należy zauważyć, że element "Usage" jest odpowiednikiem "ActualCost" i ma zastosowanie do eksportów, które jeszcze nie zapewniają danych do naliczania opłat lub amortyzacji dla rezerwacji usług.

Name	Type	Description
ActualCost	string
AmortizedCost	string
Usage	string

FormatType

Format dostarczanego eksportu. Obecnie jest obsługiwany tylko element "CSV".

Name	Type	Description
Csv	string

GranularityType

Stopień szczegółowości wierszy eksportu. Obecnie jest obsługiwana tylko "dzienna".

Name	Type	Description
Daily	string

RecurrenceType

Cykl harmonogramu.

Name	Type	Description
Annually	string
Daily	string
Monthly	string
Weekly	string

StatusType

Stan harmonogramu eksportu. W przypadku braku nieaktywnego harmonogramu eksportu jest wstrzymany.

Name	Type	Description
Active	string
Inactive	string

TimeframeType

Przedział czasu służący do ściągania danych eksportu. Jeśli jest to niestandardowa, należy podać określony przedział czasu.

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

Exports - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

ExportGetByBillingAccount

Sample Request

Sample Response

ExportGetByDepartment

Sample Request

Sample Response

ExportGetByEnrollmentAccount

Sample Request

Sample Response

ExportGetByManagementGroup

Sample Request

Sample Response

ExportGetByResourceGroup

Sample Request

Sample Response

ExportGetBySubscription

Sample Request

Sample Response

Definicje

CommonExportProperties

ErrorDetails

ErrorResponse

ExecutionStatus

ExecutionType

Export

ExportDataset

ExportDatasetConfiguration

ExportDefinition

ExportDeliveryDestination

ExportDeliveryInfo

ExportExecution

ExportExecutionListResult

ExportRecurrencePeriod

ExportSchedule

ExportTimePeriod

ExportType

FormatType

GranularityType

RecurrenceType

StatusType

TimeframeType

Czy ta strona jest pomocna?

Czy ta strona jest pomocna?