Exports - Get

Åtgärden för att hämta exporten för det definierade omfånget efter exportnamn.

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}

URI-parametrar

Name In Required Type Description
exportName
path True
  • string

Exportnamn.

scope
path True
  • string

Omfånget som är associerat med exportåtgärder. Detta inkluderar "/subscriptions/{subscriptionId}/" för prenumerationsomfånget "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" för resourceGroup-omfånget, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" för faktureringskontoomfånget och "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" för avdelningens omfattning, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} för EnrollmentAccount-omfång, "/providers/Microsoft.Management/managementGroups/{managementGroupId} för hanteringsgruppsomfånget, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' för billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' för invoiceSection-omfång och '/providers/Microsoft. Fakturering/faktureringKonton/{billingAccountId}/customers/{customerId} som är specifika för partner.

api-version
query True
  • string

Version av API:et som ska användas med klientbegäran.

$expand
query
  • string

Kan användas för att expandera egenskaperna inom en export. För närvarande stöds endast "runHistory" och returnerar information för de senaste 10 körningarna av exporten.

Svar

Name Type Description
200 OK

OK. Begäran har slutförts.

Other Status Codes

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

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

Definitioner

CommonExportProperties

De gemensamma egenskaperna för exporten.

ErrorDetails

Information om felet.

ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

  • 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.

ExecutionStatus

Den senast kända statusen för exportkörningen.

ExecutionType

Typ av exportkörning.

Export

En exportresurs.

ExportDataset

Definitionen för data i exporten.

ExportDatasetConfiguration

Konfigurationen av exportdatauppsättningen. Tillåter att kolumner väljs för exporten. Om det inte anges kommer exporten att innehålla alla tillgängliga kolumner.

ExportDefinition

Definitionen av en export.

ExportDeliveryDestination

Detta representerar platsen för bloblagringskontot där export av kostnader kommer att levereras. Det finns två sätt att konfigurera målet. Den metod som rekommenderas för de flesta kunder är att ange resourceId för lagringskontot. Detta kräver en engångsregistrering av kontots prenumeration med resursprovidern Microsoft.CostManagementExports för att ge Cost Management-tjänsterna åtkomst till lagringen. När du skapar en export i Azure Portal utförs den här registreringen automatiskt, men API-användare kan behöva registrera prenumerationen explicit (mer information finns i https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Ett annat sätt att konfigurera målet är endast tillgängligt för partner med en Microsoft-partneravtal plan som är globala administratörer för deras faktureringskonto. Dessa partner kan i stället för att ange resourceId för ett lagringskonto ange lagringskontots namn tillsammans med en SAS-token för kontot. På så sätt kan du exportera kostnader till ett lagringskonto i valfri klientorganisation. SAS-token ska skapas för blobtjänsten med resurstyperna Tjänst/Container/Objekt och med läs-/skriv-/borttagnings-/list-/lägg till-/skapa-behörigheter (mer information finns i https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).

ExportDeliveryInfo

Leveransinformationen som är associerad med en export.

ExportExecution

En exportkörning.

ExportExecutionListResult

Resultat av att lista körningshistoriken för en export.

ExportRecurrencePeriod

Start- och slutdatumet för upprepningsschemat.

ExportSchedule

Schemat som är associerat med exporten.

ExportTimePeriod

Datumintervallet för data i exporten. Detta bör endast anges med timeFrame inställt på "Anpassad". Det maximala datumintervallet är 3 månader.

ExportType

Exporttypen. Observera att "Användning" motsvarar "ActualCost" och gäller för exporter som ännu inte tillhandahåller data för avgifter eller amortering för tjänstreservationer.

FormatType

Formatet för exporten som levereras. För närvarande stöds endast "Csv".

GranularityType

Kornigheten för rader i exporten. För närvarande stöds endast "Dagligen".

RecurrenceType

Schemats upprepning.

StatusType

Status för exportens schema. Om det är inaktivt pausas exportens schema.

TimeframeType

Tidsramen för att hämta data för exporten. Om det är anpassat måste en viss tidsperiod anges.

CommonExportProperties

De gemensamma egenskaperna för exporten.

Name Type Description
definition

Har definitionen för exporten.

deliveryInfo

Har leveransinformation för exporten.

format

Formatet för exporten som levereras. För närvarande stöds endast "Csv".

nextRunTimeEstimate
  • string

Om exporten har ett aktivt schema ger en uppskattning av nästa körningstid.

partitionData
  • boolean

Om värdet är true partitioneras exporterade data efter storlek och placeras i en blobkatalog tillsammans med en manifestfil. Obs! Det här alternativet är för närvarande endast tillgängligt för moderna handelsomfattningar.

runHistory

Om det begärs har den senaste körningshistoriken för exporten.

ErrorDetails

Information om felet.

Name Type Description
code
  • string

Felkod.

message
  • string

Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

  • 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.

Name Type Description
error

Information om felet.

ExecutionStatus

Den senast kända statusen för exportkörningen.

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

ExecutionType

Typ av exportkörning.

Name Type Description
OnDemand
  • string
Scheduled
  • string

Export

En exportresurs.

Name Type Description
eTag
  • string

eTag för resursen. För att hantera samtidiga uppdateringsscenarion används det här fältet för att avgöra om användaren uppdaterar den senaste versionen eller inte.

id
  • string

Resurs-ID.

name
  • string

Resursnamn.

properties.definition

Har definitionen för exporten.

properties.deliveryInfo

Har leveransinformation för exporten.

properties.format

Formatet för exporten som levereras. För närvarande stöds endast "Csv".

properties.nextRunTimeEstimate
  • string

Om exporten har ett aktivt schema ger en uppskattning av nästa körningstid.

properties.partitionData
  • boolean

Om värdet är true partitioneras exporterade data efter storlek och placeras i en blobkatalog tillsammans med en manifestfil. Obs! Det här alternativet är för närvarande endast tillgängligt för moderna handelsomfattningar.

properties.runHistory

Om det begärs har den senaste körningshistoriken för exporten.

properties.schedule

Har schemainformation för exporten.

type
  • string

Resurstyp.

ExportDataset

Definitionen för data i exporten.

Name Type Description
configuration

Konfigurationen av exportdatauppsättningen.

granularity

Kornigheten för rader i exporten. För närvarande stöds endast "Dagligen".

ExportDatasetConfiguration

Konfigurationen av exportdatauppsättningen. Tillåter att kolumner väljs för exporten. Om det inte anges kommer exporten att innehålla alla tillgängliga kolumner.

Name Type Description
columns
  • string[]

Matris med kolumnnamn som ska ingå i exporten. Om det inte anges kommer exporten att innehålla alla tillgängliga kolumner. De tillgängliga kolumnerna kan variera beroende på kundkanal (se exempel).

ExportDefinition

Definitionen av en export.

Name Type Description
dataSet

Definitionen för data i exporten.

timePeriod

Har en tidsperiod för att hämta data för exporten.

timeframe

Tidsramen för att hämta data för exporten. Om det är anpassat måste en viss tidsperiod anges.

type

Exporttypen. Observera att "Användning" motsvarar "ActualCost" och gäller för exporter som ännu inte tillhandahåller data för avgifter eller amortering för tjänstreservationer.

ExportDeliveryDestination

Detta representerar platsen för bloblagringskontot där export av kostnader kommer att levereras. Det finns två sätt att konfigurera målet. Den metod som rekommenderas för de flesta kunder är att ange resourceId för lagringskontot. Detta kräver en engångsregistrering av kontots prenumeration med resursprovidern Microsoft.CostManagementExports för att ge Cost Management-tjänsterna åtkomst till lagringen. När du skapar en export i Azure Portal utförs den här registreringen automatiskt, men API-användare kan behöva registrera prenumerationen explicit (mer information finns i https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Ett annat sätt att konfigurera målet är endast tillgängligt för partner med en Microsoft-partneravtal plan som är globala administratörer för deras faktureringskonto. Dessa partner kan i stället för att ange resourceId för ett lagringskonto ange lagringskontots namn tillsammans med en SAS-token för kontot. På så sätt kan du exportera kostnader till ett lagringskonto i valfri klientorganisation. SAS-token ska skapas för blobtjänsten med resurstyperna Tjänst/Container/Objekt och med läs-/skriv-/borttagnings-/list-/lägg till-/skapa-behörigheter (mer information finns i https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).

Name Type Description
container
  • string

Namnet på den container där exporter ska laddas upp. Om containern inte finns skapas den.

resourceId
  • string

Resurs-ID:t för lagringskontot där exporter ska levereras. Detta krävs inte om en sasToken och storageAccount har angetts.

rootFolderPath
  • string

Namnet på den katalog där exporter ska laddas upp.

sasToken
  • string

En SAS-token för lagringskontot. För en begränsad uppsättning Azure-kunder kan detta tillsammans med storageAccount anges i stället för resourceId. Obs! Värdet som returneras av API:et för den här egenskapen kommer alltid att döljas. Om du returnerar samma dolda värde kommer inte SAS-token att uppdateras. Om du vill uppdatera det här värdet måste en ny SAS-token anges.

storageAccount
  • string

Lagringskontot där exporter laddas upp. För en begränsad uppsättning Azure-kunder kan detta tillsammans med sasToken anges i stället för resourceId.

ExportDeliveryInfo

Leveransinformationen som är associerad med en export.

Name Type Description
destination

Har målet för exporten som levereras.

ExportExecution

En exportkörning.

Name Type Description
eTag
  • string

eTag för resursen. För att hantera samtidiga uppdateringsscenarion används det här fältet för att avgöra om användaren uppdaterar den senaste versionen eller inte.

id
  • string

Resurs-ID.

name
  • string

Resursnamn.

properties.error

Information om eventuella fel.

properties.executionType

Typ av exportkörning.

properties.fileName
  • string

Namnet på den exporterade filen.

properties.processingEndTime
  • string

Tiden då exportkörningen slutfördes.

properties.processingStartTime
  • string

Den tid då exporten hämtades för att köras.

properties.runSettings

De exportinställningar som gällde för den här körningen.

properties.status

Den senast kända statusen för exportkörningen.

properties.submittedBy
  • string

Identifieraren för entiteten som körde exporten. För OnDemand-körningar är det användarens e-post. För schemalagda körningar är det "System".

properties.submittedTime
  • string

Den tid då exporten köades för att köras.

type
  • string

Resurstyp.

ExportExecutionListResult

Resultat av att lista körningshistoriken för en export.

Name Type Description
value

En lista över exportkörningar.

ExportRecurrencePeriod

Start- och slutdatumet för upprepningsschemat.

Name Type Description
from
  • string

Startdatumet för upprepning.

to
  • string

Slutdatumet för upprepning.

ExportSchedule

Schemat som är associerat med exporten.

Name Type Description
recurrence

Schemats upprepning.

recurrencePeriod

Har start- och slutdatum för upprepningen. Startdatumet måste vara i framtiden. Om det finns måste slutdatumet vara större än startdatumet.

status

Status för exportens schema. Om det är inaktivt pausas exportens schema.

ExportTimePeriod

Datumintervallet för data i exporten. Detta bör endast anges med timeFrame inställt på "Anpassad". Det maximala datumintervallet är 3 månader.

Name Type Description
from
  • string

Startdatum för exportdata.

to
  • string

Slutdatum för exportdata.

ExportType

Exporttypen. Observera att "Användning" motsvarar "ActualCost" och gäller för exporter som ännu inte tillhandahåller data för avgifter eller amortering för tjänstreservationer.

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

FormatType

Formatet för exporten som levereras. För närvarande stöds endast "Csv".

Name Type Description
Csv
  • string

GranularityType

Kornigheten för rader i exporten. För närvarande stöds endast "Dagligen".

Name Type Description
Daily
  • string

RecurrenceType

Schemats upprepning.

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

StatusType

Status för exportens schema. Om det är inaktivt pausas exportens schema.

Name Type Description
Active
  • string
Inactive
  • string

TimeframeType

Tidsramen för att hämta data för exporten. Om det är anpassat måste en viss tidsperiod anges.

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