Exports - Create Or Update

  • Ссылка
Service:
Cost Management
API Version:
2023-11-01

Операция создания или обновления экспорта. Операция обновления требует, чтобы в запросе был задан последний eTag. Вы можете получить последнюю версию eTag, выполнив операцию получения. Операция создания не требует eTag.

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

Параметры URI

Имя В Обязательно Тип Описание
exportName
 path True

string

Имя экспорта.
scope
 path True

string

Область, связанный с операциями экспорта. Сюда входят "/subscriptions/{subscriptionId}/" для область подписки, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" для resourceGroup область, "/providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}" для учетной записи выставления счетов область и "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" для Отдела область, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}" для EnrollmentAccount область, '/providers/Microsoft.Management/managementGroups/{managementGroupId} для группы управления область, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' для выставления счетовProfile область, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}" для область invoiceSection, а также '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' для партнеров.
api-version
 query True

string

Версия API, используемая для данной операции.

Текст запроса

Имя Обязательно Тип Описание
properties.definition True

ExportDefinition

Содержит определение для экспорта.
properties.deliveryInfo True

ExportDeliveryInfo

Содержит сведения о доставке для экспорта.
eTag

string

eTag ресурса. Для обработки сценария параллельного обновления это поле будет использоваться для определения того, обновляет ли пользователь последнюю версию.
identity

SystemAssignedServiceIdentity

Управляемое удостоверение, связанное с экспортом
location

string

Расположение управляемого удостоверения экспорта. Требуется только при использовании управляемого удостоверения.
properties.format

FormatType

Формат доставляемого экспорта. В настоящее время поддерживается только csv.
properties.partitionData

boolean

Если задано значение true, экспортированные данные будут секционированы по размеру и помещены в каталог больших двоичных объектов вместе с файлом манифеста. Примечание. В настоящее время этот параметр доступен только для Клиентское соглашение Майкрософт области коммерческой деятельности.
properties.runHistory

ExportExecutionListResult

При запросе имеет последний журнал выполнения для экспорта.
properties.schedule

ExportSchedule

Содержит сведения о расписании экспорта.

Ответы

Имя Тип Описание
200 OK

Export

Все в порядке. Запрос выполнен успешно.
201 Created

Export

Создан.
Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Scopes

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

ExportCreateOrUpdateByBillingAccount
ExportCreateOrUpdateByDepartment
ExportCreateOrUpdateByEnrollmentAccount
ExportCreateOrUpdateByManagementGroup
ExportCreateOrUpdateByResourceGroup
ExportCreateOrUpdateBySubscription

ExportCreateOrUpdateByBillingAccount

Sample Request

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

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

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

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

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

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

Определения

Имя Описание
CommonExportProperties

Общие свойства экспорта.
ErrorDetails

Сведения об ошибке.
ErrorResponse

Ответ об ошибке указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Некоторые ответы об ошибках:

  • 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания в течение времени, указанного в заголовке "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable — служба временно недоступна. Повторите попытку по окончании периода времени, указанного в заголовке Retry-After.
ExecutionStatus

Последнее известное состояние выполнения экспорта.
ExecutionType

Тип выполнения экспорта.
Export

Ресурс экспорта.
ExportDataset

Определение для данных при экспорте.
ExportDatasetConfiguration

Конфигурация экспортного набора данных. Позволяет выбирать столбцы для экспорта. Если параметр не указан, экспорт будет включать все доступные столбцы.
ExportDefinition

Определение экспорта.
ExportDeliveryDestination

Это расположение учетной записи хранения BLOB-объектов, в которую будет осуществляться экспорт затрат. Существует два способа настройки назначения. Для большинства клиентов рекомендуется указать resourceId учетной записи хранения. Для этого требуется однократная регистрация подписки учетной записи с помощью поставщика ресурсов Microsoft.CostManagementExports, чтобы предоставить службам управления затратами доступ к хранилищу. При создании экспорта в портал Azure эта регистрация выполняется автоматически, но пользователям API может потребоваться явно зарегистрировать подписку (дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Другой способ настройки назначения доступен ТОЛЬКО партнерам с планом Соглашение с партнером Майкрософт, которые являются глобальными администраторами своей учетной записи выставления счетов. Эти партнеры вместо указания resourceId учетной записи хранения могут указать имя учетной записи хранения вместе с маркером SAS для учетной записи. Это позволяет экспортировать затраты в учетную запись хранения в любом клиенте. Маркер SAS должен быть создан для службы BLOB-объектов с типами ресурсов службы, контейнера или объекта и с разрешениями на чтение, запись, удаление, список, добавление и создание (дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).
ExportDeliveryInfo

Сведения о доставке, связанные с экспортом.
ExportExecutionListResult

Результат перечисления журнала выполнения экспорта.
ExportRecurrencePeriod

Дата начала и окончания расписания повторения.
ExportRun

Выполнение экспорта.
ExportSchedule

Расписание, связанное с экспортом.
ExportTimePeriod

Диапазон дат для данных при экспорте. Это значение следует указывать только с параметром timeframe, равным Custom. Максимальный диапазон дат — 3 месяца.
ExportType

Тип экспорта. Обратите внимание, что "Использование" эквивалентно "ActualCost" и применяется к экспортам, которые еще не предоставляют данные о расходах или амортизации для резервирований служб.
FormatType

Формат доставляемого экспорта. В настоящее время поддерживается только csv.
GranularityType

Степень детализации строк в экспорте. В настоящее время поддерживается только "Daily".
RecurrenceType

Повторение расписания.
StatusType

Состояние расписания экспорта. Если параметр "Неактивен", расписание экспорта приостанавливается.
SystemAssignedServiceIdentity

Управляемое удостоверение службы (назначено системой или отсутствует)
SystemAssignedServiceIdentityType

Тип управляемого удостоверения службы (назначено системой или отсутствует).
TimeframeType

Временной интервал для извлечения данных для экспорта. Если это настраивается, то необходимо указать определенный период времени.

CommonExportProperties

Общие свойства экспорта.

Имя Тип Описание
definition

ExportDefinition

Содержит определение для экспорта.
deliveryInfo

ExportDeliveryInfo

Содержит сведения о доставке для экспорта.
format

FormatType

Формат доставляемого экспорта. В настоящее время поддерживается только csv.
nextRunTimeEstimate

string

Если экспорт имеет активное расписание, предоставляет оценку времени следующего выполнения.
partitionData

boolean

Если задано значение true, экспортированные данные будут секционированы по размеру и помещены в каталог больших двоичных объектов вместе с файлом манифеста. Примечание. В настоящее время этот параметр доступен только для Клиентское соглашение Майкрософт области коммерческой деятельности.
runHistory

ExportExecutionListResult

При запросе имеет последний журнал выполнения для экспорта.

ErrorDetails

Сведения об ошибке.

Имя Тип Описание
code

string

Код ошибки.
message

string

Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

ErrorResponse

Ответ об ошибке указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Некоторые ответы об ошибках:

  • 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания в течение времени, указанного в заголовке "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable — служба временно недоступна. Повторите попытку по окончании периода времени, указанного в заголовке Retry-After.

Имя Тип Описание
error

ErrorDetails

Сведения об ошибке.

ExecutionStatus

Последнее известное состояние выполнения экспорта.

Имя Тип Описание
Completed

string

DataNotAvailable

string

Failed

string

InProgress

string

NewDataNotAvailable

string

Queued

string

Timeout

string

ExecutionType

Тип выполнения экспорта.

Имя Тип Описание
OnDemand

string

Scheduled

string

Export

Ресурс экспорта.

Имя Тип Описание
eTag

string

eTag ресурса. Для обработки сценария параллельного обновления это поле будет использоваться для определения того, обновляет ли пользователь последнюю версию.
id

string

Идентификатор ресурса.
identity

SystemAssignedServiceIdentity

Управляемое удостоверение, связанное с экспортом
location

string

Расположение управляемого удостоверения экспорта. Требуется только при использовании управляемого удостоверения.
name

string

Имя ресурса.
properties.definition

ExportDefinition

Содержит определение для экспорта.
properties.deliveryInfo

ExportDeliveryInfo

Содержит сведения о доставке для экспорта.
properties.format

FormatType

Формат доставляемого экспорта. В настоящее время поддерживается только csv.
properties.nextRunTimeEstimate

string

Если экспорт имеет активное расписание, предоставляет оценку времени следующего выполнения.
properties.partitionData

boolean

Если задано значение true, экспортированные данные будут секционированы по размеру и помещены в каталог BLOB-объектов вместе с файлом манифеста. Примечание. В настоящее время этот параметр доступен только для Клиентское соглашение Майкрософт коммерческих областей.
properties.runHistory

ExportExecutionListResult

При запросе имеет последний журнал выполнения для экспорта.
properties.schedule

ExportSchedule

Содержит сведения о расписании экспорта.
type

string

Тип ресурса.

ExportDataset

Определение для данных при экспорте.

Имя Тип Описание
configuration

ExportDatasetConfiguration

Конфигурация экспортного набора данных.
granularity

GranularityType

Степень детализации строк в экспорте. В настоящее время поддерживается только daily.

ExportDatasetConfiguration

Конфигурация экспортного набора данных. Позволяет выбирать столбцы для экспорта. Если параметр не указан, экспорт будет включать все доступные столбцы.

Имя Тип Описание
columns

string[]

Массив имен столбцов, которые будут включены в экспорт. Если параметр не указан, экспорт будет включать все доступные столбцы. Доступные столбцы могут отличаться в зависимости от канала клиента (см. примеры).

ExportDefinition

Определение экспорта.

Имя Тип Описание
dataSet

ExportDataset

Определение для данных при экспорте.
timePeriod

ExportTimePeriod

Имеет период времени для извлечения данных для экспорта.
timeframe

TimeframeType

Временной интервал для извлечения данных для экспорта. Если это настраивается, то необходимо указать определенный период времени.
type

ExportType

Тип экспорта. Обратите внимание, что "Использование" эквивалентно "ActualCost" и применяется к экспортам, которые еще не предоставляют данные о расходах или амортизации для резервирований служб.

ExportDeliveryDestination

Это расположение учетной записи хранения BLOB-объектов, в которую будет осуществляться экспорт затрат. Существует два способа настройки назначения. Для большинства клиентов рекомендуется указать resourceId учетной записи хранения. Для этого требуется однократная регистрация подписки учетной записи с помощью поставщика ресурсов Microsoft.CostManagementExports, чтобы предоставить службам управления затратами доступ к хранилищу. При создании экспорта в портал Azure эта регистрация выполняется автоматически, но пользователям API может потребоваться явно зарегистрировать подписку (дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Другой способ настройки назначения доступен ТОЛЬКО партнерам с планом Соглашение с партнером Майкрософт, которые являются глобальными администраторами своей учетной записи выставления счетов. Эти партнеры вместо указания resourceId учетной записи хранения могут указать имя учетной записи хранения вместе с маркером SAS для учетной записи. Это позволяет экспортировать затраты в учетную запись хранения в любом клиенте. Маркер SAS должен быть создан для службы BLOB-объектов с типами ресурсов службы, контейнера или объекта и с разрешениями на чтение, запись, удаление, список, добавление и создание (дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).

Имя Тип Описание
container

string

Имя контейнера, в который будут отправляться операции экспорта. Если контейнер не существует, он будет создан.
resourceId

string

Идентификатор ресурса учетной записи хранения, в которой будут доставляться операции экспорта. Это не требуется, если указаны sasToken и storageAccount.
rootFolderPath

string

Имя каталога, в который будут отправляться операции экспорта.
sasToken

string

Маркер SAS для учетной записи хранения. Для ограниченного набора клиентов Azure это вместе с storageAccount можно указать вместо resourceId. Примечание. Значение, возвращаемое API для этого свойства, всегда будет замаскировано. Возврат этого же замаскированного значения не приведет к обновлению маркера SAS. Чтобы обновить это значение, необходимо указать новый маркер SAS.
storageAccount

string

Учетная запись хранения, в которой будут отправляться экспорты. Для ограниченного набора клиентов Azure этот параметр вместе с sasToken можно указать вместо resourceId.

ExportDeliveryInfo

Сведения о доставке, связанные с экспортом.

Имя Тип Описание
destination

ExportDeliveryDestination

Имеет назначение для доставляемого экспорта.

ExportExecutionListResult

Результат перечисления журнала выполнения экспорта.

Имя Тип Описание
value

ExportRun[]

Список выполнений экспорта.

ExportRecurrencePeriod

Дата начала и окончания расписания повторения.

Имя Тип Описание
from

string

Дата начала повторения.
to

string

Дата окончания повторения.

ExportRun

Выполнение экспорта.

Имя Тип Описание
eTag

string

eTag ресурса. Для обработки сценария параллельного обновления это поле будет использоваться для определения того, обновляет ли пользователь последнюю версию.
id

string

Идентификатор ресурса.
name

string

Имя ресурса.
properties.error

ErrorDetails

Сведения о любой ошибке.
properties.executionType

ExecutionType

Тип выполнения экспорта.
properties.fileName

string

Имя экспортируемого файла.
properties.processingEndTime

string

Время завершения выполнения экспорта.
properties.processingStartTime

string

Время, когда экспорт был выбран для запуска.
properties.runSettings

CommonExportProperties

Параметры экспорта, которые действовали для этого запуска.
properties.status

ExecutionStatus

Последнее известное состояние выполнения экспорта.
properties.submittedBy

string

Идентификатор сущности, которая активирует экспорт. Для запусков по запросу это адрес электронной почты пользователя. Для запланированных запусков это "Система".
properties.submittedTime

string

Время, когда экспорт был поставлен в очередь для выполнения.
type

string

Тип ресурса.

ExportSchedule

Расписание, связанное с экспортом.

Имя Тип Описание
recurrence

RecurrenceType

Повторение расписания.
recurrencePeriod

ExportRecurrencePeriod

Имеет дату начала и окончания повторения. Дата начала должна быть в будущем. При наличии дата окончания должна быть больше даты начала.
status

StatusType

Состояние расписания экспорта. Если параметр "Неактивен", расписание экспорта приостанавливается.

ExportTimePeriod

Диапазон дат для данных при экспорте. Это значение следует указывать только с параметром timeframe, равным Custom. Максимальный диапазон дат — 3 месяца.

Имя Тип Описание
from

string

Дата начала экспорта данных.
to

string

Дата окончания экспорта данных.

ExportType

Тип экспорта. Обратите внимание, что "Использование" эквивалентно "ActualCost" и применяется к экспортам, которые еще не предоставляют данные о расходах или амортизации для резервирований служб.

Имя Тип Описание
ActualCost

string

AmortizedCost

string

Usage

string

FormatType

Формат доставляемого экспорта. В настоящее время поддерживается только csv.

Имя Тип Описание
Csv

string

GranularityType

Степень детализации строк в экспорте. В настоящее время поддерживается только "Daily".

Имя Тип Описание
Daily

string

RecurrenceType

Повторение расписания.

Имя Тип Описание
Annually

string

Daily

string

Monthly

string

Weekly

string

StatusType

Состояние расписания экспорта. Если параметр "Неактивен", расписание экспорта приостанавливается.

Имя Тип Описание
Active

string

Inactive

string

SystemAssignedServiceIdentity

Управляемое удостоверение службы (назначено системой или отсутствует)

Имя Тип Описание
principalId

string

Идентификатор субъекта-службы назначенного системой удостоверения. Это свойство будет предоставлено только для удостоверения, назначаемого системой.
tenantId

string

Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для удостоверения, назначаемого системой.
type

SystemAssignedServiceIdentityType

Тип управляемого удостоверения службы (назначено системой или отсутствует).

SystemAssignedServiceIdentityType

Тип управляемого удостоверения службы (назначено системой или отсутствует).

Имя Тип Описание
None

string

SystemAssigned

string

TimeframeType

Временной интервал для извлечения данных для экспорта. Если это настраивается, то необходимо указать определенный период времени.

Имя Тип Описание
BillingMonthToDate

string

Custom

string

MonthToDate

string

TheLastBillingMonth

string

TheLastMonth

string

WeekToDate

string