Bagikan melalui


Exports - Get

Operasi untuk mendapatkan ekspor untuk cakupan yang ditentukan berdasarkan nama ekspor.

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}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
exportName
path True

string

Ekspor Nama.

scope
path True

string

Pengidentifikasi Azure Resource manager sumber daya yang sepenuhnya memenuhi syarat.

api-version
query True

string

minLength: 1

Versi API yang digunakan untuk operasi ini.

$expand
query

string

Dapat digunakan untuk memperluas properti dalam ekspor. Saat ini hanya 'runHistory' yang didukung dan akan mengembalikan informasi untuk 10 eksekusi ekspor terakhir.

Respons

Nama Jenis Deskripsi
200 OK

Export

Operasi Azure berhasil diselesaikan.

Other Status Codes

ErrorResponse

Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

ExportGetByBillingAccount
ExportGetByDepartment
ExportGetByEnrollmentAccount
ExportGetByManagementGroup
ExportGetByResourceGroup
ExportGetBySubscription

ExportGetByBillingAccount

Permintaan sampel

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

Respon sampel

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

Permintaan sampel

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

Respon sampel

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

Permintaan sampel

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

Respon sampel

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

Permintaan sampel

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

Respon sampel

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

Permintaan sampel

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

Respon sampel

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

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
CommonExportProperties

Properti umum ekspor.

CompressionModeType

Izinkan pelanggan memilih kompres data untuk ekspor. Pengaturan ini akan mengaktifkan skema pemadatan file tujuan saat runtime. Secara default diatur ke Tidak Ada. Gzip adalah untuk csv dan snappy untuk parkek.

createdByType

Jenis identitas yang membuat sumber daya.

DataOverwriteBehaviorType

Izinkan pelanggan untuk memilih timpa data (OverwritePreviousReport) untuk ekspor. Pengaturan ini akan mengaktifkan timpa data untuk bulan yang sama di akun penyimpanan pelanggan. Secara default diatur ke CreateNewReport.

DestinationType

Jenis tujuan pengiriman ekspor. Saat ini hanya 'AzureBlob' yang didukung.

ErrorDetails

Detail kesalahan.

ErrorResponse

Respons kesalahan menunjukkan bahwa layanan tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan. \n\nBeberapa respons Kesalahan: \n\n * 429 TooManyRequests - Permintaan dibatasi. Coba lagi setelah menunggu waktu yang ditentukan dalam header "x-ms-ratelimit-microsoft.consumption-retry-after". \n\n * 503 ServiceUnavailable - Layanan tidak tersedia untuk sementara. Coba lagi setelah menunggu waktu yang ditentukan di header "Coba Lagi-Setelah".

ExecutionStatus

Status terakhir yang diketahui dari eksekusi ekspor.

ExecutionType

Jenis eksekusi ekspor.

Export

Sumber daya ekspor.

ExportDataset

Definisi untuk data dalam ekspor.

ExportDatasetConfiguration

Ini berada di jalur untuk penghentian dan tidak akan didukung ke depannya.

ExportDefinition

Definisi ekspor.

ExportDeliveryDestination

Ini mewakili lokasi akun penyimpanan blob tempat ekspor biaya akan dikirimkan. Ada dua cara untuk mengonfigurasi tujuan. Pendekatan yang direkomendasikan untuk sebagian besar pelanggan adalah menentukan resourceId akun penyimpanan. Ini memerlukan pendaftaran satu kali langganan akun dengan penyedia sumber daya Microsoft.CostManagementExports untuk memberikan akses layanan Cost Management ke penyimpanan. Saat membuat ekspor di portal Microsoft Azure, pendaftaran ini dilakukan secara otomatis tetapi pengguna API mungkin perlu mendaftarkan langganan secara eksplisit (untuk informasi selengkapnya, lihat https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Cara lain untuk mengonfigurasi tujuan hanya tersedia untuk Mitra dengan paket Perjanjian Mitra Microsoft yang merupakan admin global akun penagihan mereka. Mitra ini, alih-alih menentukan resourceId akun penyimpanan, dapat menentukan nama akun penyimpanan bersama dengan token SAS untuk akun tersebut. Ini memungkinkan ekspor biaya ke akun penyimpanan di penyewa mana pun. Token SAS harus dibuat untuk layanan blob dengan jenis sumber daya Layanan/Kontainer/Objek dan dengan izin Baca/Tulis/Hapus/Daftar/Tambahkan/Buat (untuk informasi selengkapnya lihat https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).

ExportDeliveryInfo

Informasi pengiriman yang terkait dengan ekspor.

ExportExecutionListResult

Hasil daftar riwayat eksekusi ekspor.

ExportRecurrencePeriod

Tanggal mulai dan berakhir untuk jadwal pengulangan.

ExportRun

Eksekusi ekspor.

ExportSchedule

Jadwal yang terkait dengan ekspor.

ExportSuspensionContext

Properti eksekusi ekspor. Ini tidak dihuni saat ini.

ExportTimePeriod

Rentang tanggal untuk data dalam ekspor. Ini hanya boleh ditentukan dengan timeFrame diatur ke 'Kustom'. Rentang tanggal maksimum adalah 1 bulan kalender.

ExportType

Jenis ekspor. Perhatikan bahwa 'Penggunaan' setara dengan 'ActualCost' dan berlaku untuk ekspor yang belum menyediakan data untuk biaya atau amortisasi untuk reservasi layanan.

FilterItemNames

Nama filter. Ini saat ini hanya didukung untuk jenis Definisi Ekspor dari ReservationRecommendations. Nama yang didukung adalah ['ReservationScope', 'LookBackPeriod', 'ResourceType']

FilterItems

Akan berisi nama filter dan nilai untuk dioperasikan. Ini saat ini hanya didukung untuk jenis Definisi Ekspor dari ReservationRecommendations.

FormatType

Format ekspor yang dikirimkan.

GranularityType

Granularitas baris dalam ekspor. Saat ini 'Harian' didukung untuk sebagian besar kasus.

RecurrenceType

Pengulangan jadwal.

StatusType

Status jadwal ekspor. Jika 'Tidak Aktif', jadwal ekspor akan dijeda. Untuk mengaktifkan ekspor, atur status menjadi Aktif lalu buat permintaan PUT.

SystemAssignedServiceIdentity

Identitas layanan terkelola (baik yang ditetapkan sistem, atau tidak ada)

SystemAssignedServiceIdentityType

Jenis identitas layanan terkelola (baik yang ditetapkan sistem, atau tidak ada).

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

TimeframeType

Jangka waktu untuk menarik data untuk ekspor. Jika kustom, maka periode waktu tertentu harus disediakan.

CommonExportProperties

Properti umum ekspor.

Nama Jenis Deskripsi
compressionMode

CompressionModeType

Izinkan pelanggan memilih kompres data untuk ekspor. Pengaturan ini akan mengaktifkan skema pemadatan file tujuan saat runtime. Secara default diatur ke Tidak Ada. Gzip adalah untuk csv dan snappy untuk parkek.

dataOverwriteBehavior

DataOverwriteBehaviorType

Izinkan pelanggan untuk memilih timpa data (OverwritePreviousReport) untuk ekspor. Pengaturan ini akan mengaktifkan timpa data untuk bulan yang sama di akun penyimpanan pelanggan. Secara default diatur ke CreateNewReport.

definition

ExportDefinition

Memiliki definisi untuk ekspor.

deliveryInfo

ExportDeliveryInfo

Memiliki informasi pengiriman untuk ekspor.

exportDescription

string

Deskripsi ekspor yang ditetapkan oleh pelanggan pada saat pembuatan/pembaruan ekspor.

format

FormatType

Format ekspor yang dikirimkan.

nextRunTimeEstimate

string (date-time)

Jika ekspor memiliki jadwal aktif, berikan perkiraan waktu proses berikutnya.

partitionData

boolean

Jika diatur ke true, data yang diekspor akan dipartisi berdasarkan ukuran dan ditempatkan dalam direktori blob bersama dengan file manifes.

runHistory

ExportExecutionListResult

Jika diminta, memiliki riwayat eksekusi terbaru untuk ekspor.

systemSuspensionContext

ExportSuspensionContext

Alasan penangguhan ekspor jika ekspor dalam status SystemSuspended. Ini tidak dihuni saat ini.

CompressionModeType

Izinkan pelanggan memilih kompres data untuk ekspor. Pengaturan ini akan mengaktifkan skema pemadatan file tujuan saat runtime. Secara default diatur ke Tidak Ada. Gzip adalah untuk csv dan snappy untuk parkek.

Nilai Deskripsi
gzip
snappy
none

createdByType

Jenis identitas yang membuat sumber daya.

Nilai Deskripsi
User
Application
ManagedIdentity
Key

DataOverwriteBehaviorType

Izinkan pelanggan untuk memilih timpa data (OverwritePreviousReport) untuk ekspor. Pengaturan ini akan mengaktifkan timpa data untuk bulan yang sama di akun penyimpanan pelanggan. Secara default diatur ke CreateNewReport.

Nilai Deskripsi
OverwritePreviousReport
CreateNewReport

DestinationType

Jenis tujuan pengiriman ekspor. Saat ini hanya 'AzureBlob' yang didukung.

Nilai Deskripsi
AzureBlob

ErrorDetails

Detail kesalahan.

Nama Jenis Deskripsi
code

string

Kode kesalahan.

message

string

Pesan kesalahan yang menunjukkan mengapa operasi gagal.

ErrorResponse

Respons kesalahan menunjukkan bahwa layanan tidak dapat memproses permintaan masuk. Alasannya disediakan dalam pesan kesalahan. \n\nBeberapa respons Kesalahan: \n\n * 429 TooManyRequests - Permintaan dibatasi. Coba lagi setelah menunggu waktu yang ditentukan dalam header "x-ms-ratelimit-microsoft.consumption-retry-after". \n\n * 503 ServiceUnavailable - Layanan tidak tersedia untuk sementara. Coba lagi setelah menunggu waktu yang ditentukan di header "Coba Lagi-Setelah".

Nama Jenis Deskripsi
error

ErrorDetails

Detail kesalahan.

ExecutionStatus

Status terakhir yang diketahui dari eksekusi ekspor.

Nilai Deskripsi
Queued
InProgress
Completed
Failed
Timeout
NewDataNotAvailable
DataNotAvailable

ExecutionType

Jenis eksekusi ekspor.

Nilai Deskripsi
OnDemand
Scheduled

Export

Sumber daya ekspor.

Nama Jenis Deskripsi
eTag

string

eTag sumber daya. Untuk menangani skenario pembaruan bersamaan, bidang ini akan digunakan untuk menentukan apakah pengguna memperbarui versi terbaru atau tidak.

id

string (arm-id)

ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

SystemAssignedServiceIdentity

Identitas terkelola yang terkait dengan Ekspor

location

string

Lokasi identitas terkelola Ekspor. Hanya diperlukan saat menggunakan identitas terkelola.

name

string

Nama sumber daya

properties.compressionMode

CompressionModeType

Izinkan pelanggan memilih kompres data untuk ekspor. Pengaturan ini akan mengaktifkan skema pemadatan file tujuan saat runtime. Secara default diatur ke Tidak Ada. Gzip adalah untuk csv dan snappy untuk parkek.

properties.dataOverwriteBehavior

DataOverwriteBehaviorType

Izinkan pelanggan untuk memilih timpa data (OverwritePreviousReport) untuk ekspor. Pengaturan ini akan mengaktifkan timpa data untuk bulan yang sama di akun penyimpanan pelanggan. Secara default diatur ke CreateNewReport.

properties.definition

ExportDefinition

Memiliki definisi untuk ekspor.

properties.deliveryInfo

ExportDeliveryInfo

Memiliki informasi pengiriman untuk ekspor.

properties.exportDescription

string

Deskripsi ekspor yang ditetapkan oleh pelanggan pada saat pembuatan/pembaruan ekspor.

properties.format

FormatType

Format ekspor yang dikirimkan.

properties.nextRunTimeEstimate

string (date-time)

Jika ekspor memiliki jadwal aktif, berikan perkiraan waktu proses berikutnya.

properties.partitionData

boolean

Jika diatur ke true, data yang diekspor akan dipartisi berdasarkan ukuran dan ditempatkan dalam direktori blob bersama dengan file manifes.

properties.runHistory

ExportExecutionListResult

Jika diminta, memiliki riwayat eksekusi terbaru untuk ekspor.

properties.schedule

ExportSchedule

Memiliki informasi jadwal untuk ekspor.

properties.systemSuspensionContext

ExportSuspensionContext

Alasan penangguhan ekspor jika ekspor dalam status SystemSuspended. Ini tidak dihuni saat ini.

systemData

systemData

Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.

type

string

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ExportDataset

Definisi untuk data dalam ekspor.

Nama Jenis Deskripsi
configuration

ExportDatasetConfiguration

Konfigurasi himpunan data ekspor.

granularity

GranularityType

Granularitas baris dalam ekspor. Saat ini 'Harian' didukung untuk sebagian besar kasus.

ExportDatasetConfiguration

Ini berada di jalur untuk penghentian dan tidak akan didukung ke depannya.

Nama Jenis Deskripsi
columns

string[]

Array nama kolom yang akan disertakan dalam ekspor. Jika tidak disediakan, maka ekspor akan menyertakan semua kolom yang tersedia. Kolom yang tersedia dapat bervariasi menurut saluran pelanggan (lihat contoh).

dataVersion

string

Versi data untuk yang dipilih untuk ekspor. Jika tidak disediakan, maka ekspor akan default ke versi data terbaru.

filters

FilterItems[]

Filter yang terkait dengan himpunan data.

ExportDefinition

Definisi ekspor.

Nama Jenis Deskripsi
dataSet

ExportDataset

Definisi untuk data dalam ekspor.

timePeriod

ExportTimePeriod

Memiliki periode waktu untuk menarik data untuk ekspor.

timeframe

TimeframeType

Jangka waktu untuk menarik data untuk ekspor. Jika kustom, maka periode waktu tertentu harus disediakan.

type

ExportType

Jenis ekspor. Perhatikan bahwa 'Penggunaan' setara dengan 'ActualCost' dan berlaku untuk ekspor yang belum menyediakan data untuk biaya atau amortisasi untuk reservasi layanan.

ExportDeliveryDestination

Ini mewakili lokasi akun penyimpanan blob tempat ekspor biaya akan dikirimkan. Ada dua cara untuk mengonfigurasi tujuan. Pendekatan yang direkomendasikan untuk sebagian besar pelanggan adalah menentukan resourceId akun penyimpanan. Ini memerlukan pendaftaran satu kali langganan akun dengan penyedia sumber daya Microsoft.CostManagementExports untuk memberikan akses layanan Cost Management ke penyimpanan. Saat membuat ekspor di portal Microsoft Azure, pendaftaran ini dilakukan secara otomatis tetapi pengguna API mungkin perlu mendaftarkan langganan secara eksplisit (untuk informasi selengkapnya, lihat https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Cara lain untuk mengonfigurasi tujuan hanya tersedia untuk Mitra dengan paket Perjanjian Mitra Microsoft yang merupakan admin global akun penagihan mereka. Mitra ini, alih-alih menentukan resourceId akun penyimpanan, dapat menentukan nama akun penyimpanan bersama dengan token SAS untuk akun tersebut. Ini memungkinkan ekspor biaya ke akun penyimpanan di penyewa mana pun. Token SAS harus dibuat untuk layanan blob dengan jenis sumber daya Layanan/Kontainer/Objek dan dengan izin Baca/Tulis/Hapus/Daftar/Tambahkan/Buat (untuk informasi selengkapnya lihat https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).

Nama Jenis Deskripsi
container

string

Nama kontainer tempat ekspor akan diunggah. Jika kontainer tidak ada, kontainer akan dibuat.

resourceId

string

Id sumber daya akun penyimpanan tempat ekspor akan dikirimkan. Ini tidak diperlukan jika sasToken dan storageAccount ditentukan.

rootFolderPath

string

Nama direktori tempat ekspor akan diunggah.

sasToken

string (password)

Token SAS untuk akun penyimpanan. Untuk sekumpulan pelanggan Azure terbatas, ini bersama dengan storageAccount dapat ditentukan alih-alih resourceId. Catatan: nilai yang dikembalikan oleh API untuk properti ini akan selalu dikaburkan. Mengembalikan nilai yang dikaburkan yang sama ini tidak akan mengakibatkan token SAS diperbarui. Untuk memperbarui nilai ini, token SAS baru harus ditentukan.

storageAccount

string

Akun penyimpanan tempat ekspor akan diunggah. Untuk sekumpulan pelanggan Azure terbatas, ini bersama dengan sasToken dapat ditentukan alih-alih resourceId.

type

DestinationType

Jenis tujuan pengiriman ekspor. Saat ini hanya 'AzureBlob' yang didukung.

ExportDeliveryInfo

Informasi pengiriman yang terkait dengan ekspor.

Nama Jenis Deskripsi
destination

ExportDeliveryDestination

Memiliki tujuan untuk ekspor yang dikirimkan.

ExportExecutionListResult

Hasil daftar riwayat eksekusi ekspor.

Nama Jenis Deskripsi
value

ExportRun[]

Daftar eksekusi ekspor.

ExportRecurrencePeriod

Tanggal mulai dan berakhir untuk jadwal pengulangan.

Nama Jenis Deskripsi
from

string (date-time)

Tanggal mulai pengulangan.

to

string (date-time)

Tanggal akhir pengulangan.

ExportRun

Eksekusi ekspor.

Nama Jenis Deskripsi
eTag

string

eTag sumber daya. Untuk menangani skenario pembaruan bersamaan, bidang ini akan digunakan untuk menentukan apakah pengguna memperbarui versi terbaru atau tidak.

id

string

Id Sumber Daya.

name

string

Nama sumber daya.

properties.endDate

string (date-time)

Tanggal berakhir untuk ekspor.

properties.error

ErrorDetails

Detail kesalahan apa pun.

properties.executionType

ExecutionType

Jenis eksekusi ekspor.

properties.fileName

string

Nama file yang diekspor.

properties.manifestFile

string

Lokasi file manifes (lokasi URI) untuk file yang diekspor.

properties.processingEndTime

string (date-time)

Waktu ketika eksekusi ekspor selesai.

properties.processingStartTime

string (date-time)

Waktu ketika ekspor diambil untuk dijalankan.

properties.runSettings

CommonExportProperties

Pengaturan ekspor yang berlaku untuk eksekusi ini.

properties.startDate

string (date-time)

Tanggal mulai untuk ekspor.

properties.status

ExecutionStatus

Status terakhir yang diketahui dari eksekusi ekspor.

properties.submittedBy

string

Pengidentifikasi untuk entitas yang memicu ekspor. Untuk eksekusi sesuai permintaan, ini adalah email pengguna. Untuk eksekusi terjadwal, ini adalah 'Sistem'.

properties.submittedTime

string (date-time)

Waktu ketika ekspor diantrekan untuk dijalankan.

type

string

Jenis sumber daya.

ExportSchedule

Jadwal yang terkait dengan ekspor.

Nama Jenis Deskripsi
recurrence

RecurrenceType

Pengulangan jadwal.

recurrencePeriod

ExportRecurrencePeriod

Memiliki tanggal mulai dan berakhir pengulangan. Tanggal mulai harus di masa mendatang. Jika ada, tanggal akhir harus lebih besar dari tanggal mulai.

status

StatusType

Status jadwal ekspor. Jika 'Tidak Aktif', jadwal ekspor akan dijeda. Untuk mengaktifkan ekspor, atur status menjadi Aktif lalu buat permintaan PUT.

ExportSuspensionContext

Properti eksekusi ekspor. Ini tidak dihuni saat ini.

Nama Jenis Deskripsi
suspensionCode

string

Kode untuk penangguhan ekspor.

suspensionReason

string

Alasan terperinci untuk penangguhan ekspor.

suspensionTime

string (date-time)

Waktu ketika ekspor ditangguhkan.

ExportTimePeriod

Rentang tanggal untuk data dalam ekspor. Ini hanya boleh ditentukan dengan timeFrame diatur ke 'Kustom'. Rentang tanggal maksimum adalah 1 bulan kalender.

Nama Jenis Deskripsi
from

string (date-time)

Tanggal mulai untuk mengekspor data.

to

string (date-time)

Tanggal akhir untuk mengekspor data.

ExportType

Jenis ekspor. Perhatikan bahwa 'Penggunaan' setara dengan 'ActualCost' dan berlaku untuk ekspor yang belum menyediakan data untuk biaya atau amortisasi untuk reservasi layanan.

Nilai Deskripsi
Usage
ActualCost
AmortizedCost
FocusCost
PriceSheet
ReservationTransactions
ReservationRecommendations
ReservationDetails

FilterItemNames

Nama filter. Ini saat ini hanya didukung untuk jenis Definisi Ekspor dari ReservationRecommendations. Nama yang didukung adalah ['ReservationScope', 'LookBackPeriod', 'ResourceType']

Nilai Deskripsi
ReservationScope
ResourceType
LookBackPeriod

FilterItems

Akan berisi nama filter dan nilai untuk dioperasikan. Ini saat ini hanya didukung untuk jenis Definisi Ekspor dari ReservationRecommendations.

Nama Jenis Deskripsi
name

FilterItemNames

Nama filter. Ini saat ini hanya didukung untuk jenis Definisi Ekspor dari ReservationRecommendations. Nama yang didukung adalah ['ReservationScope', 'LookBackPeriod', 'ResourceType']

value

string

Nilai yang akan difilter. Saat ini nilai yang didukung per nama adalah, untuk nilai yang didukung 'ReservationScope' adalah ['Single', 'Shared'], untuk nilai yang didukung 'LookBackPeriod' adalah ['Last7Days', 'Last30Days', 'Last60Days'] dan untuk 'ResourceType' nilai yang didukung adalah ['VirtualMachines', 'SQLDatabases', 'PostgreSQL', 'ManagedDisk', 'MySQL', 'RedHat', 'MariaDB', 'RedisCache', 'CosmosDB', 'SqlDataWarehouse', 'SUSELinux', 'AppService', 'BlockBlob', 'AzureDataExplorer', 'VMwareCloudSimple'].

FormatType

Format ekspor yang dikirimkan.

Nilai Deskripsi
Csv
Parquet

GranularityType

Granularitas baris dalam ekspor. Saat ini 'Harian' didukung untuk sebagian besar kasus.

Nilai Deskripsi
Daily
Monthly

RecurrenceType

Pengulangan jadwal.

Nilai Deskripsi
Daily
Weekly
Monthly
Annually

StatusType

Status jadwal ekspor. Jika 'Tidak Aktif', jadwal ekspor akan dijeda. Untuk mengaktifkan ekspor, atur status menjadi Aktif lalu buat permintaan PUT.

Nilai Deskripsi
Active
Inactive

SystemAssignedServiceIdentity

Identitas layanan terkelola (baik yang ditetapkan sistem, atau tidak ada)

Nama Jenis Deskripsi
principalId

string (uuid)

ID perwakilan layanan dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.

tenantId

string (uuid)

ID penyewa dari identitas yang ditetapkan sistem. Properti ini hanya akan disediakan untuk identitas yang ditetapkan sistem.

type

SystemAssignedServiceIdentityType

Jenis identitas layanan terkelola (baik yang ditetapkan sistem, atau tidak ada).

SystemAssignedServiceIdentityType

Jenis identitas layanan terkelola (baik yang ditetapkan sistem, atau tidak ada).

Nilai Deskripsi
None
SystemAssigned

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama Jenis Deskripsi
createdAt

string (date-time)

Tanda waktu pembuatan sumber daya (UTC).

createdBy

string

Identitas yang membuat sumber daya.

createdByType

createdByType

Jenis identitas yang membuat sumber daya.

lastModifiedAt

string (date-time)

Stempel waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy

string

Identitas yang terakhir mengubah sumber daya.

lastModifiedByType

createdByType

Jenis identitas yang terakhir memodifikasi sumber daya.

TimeframeType

Jangka waktu untuk menarik data untuk ekspor. Jika kustom, maka periode waktu tertentu harus disediakan.

Nilai Deskripsi
MonthToDate
BillingMonthToDate
TheLastMonth
TheLastBillingMonth
WeekToDate
Custom
TheCurrentMonth