Exports - Create Or Update

リファレンス

Service:: Cost Management

API Version:: 2023-11-01

エクスポートを作成または更新する操作。更新操作では、要求で最新の eTag を設定する必要があります。 get 操作を実行することで、最新の 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}/'、resourceGroup スコープの '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' が含まれます。 '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, billingProfile スコープの場合は '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/{billingProfileId}'、invoiceSection スコープの場合は '/providers/Microsoft.Billing/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	Export に関連付けられているマネージド ID
location		string	エクスポートのマネージド ID の場所。マネージド ID を使用する場合にのみ必要です。
properties.format		FormatType	配信されるエクスポートの形式。現在、'Csv' のみがサポートされています。
properties.partitionData		boolean	true に設定すると、エクスポートされたデータはサイズ別にパーティション分割され、マニフェストファイルと共に BLOB ディレクトリに配置されます。注: このオプションは現在、Microsoft 顧客契約コマーススコープでのみ使用できます。
properties.runHistory		ExportExecutionListResult	要求された場合は、エクスポートの最新の実行履歴が含まれます。
properties.schedule		ExportSchedule	エクスポートのスケジュール情報が含まれます。

応答

名前	型	説明
200 OK	Export	OK です。要求は成功しました。
201 Created	Export	作成されました。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

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

定義

名前	説明
CommonExportProperties	エクスポートの共通プロパティ。
ErrorDetails	エラーの詳細。
ErrorResponse	エラー応答は、サービスが受信要求を処理できないことを示します。理由は、エラーメッセージに表示されます。いくつかのエラー応答: 429 TooManyRequests - 要求が調整されました。 "x-ms-ratelimit-microsoft.consumption-retry-after" ヘッダーで指定された時間を待ってから再試行します。 503 ServiceUnavailable - サービスは一時的に使用できません。 "Retry-After" ヘッダーで指定された時刻まで待ってから、再試行してください。
ExecutionStatus	エクスポート実行の最後の既知の状態。
ExecutionType	エクスポート実行の種類。
Export	エクスポートリソース。
ExportDataset	エクスポート内のデータの定義。
ExportDatasetConfiguration	データセットのエクスポート構成。エクスポート用に列を選択できるようにします。指定しない場合、エクスポートには使用可能なすべての列が含まれます。
ExportDefinition	エクスポートの定義。
ExportDeliveryDestination	これは、コストのエクスポートが配信される BLOB ストレージアカウントの場所を表します。宛先を構成するには、2 つの方法があります。ほとんどのお客様に推奨される方法は、ストレージアカウントの resourceId を指定することです。 Cost Management サービスにストレージへのアクセス権を付与するには、アカウントのサブスクリプションを Microsoft.CostManagementExports リソースプロバイダーに 1 回限り登録する必要があります。 Azure portalでエクスポートを作成すると、この登録は自動的に実行されますが、API ユーザーはサブスクリプションを明示的に登録する必要がある場合があります (詳細については、「」を参照してくださいhttps://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services)。宛先を構成するもう 1 つの方法は、課金アカウントのグローバル管理者であるMicrosoft Partner Agreementプランを持つパートナーのみが利用できます。これらのパートナーは、ストレージアカウントの 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	エクスポートの型。 'Usage' は 'ActualCost' と同等であり、サービス予約の料金または償却のためのデータをまだ提供していないエクスポートに適用されることに注意してください。
FormatType	配信されるエクスポートの形式。現在、'Csv' のみがサポートされています。
GranularityType	エクスポート内の行の粒度。現在、'Daily' のみがサポートされています。
RecurrenceType	スケジュール繰り返し。
StatusType	エクスポートのスケジュールの状態。 '非アクティブ' の場合、エクスポートのスケジュールは一時停止されます。
SystemAssignedServiceIdentity	マネージドサービス ID (システム割り当て済み、またはなし)
SystemAssignedServiceIdentityType	マネージドサービス ID の種類 (システム割り当て済み、またはなし)。
TimeframeType	エクスポートのデータをプルする期間。カスタムの場合は、特定の期間を指定する必要があります。

CommonExportProperties

エクスポートの共通プロパティ。

名前	型	説明
definition	ExportDefinition	エクスポートの定義があります。
deliveryInfo	ExportDeliveryInfo	エクスポートの配信情報があります。
format	FormatType	配信されるエクスポートの形式。現在、'Csv' のみがサポートされています。
nextRunTimeEstimate	string	エクスポートにアクティブなスケジュールがある場合は、次の実行時の見積もりを提供します。
partitionData	boolean	true に設定すると、エクスポートされたデータはサイズ別にパーティション分割され、マニフェストファイルと共に BLOB ディレクトリに配置されます。注: このオプションは現在、Microsoft 顧客契約コマーススコープでのみ使用できます。
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	リソース ID。
identity	SystemAssignedServiceIdentity	Export に関連付けられているマネージド ID
location	string	エクスポートのマネージド ID の場所。マネージド ID を使用する場合にのみ必要です。
name	string	リソース名。
properties.definition	ExportDefinition	エクスポートの定義があります。
properties.deliveryInfo	ExportDeliveryInfo	エクスポートの配信情報があります。
properties.format	FormatType	配信されるエクスポートの形式。現在、'Csv' のみがサポートされています。
properties.nextRunTimeEstimate	string	エクスポートにアクティブなスケジュールがある場合は、次の実行時の見積もりを提供します。
properties.partitionData	boolean	true に設定すると、エクスポートされたデータはサイズ別にパーティション分割され、マニフェストファイルと共に BLOB ディレクトリに配置されます。注: このオプションは現在、Microsoft 顧客契約コマーススコープでのみ使用できます。
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	エクスポートの型。 'Usage' は 'ActualCost' と同等であり、サービス予約の料金または償却のためのデータをまだ提供していないエクスポートに適用されることに注意してください。

ExportDeliveryDestination

これは、コストのエクスポートが配信される BLOB ストレージアカウントの場所を表します。宛先を構成するには、2 つの方法があります。ほとんどのお客様に推奨される方法は、ストレージアカウントの resourceId を指定することです。 Cost Management サービスにストレージへのアクセス権を付与するには、アカウントのサブスクリプションを Microsoft.CostManagementExports リソースプロバイダーに 1 回限り登録する必要があります。 Azure portalでエクスポートを作成すると、この登録は自動的に実行されますが、API ユーザーはサブスクリプションを明示的に登録する必要がある場合があります (詳細については、「」を参照してくださいhttps://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services)。宛先を構成するもう 1 つの方法は、課金アカウントのグローバル管理者であるMicrosoft Partner Agreementプランを持つパートナーのみが利用できます。これらのパートナーは、ストレージアカウントの 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	エクスポートが配信されるストレージアカウントのリソース ID。 sasToken と storageAccount が指定されている場合、これは必須ではありません。
rootFolderPath	string	エクスポートがアップロードされるディレクトリの名前。
sasToken	string	ストレージアカウントの SAS トークン。 Azure のお客様の制限付きセットでは、resourceId の代わりに storageAccount と共にこれを指定できます。注: このプロパティの API によって返される値は、常に難読化されます。この同じ難読化された値を返しても、SAS トークンは更新されません。この値を更新するには、新しい SAS トークンを指定する必要があります。
storageAccount	string	エクスポートがアップロードされるストレージアカウント。 Azure のお客様の制限付きセットでは、resourceId の代わりに sasToken と共にこれを指定できます。

ExportDeliveryInfo

エクスポートに関連付けられている配信情報。

名前	型	説明
destination	ExportDeliveryDestination	配信されるエクスポートの宛先を指定します。

ExportExecutionListResult

エクスポートの実行履歴を一覧表示した結果。

名前	型	説明
value	ExportRun[]	エクスポート実行の一覧。

ExportRecurrencePeriod

繰り返しスケジュールの開始日と終了日。

名前	型	説明
from	string	繰り返しの開始日。
to	string	繰り返しの終了日。

ExportRun

エクスポート実行。

名前	型	説明
eTag	string	リソースの eTag。同時更新シナリオを処理するために、このフィールドを使用して、ユーザーが最新バージョンを更新しているかどうかを判断します。
id	string	リソース ID。
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

エクスポートの型。 'Usage' は '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

マネージドサービス ID (システム割り当て済み、またはなし)

名前	型	説明
principalId	string	システム割り当て ID のサービスプリンシパル ID。このプロパティは、システム割り当て ID に対してのみ提供されます。
tenantId	string	システム割り当て ID のテナント ID。このプロパティは、システム割り当て ID に対してのみ提供されます。
type	SystemAssignedServiceIdentityType	マネージドサービス ID の種類 (システム割り当て済み、またはなし)。

SystemAssignedServiceIdentityType

マネージドサービス ID の種類 (システム割り当て済み、またはなし)。

名前	型	説明
None	string
SystemAssigned	string

TimeframeType

エクスポートのデータをプルする期間。カスタムの場合は、特定の期間を指定する必要があります。

名前	型	説明
BillingMonthToDate	string
Custom	string
MonthToDate	string
TheLastBillingMonth	string
TheLastMonth	string
WeekToDate	string

Exports - Create Or Update

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

Scopes

例

ExportCreateOrUpdateByBillingAccount

Sample Request

Sample Response

ExportCreateOrUpdateByDepartment

Sample Request

Sample Response

ExportCreateOrUpdateByEnrollmentAccount

Sample Request

Sample Response

ExportCreateOrUpdateByManagementGroup

Sample Request

Sample Response

ExportCreateOrUpdateByResourceGroup

Sample Request

Sample Response

ExportCreateOrUpdateBySubscription

Sample Request

Sample Response

定義

CommonExportProperties

ErrorDetails

ErrorResponse

ExecutionStatus

ExecutionType

Export

ExportDataset

ExportDatasetConfiguration

ExportDefinition

ExportDeliveryDestination

ExportDeliveryInfo

ExportExecutionListResult

ExportRecurrencePeriod

ExportRun

ExportSchedule

ExportTimePeriod

ExportType

FormatType

GranularityType

RecurrenceType

StatusType

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

TimeframeType

その他のリソース