Compartilhar via


Exports - Create Or Update

A operação para criar ou atualizar uma exportação. A operação de atualização requer que a eTag mais recente seja definida na solicitação. Você pode obter a eTag mais recente executando uma operação get. A operação create não requer eTag.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
exportName
path True

string

Nome da Exportação.

scope
path True

string

O escopo associado às operações de exportação. Isso inclui '/subscriptions/{subscriptionId}/' para escopo de assinatura, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' para escopo resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' para escopo da Conta de Cobrança e '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' para escopo do Departamento, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' para escopo EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o escopo billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' para o escopo invoiceSection e '/providers/Microsoft. Billing/billingAccounts/{billingAccountId}/customers/{customerId}' específico para parceiros.

api-version
query True

string

A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome Obrigatório Tipo Description
properties.definition True

ExportDefinition

Tem a definição para a exportação.

properties.deliveryInfo True

ExportDeliveryInfo

Tem informações de entrega para a exportação.

eTag

string

eTag do recurso. Para lidar com o cenário de atualização simultânea, esse campo será usado para determinar se o usuário está atualizando a versão mais recente ou não.

identity

SystemAssignedServiceIdentity

A identidade gerenciada associada à Exportação

location

string

O local da identidade gerenciada da Exportação. Necessário somente ao utilizar a identidade gerenciada.

properties.format

FormatType

O formato da exportação que está sendo entregue. Atualmente, há suporte apenas para "Csv".

properties.partitionData

boolean

Se definido como true, os dados exportados serão particionados por tamanho e colocados em um diretório de blob junto com um arquivo de manifesto. Observação: esta opção está disponível apenas para escopos de comércio do Contrato de Cliente da Microsoft.

properties.runHistory

ExportExecutionListResult

Se solicitado, tem o histórico de execuções mais recente para a exportação.

properties.schedule

ExportSchedule

Tem informações de agendamento para a exportação.

Respostas

Nome Tipo Description
200 OK

Export

OKEY. A solicitação foi bem-sucedida.

201 Created

Export

Criado.

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ExportCreateOrUpdateByBillingAccount
ExportCreateOrUpdateByDepartment
ExportCreateOrUpdateByEnrollmentAccount
ExportCreateOrUpdateByManagementGroup
ExportCreateOrUpdateByResourceGroup
ExportCreateOrUpdateBySubscription

ExportCreateOrUpdateByBillingAccount

Solicitação de exemplo

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport?api-version=2024-08-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"
          ]
        }
      }
    }
  }
}

Resposta de exemplo

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

Solicitação de exemplo

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport?api-version=2024-08-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"
          ]
        }
      }
    }
  }
}

Resposta de exemplo

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

Solicitação de exemplo

PUT https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport?api-version=2024-08-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"
          ]
        }
      }
    }
  }
}

Resposta de exemplo

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

Solicitação de exemplo

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport?api-version=2024-08-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"
          ]
        }
      }
    }
  }
}

Resposta de exemplo

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

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport?api-version=2024-08-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"
          ]
        }
      }
    }
  }
}

Resposta de exemplo

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

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport?api-version=2024-08-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"
          ]
        }
      }
    }
  }
}

Resposta de exemplo

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

Definições

Nome Description
CommonExportProperties

As propriedades comuns da exportação.

ErrorDetails

Os detalhes do erro.

ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

  • 429 TooManyRequests – A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

ExecutionStatus

O último status conhecido da execução de exportação.

ExecutionType

O tipo da execução de exportação.

Export

Um recurso de exportação.

ExportDataset

A definição de dados na exportação.

ExportDatasetConfiguration

A configuração do conjunto de dados de exportação. Permite que as colunas sejam selecionadas para a exportação. Se não for fornecido, a exportação incluirá todas as colunas disponíveis.

ExportDefinition

A definição de uma exportação.

ExportDeliveryDestination

Isso representa o local da conta de armazenamento de blobs em que as exportações de custos serão entregues. Há duas maneiras de configurar o destino. A abordagem recomendada para a maioria dos clientes é especificar a resourceId da conta de armazenamento. Isso requer um registro único da assinatura da conta com o provedor de recursos Microsoft.CostManagementExports para conceder aos serviços de Gerenciamento de Custos acesso ao armazenamento. Ao criar uma exportação no portal do Azure, esse registro é executado automaticamente, mas os usuários de API podem precisar registrar a assinatura explicitamente (para obter mais informações, consulte https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services). Outra maneira de configurar o destino está disponível somente para parceiros com um plano do Contrato de Parceiro da Microsoft que são administradores globais de sua conta de cobrança. Esses parceiros, em vez de especificar a resourceId de uma conta de armazenamento, podem especificar o nome da conta de armazenamento junto com um token SAS para a conta. Isso permite exportações de custos para uma conta de armazenamento em qualquer locatário. O token SAS deve ser criado para o serviço blob com tipos de recursos de serviço/contêiner/objeto e com permissões de leitura/gravação/exclusão/lista/adicionar/criar (para obter mais informações, consulte https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key).

ExportDeliveryInfo

As informações de entrega associadas a uma exportação.

ExportExecutionListResult

Resultado da listagem do histórico de execuções de uma exportação.

ExportRecurrencePeriod

A data de início e término do agendamento de recorrência.

ExportRun

Uma execução de exportação.

ExportSchedule

O agendamento associado à exportação.

ExportTimePeriod

O intervalo de datas para dados na exportação. Isso só deve ser especificado com timeFrame definido como 'Personalizado'. O intervalo máximo de datas é de 3 meses.

ExportType

O tipo da exportação. Observe que 'Usage' é equivalente a 'ActualCost' e é aplicável a exportações que ainda não fornecem dados para encargos ou amortização para reservas de serviço.

FormatType

O formato da exportação que está sendo entregue. Atualmente, há suporte apenas para "Csv".

GranularityType

A granularidade das linhas na exportação. Atualmente, há suporte apenas para "Diário".

RecurrenceType

A recorrência de agendamento.

StatusType

O status do agendamento da exportação. Se 'Inativo', o agendamento da exportação será pausado.

SystemAssignedServiceIdentity

Identidade de serviço gerenciada (atribuída pelo sistema ou nenhuma)

SystemAssignedServiceIdentityType

Tipo de identidade de serviço gerenciada (atribuída pelo sistema ou nenhuma).

TimeframeType

O período para efetuar pull de dados para a exportação. Se personalizado, um período de tempo específico deve ser fornecido.

CommonExportProperties

As propriedades comuns da exportação.

Nome Tipo Description
definition

ExportDefinition

Tem a definição para a exportação.

deliveryInfo

ExportDeliveryInfo

Tem informações de entrega para a exportação.

format

FormatType

O formato da exportação que está sendo entregue. Atualmente, há suporte apenas para "Csv".

nextRunTimeEstimate

string

Se a exportação tiver um agendamento ativo, fornecerá uma estimativa do próximo tempo de execução.

partitionData

boolean

Se definido como true, os dados exportados serão particionados por tamanho e colocados em um diretório de blob junto com um arquivo de manifesto. Observação: esta opção está disponível apenas para escopos de comércio do Contrato de Cliente da Microsoft.

runHistory

ExportExecutionListResult

Se solicitado, tem o histórico de execuções mais recente para a exportação.

ErrorDetails

Os detalhes do erro.

Nome Tipo Description
code

string

Código de erro.

message

string

Mensagem de erro indicando por que a operação falhou.

ErrorResponse

A resposta de erro indica que o serviço não é capaz de processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Algumas respostas de erro:

  • 429 TooManyRequests – A solicitação é limitada. Tente novamente depois de aguardar o tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – O serviço está temporariamente indisponível. Tente novamente depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Nome Tipo Description
error

ErrorDetails

Os detalhes do erro.

ExecutionStatus

O último status conhecido da execução de exportação.

Nome Tipo Description
Completed

string

DataNotAvailable

string

Failed

string

InProgress

string

NewDataNotAvailable

string

Queued

string

Timeout

string

ExecutionType

O tipo da execução de exportação.

Nome Tipo Description
OnDemand

string

Scheduled

string

Export

Um recurso de exportação.

Nome Tipo Description
eTag

string

eTag do recurso. Para lidar com o cenário de atualização simultânea, esse campo será usado para determinar se o usuário está atualizando a versão mais recente ou não.

id

string

ID do recurso.

identity

SystemAssignedServiceIdentity

A identidade gerenciada associada à Exportação

location

string

O local da identidade gerenciada da Exportação. Necessário somente ao utilizar a identidade gerenciada.

name

string

Nome do recurso.

properties.definition

ExportDefinition

Tem a definição para a exportação.

properties.deliveryInfo

ExportDeliveryInfo

Tem informações de entrega para a exportação.

properties.format

FormatType

O formato da exportação que está sendo entregue. Atualmente, há suporte apenas para "Csv".

properties.nextRunTimeEstimate

string

Se a exportação tiver um agendamento ativo, fornecerá uma estimativa do próximo tempo de execução.

properties.partitionData

boolean

Se definido como true, os dados exportados serão particionados por tamanho e colocados em um diretório de blob junto com um arquivo de manifesto. Observação: esta opção está disponível apenas para escopos de comércio do Contrato de Cliente da Microsoft.

properties.runHistory

ExportExecutionListResult

Se solicitado, tem o histórico de execuções mais recente para a exportação.

properties.schedule

ExportSchedule

Tem informações de agendamento para a exportação.

type

string

Tipo de recurso.

ExportDataset

A definição de dados na exportação.

Nome Tipo Description
configuration

ExportDatasetConfiguration

A configuração do conjunto de dados de exportação.

granularity

GranularityType

A granularidade das linhas na exportação. Atualmente, há suporte apenas para "Diário".

ExportDatasetConfiguration

A configuração do conjunto de dados de exportação. Permite que as colunas sejam selecionadas para a exportação. Se não for fornecido, a exportação incluirá todas as colunas disponíveis.

Nome Tipo Description
columns

string[]

Matriz de nomes de coluna a serem incluídos na exportação. Se não for fornecido, a exportação incluirá todas as colunas disponíveis. As colunas disponíveis podem variar de acordo com o canal do cliente (veja exemplos).

ExportDefinition

A definição de uma exportação.

Nome Tipo Description
dataSet

ExportDataset

A definição de dados na exportação.

timePeriod

ExportTimePeriod

Tem um período de tempo para efetuar pull de dados para a exportação.

timeframe

TimeframeType

O período para efetuar pull de dados para a exportação. Se personalizado, um período de tempo específico deve ser fornecido.

type

ExportType

O tipo da exportação. Observe que 'Usage' é equivalente a 'ActualCost' e é aplicável a exportações que ainda não fornecem dados para encargos ou amortização para reservas de serviço.

ExportDeliveryDestination

Isso representa o local da conta de armazenamento de blobs em que as exportações de custos serão entregues. Há duas maneiras de configurar o destino. A abordagem recomendada para a maioria dos clientes é especificar a resourceId da conta de armazenamento. Isso requer um registro único da assinatura da conta com o provedor de recursos Microsoft.CostManagementExports para conceder aos serviços de Gerenciamento de Custos acesso ao armazenamento. Ao criar uma exportação no portal do Azure, esse registro é executado automaticamente, mas os usuários de API podem precisar registrar a assinatura explicitamente (para obter mais informações, consulte https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services). Outra maneira de configurar o destino está disponível somente para parceiros com um plano do Contrato de Parceiro da Microsoft que são administradores globais de sua conta de cobrança. Esses parceiros, em vez de especificar a resourceId de uma conta de armazenamento, podem especificar o nome da conta de armazenamento junto com um token SAS para a conta. Isso permite exportações de custos para uma conta de armazenamento em qualquer locatário. O token SAS deve ser criado para o serviço blob com tipos de recursos de serviço/contêiner/objeto e com permissões de leitura/gravação/exclusão/lista/adicionar/criar (para obter mais informações, consulte https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key).

Nome Tipo Description
container

string

O nome do contêiner em que as exportações serão carregadas. Se o contêiner não existir, ele será criado.

resourceId

string

A ID do recurso da conta de armazenamento em que as exportações serão entregues. Isso não será necessário se um sasToken e storageAccount forem especificados.

rootFolderPath

string

O nome do diretório em que as exportações serão carregadas.

sasToken

string

Um token SAS para a conta de armazenamento. Para um conjunto restrito de clientes do Azure, isso junto com storageAccount pode ser especificado em vez de resourceId. Observação: o valor retornado pela API para essa propriedade sempre será ofuscado. Retornar esse mesmo valor ofuscado não resultará na atualização do token SAS. Para atualizar esse valor, um novo token SAS deve ser especificado.

storageAccount

string

A conta de armazenamento em que as exportações serão carregadas. Para um conjunto restrito de clientes do Azure, isso junto com sasToken pode ser especificado em vez de resourceId.

ExportDeliveryInfo

As informações de entrega associadas a uma exportação.

Nome Tipo Description
destination

ExportDeliveryDestination

Tem o destino da exportação que está sendo entregue.

ExportExecutionListResult

Resultado da listagem do histórico de execuções de uma exportação.

Nome Tipo Description
value

ExportRun[]

Uma lista de execuções de exportação.

ExportRecurrencePeriod

A data de início e término do agendamento de recorrência.

Nome Tipo Description
from

string

A data de início da recorrência.

to

string

A data de término da recorrência.

ExportRun

Uma execução de exportação.

Nome Tipo Description
eTag

string

eTag do recurso. Para lidar com o cenário de atualização simultânea, esse campo será usado para determinar se o usuário está atualizando a versão mais recente ou não.

id

string

ID do recurso.

name

string

Nome do recurso.

properties.error

ErrorDetails

Os detalhes de qualquer erro.

properties.executionType

ExecutionType

O tipo da execução de exportação.

properties.fileName

string

O nome do arquivo exportado.

properties.processingEndTime

string

A hora em que a execução de exportação terminou.

properties.processingStartTime

string

A hora em que a exportação foi selecionada para ser executada.

properties.runSettings

CommonExportProperties

As configurações de exportação que estavam em vigor para esta execução.

properties.status

ExecutionStatus

O último status conhecido da execução de exportação.

properties.submittedBy

string

O identificador da entidade que disparou a exportação. Para execuções sob demanda, é o email do usuário. Para execuções agendadas, é "Sistema".

properties.submittedTime

string

A hora em que a exportação foi enfileirada para ser executada.

type

string

Tipo de recurso.

ExportSchedule

O agendamento associado à exportação.

Nome Tipo Description
recurrence

RecurrenceType

A recorrência de agendamento.

recurrencePeriod

ExportRecurrencePeriod

Tem a data de início e término da recorrência. A data de início deve estar no futuro. Se presente, a data de término deve ser maior que a data de início.

status

StatusType

O status do agendamento da exportação. Se 'Inativo', o agendamento da exportação será pausado.

ExportTimePeriod

O intervalo de datas para dados na exportação. Isso só deve ser especificado com timeFrame definido como 'Personalizado'. O intervalo máximo de datas é de 3 meses.

Nome Tipo Description
from

string

A data de início dos dados de exportação.

to

string

A data de término dos dados de exportação.

ExportType

O tipo da exportação. Observe que 'Usage' é equivalente a 'ActualCost' e é aplicável a exportações que ainda não fornecem dados para encargos ou amortização para reservas de serviço.

Nome Tipo Description
ActualCost

string

AmortizedCost

string

Usage

string

FormatType

O formato da exportação que está sendo entregue. Atualmente, há suporte apenas para "Csv".

Nome Tipo Description
Csv

string

GranularityType

A granularidade das linhas na exportação. Atualmente, há suporte apenas para "Diário".

Nome Tipo Description
Daily

string

RecurrenceType

A recorrência de agendamento.

Nome Tipo Description
Annually

string

Daily

string

Monthly

string

Weekly

string

StatusType

O status do agendamento da exportação. Se 'Inativo', o agendamento da exportação será pausado.

Nome Tipo Description
Active

string

Inactive

string

SystemAssignedServiceIdentity

Identidade de serviço gerenciada (atribuída pelo sistema ou nenhuma)

Nome Tipo Description
principalId

string

A ID da entidade de serviço da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.

tenantId

string

A ID do locatário da identidade atribuída pelo sistema. Essa propriedade será fornecida apenas para uma identidade atribuída pelo sistema.

type

SystemAssignedServiceIdentityType

Tipo de identidade de serviço gerenciada (atribuída pelo sistema ou nenhuma).

SystemAssignedServiceIdentityType

Tipo de identidade de serviço gerenciada (atribuída pelo sistema ou nenhuma).

Nome Tipo Description
None

string

SystemAssigned

string

TimeframeType

O período para efetuar pull de dados para a exportação. Se personalizado, um período de tempo específico deve ser fornecido.

Nome Tipo Description
BillingMonthToDate

string

Custom

string

MonthToDate

string

TheLastBillingMonth

string

TheLastMonth

string

WeekToDate

string