Exports - Create Or Update

  • Odwołanie
Service:
Cost Management
API Version:
2023-11-01

Operacja tworzenia lub aktualizowania eksportu. Operacja aktualizacji wymaga ustawienia najnowszego elementu eTag w żądaniu. Możesz uzyskać najnowszy element eTag, wykonując operację pobierania. Operacja tworzenia nie wymaga elementu eTag.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
exportName
 path True

string

Eksportuj nazwę.
scope
 path True

string

Zakres skojarzony z operacjami eksportowania. Obejmuje to ciąg "/subscriptions/{subscriptionId}/" dla zakresu subskrypcji, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" dla zakresu grupy zasobów, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" dla zakresu konta rozliczeniowego i "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departmentId}" dla zakresu działu, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}" dla zakresu EnrollmentAccount, "/providers/Microsoft.Management/managementGroups/{managementGroupId} dla zakresu grupy zarządzania, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" dla zakresu billingProfile, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}" dla zakresu fakturySection i "/providers/Microsoft". Rozliczenia/rozliczeniaKonta/{billingAccountId}/customers/{customerId}' specyficzne dla partnerów.
api-version
 query True

string

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa Wymagane Typ Opis
properties.definition True

ExportDefinition

Zawiera definicję eksportu.
properties.deliveryInfo True

ExportDeliveryInfo

Zawiera informacje o dostawie dla eksportu.
eTag

string

eTag zasobu. Aby obsłużyć scenariusz aktualizacji współbieżnych, to pole będzie używane do określenia, czy użytkownik aktualizuje najnowszą wersję, czy nie.
identity

SystemAssignedServiceIdentity

Tożsamość zarządzana skojarzona z eksportem
location

string

Lokalizacja tożsamości zarządzanej eksportu. Wymagane tylko w przypadku korzystania z tożsamości zarządzanej.
properties.format

FormatType

Format dostarczanego eksportu. Obecnie obsługiwany jest tylko plik CSV.
properties.partitionData

boolean

W przypadku ustawienia wartości true wyeksportowane dane będą partycjonowane według rozmiaru i umieszczone w katalogu obiektów blob wraz z plikiem manifestu. Uwaga: ta opcja jest obecnie dostępna tylko dla zakresów handlu Umowa z Klientem Microsoft.
properties.runHistory

ExportExecutionListResult

Jeśli jest to wymagane, ma najnowszą historię uruchamiania eksportu.
properties.schedule

ExportSchedule

Zawiera informacje o harmonogramie eksportu.

Odpowiedzi

Nazwa Typ Opis
200 OK

Export

OK. Żądanie zakończyło się pomyślnie.
201 Created

Export

Utworzone.
Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa Opis
CommonExportProperties

Typowe właściwości eksportu.
ErrorDetails

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Niektóre odpowiedzi na błędy:

  • 429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po upływie czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Poczekaj przez czas określony w nagłówku „Retry-After” i spróbuj ponownie.
ExecutionStatus

Ostatni znany stan przebiegu eksportu.
ExecutionType

Typ przebiegu eksportu.
Export

Zasób eksportu.
ExportDataset

Definicja danych w eksporcie.
ExportDatasetConfiguration

Konfiguracja eksportu zestawu danych. Umożliwia wybranie kolumn dla eksportu. Jeśli nie zostanie podany, eksport będzie zawierać wszystkie dostępne kolumny.
ExportDefinition

Definicja eksportu.
ExportDeliveryDestination

Reprezentuje to lokalizację konta magazynu obiektów blob, w której zostaną dostarczone eksporty kosztów. Istnieją dwa sposoby konfigurowania miejsca docelowego. Zalecane podejście dla większości klientów polega na określeniu identyfikatora resourceId konta magazynu. Wymaga to jednorazowej rejestracji subskrypcji konta z dostawcą zasobów Microsoft.CostManagementExports w celu zapewnienia usług Cost Management dostępu do magazynu. Podczas tworzenia eksportu w Azure Portal ta rejestracja jest wykonywana automatycznie, ale użytkownicy interfejsu API mogą potrzebować jawnego zarejestrowania subskrypcji (aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Inny sposób konfigurowania miejsca docelowego jest dostępny tylko dla partnerów z planem Microsoft Partner Agreement, którzy są administratorami globalnymi swojego konta rozliczeniowego. Ci partnerzy, zamiast określać identyfikator resourceId konta magazynu, mogą określić nazwę konta magazynu wraz z tokenem SAS dla konta. Umożliwia to eksportowanie kosztów do konta magazynu w dowolnej dzierżawie. Token sygnatury dostępu współdzielonego należy utworzyć dla usługi blob z typami zasobów Service/Container/Object oraz z uprawnieniami do odczytu/zapisu/usuwania/list/dodawania/tworzenia (aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).
ExportDeliveryInfo

Informacje o dostawie skojarzone z eksportem.
ExportExecutionListResult

Wynik wyświetlania listy historii uruchamiania eksportu.
ExportRecurrencePeriod

Data rozpoczęcia i zakończenia harmonogramu cyklu.
ExportRun

Przebieg eksportu.
ExportSchedule

Harmonogram skojarzony z eksportem.
ExportTimePeriod

Zakres dat dla danych w eksporcie. Należy to określić tylko z przedziałem czasu ustawionym na wartość "Niestandardowe". Maksymalny zakres dat wynosi 3 miesiące.
ExportType

Typ eksportu. Należy pamiętać, że wartość "Użycie" jest równoważna wartościom "ActualCost" i ma zastosowanie do eksportów, które nie dostarczają jeszcze danych dotyczących opłat ani amortyzacji rezerwacji usług.
FormatType

Format dostarczanego eksportu. Obecnie obsługiwany jest tylko plik CSV.
GranularityType

Stopień szczegółowości wierszy w eksporcie. Obecnie obsługiwana jest tylko opcja "Daily".
RecurrenceType

Cykl harmonogramu.
StatusType

Stan harmonogramu eksportu. Jeśli wartość "Nieaktywna", harmonogram eksportu zostanie wstrzymany.
SystemAssignedServiceIdentity

Tożsamość usługi zarządzanej (przypisana przez system lub brak)
SystemAssignedServiceIdentityType

Typ tożsamości usługi zarządzanej (przypisany system lub brak).
TimeframeType

Przedział czasu ściągnięcia danych dla eksportu. Jeśli jest to niestandardowe, należy podać określony okres.

CommonExportProperties

Typowe właściwości eksportu.

Nazwa Typ Opis
definition

ExportDefinition

Zawiera definicję eksportu.
deliveryInfo

ExportDeliveryInfo

Zawiera informacje o dostawie dla eksportu.
format

FormatType

Format dostarczanego eksportu. Obecnie obsługiwany jest tylko plik CSV.
nextRunTimeEstimate

string

Jeśli eksport ma aktywny harmonogram, zapewnia oszacowanie następnego czasu wykonywania.
partitionData

boolean

W przypadku ustawienia wartości true wyeksportowane dane będą partycjonowane według rozmiaru i umieszczone w katalogu obiektów blob wraz z plikiem manifestu. Uwaga: ta opcja jest obecnie dostępna tylko dla zakresów handlu Umowa z Klientem Microsoft.
runHistory

ExportExecutionListResult

Jeśli jest to wymagane, ma najnowszą historię uruchamiania eksportu.

ErrorDetails

Szczegóły błędu.

Nazwa Typ Opis
code

string

Kod błędu.
message

string

Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponse

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Niektóre odpowiedzi na błędy:

  • 429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po upływie czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Poczekaj przez czas określony w nagłówku „Retry-After” i spróbuj ponownie.

Nazwa Typ Opis
error

ErrorDetails

Szczegóły błędu.

ExecutionStatus

Ostatni znany stan przebiegu eksportu.

Nazwa Typ Opis
Completed

string

DataNotAvailable

string

Failed

string

InProgress

string

NewDataNotAvailable

string

Queued

string

Timeout

string

ExecutionType

Typ przebiegu eksportu.

Nazwa Typ Opis
OnDemand

string

Scheduled

string

Export

Zasób eksportu.

Nazwa Typ Opis
eTag

string

eTag zasobu. Aby obsłużyć scenariusz aktualizacji współbieżnych, to pole będzie używane do określenia, czy użytkownik aktualizuje najnowszą wersję, czy nie.
id

string

Identyfikator zasobu.
identity

SystemAssignedServiceIdentity

Tożsamość zarządzana skojarzona z eksportem
location

string

Lokalizacja tożsamości zarządzanej eksportu. Wymagane tylko w przypadku korzystania z tożsamości zarządzanej.
name

string

Nazwa zasobu.
properties.definition

ExportDefinition

Zawiera definicję eksportu.
properties.deliveryInfo

ExportDeliveryInfo

Zawiera informacje o dostawie dla eksportu.
properties.format

FormatType

Format dostarczanego eksportu. Obecnie obsługiwany jest tylko plik CSV.
properties.nextRunTimeEstimate

string

Jeśli eksport ma aktywny harmonogram, zapewnia oszacowanie następnego czasu wykonywania.
properties.partitionData

boolean

W przypadku ustawienia wartości true wyeksportowane dane będą partycjonowane według rozmiaru i umieszczone w katalogu obiektów blob wraz z plikiem manifestu. Uwaga: ta opcja jest obecnie dostępna tylko dla zakresów handlu Umowa z Klientem Microsoft.
properties.runHistory

ExportExecutionListResult

Jeśli jest to wymagane, ma najnowszą historię uruchamiania eksportu.
properties.schedule

ExportSchedule

Zawiera informacje o harmonogramie eksportu.
type

string

Typ zasobu.

ExportDataset

Definicja danych w eksporcie.

Nazwa Typ Opis
configuration

ExportDatasetConfiguration

Konfiguracja eksportu zestawu danych.
granularity

GranularityType

Stopień szczegółowości wierszy w eksporcie. Obecnie obsługiwana jest tylko opcja "Daily".

ExportDatasetConfiguration

Konfiguracja eksportu zestawu danych. Umożliwia wybranie kolumn dla eksportu. Jeśli nie zostanie podany, eksport będzie zawierać wszystkie dostępne kolumny.

Nazwa Typ Opis
columns

string[]

Tablica nazw kolumn do ujęć w eksporcie. Jeśli nie zostanie podany, eksport będzie zawierać wszystkie dostępne kolumny. Dostępne kolumny mogą się różnić w zależności od kanału klienta (zobacz przykłady).

ExportDefinition

Definicja eksportu.

Nazwa Typ Opis
dataSet

ExportDataset

Definicja danych w eksporcie.
timePeriod

ExportTimePeriod

Ma okres na ściąganie danych dla eksportu.
timeframe

TimeframeType

Przedział czasu ściągnięcia danych dla eksportu. Jeśli jest to niestandardowe, należy podać określony okres.
type

ExportType

Typ eksportu. Należy pamiętać, że wartość "Użycie" jest równoważna wartościom "ActualCost" i ma zastosowanie do eksportów, które nie dostarczają jeszcze danych dotyczących opłat ani amortyzacji rezerwacji usług.

ExportDeliveryDestination

Reprezentuje to lokalizację konta magazynu obiektów blob, w której zostaną dostarczone eksporty kosztów. Istnieją dwa sposoby konfigurowania miejsca docelowego. Zalecane podejście dla większości klientów polega na określeniu identyfikatora resourceId konta magazynu. Wymaga to jednorazowej rejestracji subskrypcji konta z dostawcą zasobów Microsoft.CostManagementExports w celu zapewnienia usług Cost Management dostępu do magazynu. Podczas tworzenia eksportu w Azure Portal ta rejestracja jest wykonywana automatycznie, ale użytkownicy interfejsu API mogą potrzebować jawnego zarejestrowania subskrypcji (aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Inny sposób konfigurowania miejsca docelowego jest dostępny tylko dla partnerów z planem Microsoft Partner Agreement, którzy są administratorami globalnymi swojego konta rozliczeniowego. Ci partnerzy, zamiast określać identyfikator resourceId konta magazynu, mogą określić nazwę konta magazynu wraz z tokenem SAS dla konta. Umożliwia to eksportowanie kosztów do konta magazynu w dowolnej dzierżawie. Token sygnatury dostępu współdzielonego należy utworzyć dla usługi blob z typami zasobów Service/Container/Object oraz z uprawnieniami do odczytu/zapisu/usuwania/list/dodawania/tworzenia (aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).

Nazwa Typ Opis
container

string

Nazwa kontenera, w którym zostaną przekazane eksporty. Jeśli kontener nie istnieje, zostanie utworzony.
resourceId

string

Identyfikator zasobu konta magazynu, na którym zostaną dostarczone eksporty. Nie jest to wymagane, jeśli określono parametr sasToken i storageAccount.
rootFolderPath

string

Nazwa katalogu, w którym zostaną przekazane eksporty.
sasToken

string

Token sygnatury dostępu współdzielonego dla konta magazynu. W przypadku ograniczonego zestawu klientów platformy Azure można to określić razem z wartością storageAccount zamiast identyfikatora resourceId. Uwaga: wartość zwrócona przez interfejs API dla tej właściwości zawsze będzie zaciemniana. Zwracanie tej samej zaciemnionej wartości nie spowoduje zaktualizowania tokenu SAS. Aby zaktualizować tę wartość, należy określić nowy token SAS.
storageAccount

string

Konto magazynu, na którym zostaną przekazane eksporty. W przypadku ograniczonego zestawu klientów platformy Azure można to określić razem z sygnaturą sasToken zamiast identyfikatora resourceId.

ExportDeliveryInfo

Informacje o dostawie skojarzone z eksportem.

Nazwa Typ Opis
destination

ExportDeliveryDestination

Ma miejsce docelowe dla dostarczanego eksportu.

ExportExecutionListResult

Wynik wyświetlania listy historii uruchamiania eksportu.

Nazwa Typ Opis
value

ExportRun[]

Lista przebiegów eksportu.

ExportRecurrencePeriod

Data rozpoczęcia i zakończenia harmonogramu cyklu.

Nazwa Typ Opis
from

string

Data rozpoczęcia cyklu.
to

string

Data zakończenia cyklu.

ExportRun

Przebieg eksportu.

Nazwa Typ Opis
eTag

string

eTag zasobu. Aby obsłużyć scenariusz aktualizacji współbieżnych, to pole będzie używane do określenia, czy użytkownik aktualizuje najnowszą wersję, czy nie.
id

string

Identyfikator zasobu.
name

string

Nazwa zasobu.
properties.error

ErrorDetails

Szczegóły dowolnego błędu.
properties.executionType

ExecutionType

Typ przebiegu eksportu.
properties.fileName

string

Nazwa wyeksportowanego pliku.
properties.processingEndTime

string

Godzina zakończenia przebiegu eksportu.
properties.processingStartTime

string

Czas odebrania eksportu do uruchomienia.
properties.runSettings

CommonExportProperties

Ustawienia eksportu, które zostały zastosowane dla tego przebiegu.
properties.status

ExecutionStatus

Ostatni znany stan przebiegu eksportu.
properties.submittedBy

string

Identyfikator jednostki, która wyzwoliła eksport. W przypadku uruchamiania na żądanie jest to wiadomość e-mail użytkownika. W przypadku zaplanowanych przebiegów jest to "System".
properties.submittedTime

string

Czas uruchomienia eksportu w kolejce.
type

string

Typ zasobu.

ExportSchedule

Harmonogram skojarzony z eksportem.

Nazwa Typ Opis
recurrence

RecurrenceType

Cykl harmonogramu.
recurrencePeriod

ExportRecurrencePeriod

Ma datę rozpoczęcia i zakończenia cyklu. Data rozpoczęcia musi być w przyszłości. Jeśli jest obecny, data zakończenia musi być większa niż data rozpoczęcia.
status

StatusType

Stan harmonogramu eksportu. Jeśli wartość "Nieaktywna", harmonogram eksportu zostanie wstrzymany.

ExportTimePeriod

Zakres dat dla danych w eksporcie. Należy to określić tylko z przedziałem czasu ustawionym na wartość "Niestandardowe". Maksymalny zakres dat wynosi 3 miesiące.

Nazwa Typ Opis
from

string

Data rozpoczęcia eksportowania danych.
to

string

Data zakończenia eksportowania danych.

ExportType

Typ eksportu. Należy pamiętać, że wartość "Użycie" jest równoważna wartościom "ActualCost" i ma zastosowanie do eksportów, które nie dostarczają jeszcze danych dotyczących opłat ani amortyzacji rezerwacji usług.

Nazwa Typ Opis
ActualCost

string

AmortizedCost

string

Usage

string

FormatType

Format dostarczanego eksportu. Obecnie obsługiwany jest tylko plik CSV.

Nazwa Typ Opis
Csv

string

GranularityType

Stopień szczegółowości wierszy w eksporcie. Obecnie obsługiwana jest tylko opcja "Daily".

Nazwa Typ Opis
Daily

string

RecurrenceType

Cykl harmonogramu.

Nazwa Typ Opis
Annually

string

Daily

string

Monthly

string

Weekly

string

StatusType

Stan harmonogramu eksportu. Jeśli wartość "Nieaktywna", harmonogram eksportu zostanie wstrzymany.

Nazwa Typ Opis
Active

string

Inactive

string

SystemAssignedServiceIdentity

Tożsamość usługi zarządzanej (przypisana przez system lub brak)

Nazwa Typ Opis
principalId

string

Identyfikator jednostki usługi tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
tenantId

string

Identyfikator dzierżawy tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.
type

SystemAssignedServiceIdentityType

Typ tożsamości usługi zarządzanej (przypisany system lub brak).

SystemAssignedServiceIdentityType

Typ tożsamości usługi zarządzanej (przypisany system lub brak).

Nazwa Typ Opis
None

string

SystemAssigned

string

TimeframeType

Przedział czasu ściągnięcia danych dla eksportu. Jeśli jest to niestandardowe, należy podać określony okres.

Nazwa Typ Opis
BillingMonthToDate

string

Custom

string

MonthToDate

string

TheLastBillingMonth

string

TheLastMonth

string

WeekToDate

string