Exports - Create Or Update

Service:

Cost Management

API Version:

2023-11-01

Operace vytvoření nebo aktualizace exportu. Operace aktualizace vyžaduje, aby v požadavku byla nastavena nejnovější značka eTag. Nejnovější eTag můžete získat provedením operace získání. Operace vytvoření nevyžaduje eTag.

PUT https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports/{exportName}?api-version=2023-11-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
exportName	path	True	string	Název exportu.
scope	path	True	string	Obor přidružený k operacím exportu. To zahrnuje /subscriptions/{subscriptionId}/ pro rozsah předplatného, /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} pro obor resourceGroup, /providers/Microsoft.Billing/billingAccounts/{billingAccountId} pro rozsah fakturačního účtu a /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId} pro obor oddělení, /providers/Microsoft.Billing/billingAccounts/{billingAccounts}/enrollmentAccounts/{ enrollmentAccountId} pro obor EnrollmentAccount, /providers/Microsoft.Management/managementGroups/{managementGroupId} pro obor skupiny pro správu, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} pro rozsah billingProfile, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfiles}/invoiceSections/{invoiceSectionId} pro rozsah invoiceSection a /providers/Microsoft. Billing/billingAccounts/{billingAccountId}/customers/{customerId} specifické pro partnery.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.definition	True	ExportDefinition	Obsahuje definici exportu.
properties.deliveryInfo	True	ExportDeliveryInfo	Obsahuje informace o doručení exportu.
eTag		string	eTag prostředku. Při zpracování scénáře souběžných aktualizací se toto pole použije k určení, jestli uživatel aktualizuje nejnovější verzi nebo ne.
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.
properties.format		FormatType	Formát doručovaných exportů V současné době se podporuje pouze csv.
properties.partitionData		boolean	Pokud je nastavená hodnota true, exportovaná data se rozdělí na oddíly podle velikosti a umístí se do adresáře objektů blob společně se souborem manifestu. Poznámka: Tato možnost je v současné době k dispozici pouze pro rozsahy Smlouva se zákazníkem Microsoftu obchodování.
properties.runHistory		ExportExecutionListResult	V případě žádosti obsahuje nejnovější historii spuštění pro export.
properties.schedule		ExportSchedule	Obsahuje informace o plánu exportu.

Odpovědi

Name	Typ	Description
200 OK	Export	OK. Žádost byla úspěšná.
201 Created	Export	Vytvořen.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

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

Scopes

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

Příklady

ExportCreateOrUpdateByBillingAccount

ExportCreateOrUpdateByDepartment

ExportCreateOrUpdateByEnrollmentAccount

ExportCreateOrUpdateByManagementGroup

ExportCreateOrUpdateByResourceGroup

ExportCreateOrUpdateBySubscription

ExportCreateOrUpdateByBillingAccount

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport?api-version=2023-11-01

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Sample Response

Status code:

201

{
  "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Status code:

200

{
  "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportCreateOrUpdateByDepartment

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport?api-version=2023-11-01

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Sample Response

Status code:

201

{
  "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Status code:

200

{
  "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportCreateOrUpdateByEnrollmentAccount

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport?api-version=2023-11-01

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Sample Response

Status code:

201

{
  "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Status code:

200

{
  "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportCreateOrUpdateByManagementGroup

Sample Request

HTTP

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport?api-version=2023-11-01

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Sample Response

Status code:

201

{
  "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Status code:

200

{
  "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportCreateOrUpdateByResourceGroup

Sample Request

HTTP

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

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Sample Response

Status code:

201

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Status code:

200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportCreateOrUpdateBySubscription

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport?api-version=2023-11-01

{
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Sample Response

Status code:

201

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Status code:

200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "identity": {
    "type": "SystemAssigned",
    "principalId": "00000000-0000-0000-0000-000000000000",
    "tenantId": "00000000-0000-0000-0000-000000000000"
  },
  "location": "centralus",
  "properties": {
    "schedule": {
      "status": "Active",
      "recurrence": "Weekly",
      "recurrencePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      }
    },
    "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": "MonthToDate",
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Definice

Name	Description
CommonExportProperties	Společné vlastnosti exportu.
ErrorDetails	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě. Některé chybové odpovědi: 429 TooManyRequests – Požadavek je omezený. Zkuste to znovu po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable – Služba je dočasně nedostupná. Po uplynutí časového limitu uvedeného v hlavičce Retry-After zkuste operaci zopakovat.
ExecutionStatus	Poslední známý stav spuštění exportu.
ExecutionType	Typ spuštění exportu.
Export	Prostředek exportu.
ExportDataset	Definice dat v exportu.
ExportDatasetConfiguration	Konfigurace exportu datové sady Umožňuje vybrat sloupce pro export. Pokud není zadaný, export bude obsahovat všechny dostupné sloupce.
ExportDefinition	Definice exportu.
ExportDeliveryDestination	To představuje umístění účtu úložiště objektů blob, kam se budou doručovat exporty nákladů. Cíl můžete nakonfigurovat dvěma způsoby. Pro většinu zákazníků se doporučuje zadat id prostředku účtu úložiště. To vyžaduje jednorázovou registraci předplatného účtu u poskytovatele prostředků Microsoft.CostManagementExports, aby služba Cost Management mohla poskytnout přístup k úložišti. Při vytváření exportu v Azure Portal se tato registrace provádí automaticky, ale uživatelé rozhraní API možná budou muset předplatné zaregistrovat explicitně (další informace najdete v tématu https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Další způsob, jak nakonfigurovat cíl, je k dispozici POUZE pro partnery s plánem Smlouva s partnerem Microsoftu, kteří jsou globálními správci svého fakturačního účtu. Tito partneři můžou místo určení id prostředku účtu úložiště zadat název účtu úložiště spolu s tokenem SAS pro daný účet. To umožňuje export nákladů do účtu úložiště v libovolném tenantovi. Token SAS by se měl vytvořit pro službu Blob Service s typy prostředků Service/Container/Object a s oprávněními ke čtení,zápisu,odstranění/výpisu/přidání/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.
ExportTimePeriod	Rozsah dat pro data v exportu. To by mělo být zadáno pouze s časovým rámcem nastaveným na "Vlastní". Maximální rozsah dat jsou 3 měsíce.
ExportType	Typ exportu. Všimněte si, že využití je ekvivalentem hodnoty ActualCost a vztahuje se na exporty, které ještě neposkytují data pro poplatky nebo amortizaci rezervací služeb.
FormatType	Formát doručovaných exportů V současné době se podporuje pouze csv.
GranularityType	Členitost řádků v exportu. V současné době se podporuje pouze denně.
RecurrenceType	Opakování plánu.
StatusType	Stav plánu exportu. Pokud je neaktivní, plán exportu se pozastaví.
SystemAssignedServiceIdentity	Identita spravované služby (přiřazená systémem nebo žádná)
SystemAssignedServiceIdentityType	Typ identity spravované služby (buď přiřazený systémem, nebo žádný).
TimeframeType	Časový rámec pro načtení dat pro export. Pokud je vlastní, musí být zadané konkrétní časové období.

CommonExportProperties

Společné vlastnosti exportu.

Name	Typ	Description
definition	ExportDefinition	Obsahuje definici exportu.
deliveryInfo	ExportDeliveryInfo	Obsahuje informace o doručení exportu.
format	FormatType	Formát doručovaných exportů V současné době se podporuje pouze csv.
nextRunTimeEstimate	string	Pokud má export aktivní plán, poskytuje odhad času dalšího spuštění.
partitionData	boolean	Pokud je nastavená hodnota true, exportovaná data se rozdělí na oddíly podle velikosti a umístí se do adresáře objektů blob společně se souborem manifestu. Poznámka: Tato možnost je v současné době k dispozici pouze pro rozsahy Smlouva se zákazníkem Microsoftu obchodování.
runHistory	ExportExecutionListResult	V případě žádosti obsahuje nejnovější historii spuštění pro export.

ErrorDetails

Podrobnosti o chybě.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva s informacemi o tom, proč operace selhala.

ErrorResponse

Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uveden v chybové zprávě.

Některé chybové odpovědi:

• 429 TooManyRequests – Požadavek je omezený. Zkuste to znovu po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.

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

Name	Typ	Description
error	ErrorDetails	Podrobnosti o chybě.

ExecutionStatus

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

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

ExecutionType

Typ spuštění exportu.

Name	Typ	Description
OnDemand	string
Scheduled	string

Export

Prostředek exportu.

Name	Typ	Description
eTag	string	eTag prostředku. Pro zpracování scénáře souběžných aktualizací se toto pole použije k určení, jestli uživatel aktualizuje nejnovější verzi nebo ne.
id	string	ID prostředku.
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.definition	ExportDefinition	Má definici exportu.
properties.deliveryInfo	ExportDeliveryInfo	Obsahuje informace o doručení exportu.
properties.format	FormatType	Formát exportu, který se doručuje. V současné době se podporuje jenom csv.
properties.nextRunTimeEstimate	string	Pokud má export aktivní plán, poskytuje odhad doby příštího spuštění.
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. Poznámka: Tato možnost je v současné době k dispozici pouze pro Smlouva se zákazníkem Microsoftu obchodní rozsahy.
properties.runHistory	ExportExecutionListResult	Pokud je požadováno, obsahuje nejnovější historii spuštění pro export.
properties.schedule	ExportSchedule	Obsahuje informace o plánu exportu.
type	string	Typ prostředku.

ExportDataset

Definice dat v exportu.

Name	Typ	Description
configuration	ExportDatasetConfiguration	Konfigurace datové sady exportu
granularity	GranularityType	Členitost řádků v exportu. V současné době se podporuje jenom "Denně".

ExportDatasetConfiguration

Konfigurace exportu datové sady Umožňuje vybrat sloupce pro export. Pokud není zadaný, export bude obsahovat všechny dostupné sloupce.

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).

ExportDefinition

Definice exportu.

Name	Typ	Description
dataSet	ExportDataset	Definice dat v exportu.
timePeriod	ExportTimePeriod	Má časové období pro načtení dat pro export.
timeframe	TimeframeType	Časový rámec pro načtení dat pro export. Pokud je vlastní, musí být zadané konkrétní časové období.
type	ExportType	Typ exportu. Všimněte si, že využití je ekvivalentem hodnoty ActualCost a vztahuje se na exporty, které ještě neposkytují data pro poplatky nebo amortizaci rezervací služeb.

ExportDeliveryDestination

To představuje umístění účtu úložiště objektů blob, kam se budou doručovat exporty nákladů. Cíl můžete nakonfigurovat dvěma způsoby. Pro většinu zákazníků se doporučuje zadat id prostředku účtu úložiště. To vyžaduje jednorázovou registraci předplatného účtu u poskytovatele prostředků Microsoft.CostManagementExports, aby služba Cost Management mohla poskytnout přístup k úložišti. Při vytváření exportu v Azure Portal se tato registrace provádí automaticky, ale uživatelé rozhraní API možná budou muset předplatné zaregistrovat explicitně (další informace najdete v tématu https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Další způsob, jak nakonfigurovat cíl, je k dispozici POUZE pro partnery s plánem Smlouva s partnerem Microsoftu, kteří jsou globálními správci svého fakturačního účtu. Tito partneři můžou místo určení id prostředku účtu úložiště zadat název účtu úložiště spolu s tokenem SAS pro daný účet. To umožňuje export nákladů do účtu úložiště v libovolném tenantovi. Token SAS by se měl vytvořit pro službu Blob Service s typy prostředků Service/Container/Object a s oprávněními ke čtení,zápisu,odstranění/výpisu/přidání/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, do kterého 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 jsou zadány sasToken a storageAccount.
rootFolderPath	string	Název adresáře, do kterého se exporty nahrají.
sasToken	string	Token SAS pro účet úložiště. Pro omezenou sadu zákazníků Azure je možné místo resourceId zadat tento parametr společně s storageAccount. Poznámka: Hodnota vrácená rozhraním API pro tuto vlastnost bude vždy obfuskovaná. Vrácení stejné obfuskované hodnoty nebude mít za následek aktualizaci tokenu SAS. Pokud chcete tuto hodnotu aktualizovat, musí být zadán nový token SAS.
storageAccount	string	Účet úložiště, do kterého se exporty nahrají. U omezené sady zákazníků Azure je možné zadat společně s parametrem sasToken místo resourceId.

ExportDeliveryInfo

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

Name	Typ	Description
destination	ExportDeliveryDestination	Má cíl exportu, který se doručuje.

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	Počáteční datum opakování.
to	string	Koncové datum opakování.

ExportRun

Spuštění exportu.

Name	Typ	Description
eTag	string	eTag prostředku. Při zpracování scénáře souběžných aktualizací se toto pole použije k určení, jestli uživatel aktualizuje nejnovější verzi nebo ne.
id	string	ID prostředku.
name	string	Název prostředku.
properties.error	ErrorDetails	Podrobnosti o každé chybě.
properties.executionType	ExecutionType	Typ spuštění exportu.
properties.fileName	string	Název exportovaného souboru.
properties.processingEndTime	string	Čas dokončení exportu.
properties.processingStartTime	string	Čas, kdy byl export vyzvednut ke spuštění.
properties.runSettings	CommonExportProperties	Nastavení exportu, která byla v platnosti pro toto spuštění.
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í je to e-mail uživatele. U plánovaných spuštění je to Systém.
properties.submittedTime	string	Čas, kdy byl export zařazen do fronty ke spuštění.
type	string	Typ prostředku.

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 budoucnosti. 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í.

ExportTimePeriod

Rozsah dat pro data v exportu. To by mělo být zadáno pouze s časovým rámcem nastaveným na "Vlastní". Maximální rozsah dat jsou 3 měsíce.

Name	Typ	Description
from	string	Počáteční datum exportu dat.
to	string	Koncové datum exportu dat.

ExportType

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

Name	Typ	Description
ActualCost	string
AmortizedCost	string
Usage	string

FormatType

Formát doručovaných exportů V současné době se podporuje pouze csv.

Name	Typ	Description
Csv	string

GranularityType

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

Name	Typ	Description
Daily	string

RecurrenceType

Opakování plánu.

Name	Typ	Description
Annually	string
Daily	string
Monthly	string
Weekly	string

StatusType

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

Name	Typ	Description
Active	string
Inactive	string

SystemAssignedServiceIdentity

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

Name	Typ	Description
principalId	string	ID instančního objektu identity přiřazené systémem. Tato vlastnost bude k dispozici pouze pro identitu přiřazenou systémem.
tenantId	string	ID tenanta identity přiřazené systémem. Tato vlastnost bude k dispozici pouze pro identitu přiřazenou systémem.
type	SystemAssignedServiceIdentityType	Typ identity spravované služby (buď přiřazený systémem, nebo žádný).

SystemAssignedServiceIdentityType

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

Name	Typ	Description
None	string
SystemAssigned	string

TimeframeType

Časový rámec pro načtení dat pro export. Pokud je vlastní, musí být zadané konkrétní časové období.

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