Exports - Get

A operação para obter a exportação para o escopo definido por nome de exportação.

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports/{exportName}?api-version=2021-10-01
GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports/{exportName}?api-version=2021-10-01&$expand={$expand}

Parâmetros de URI

Name In Required Type 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}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' para escopo invoiceSection e '/providers/Microsoft. Cobrança/billingAccounts/{billingAccountId}/customers/{customerId}' específica para parceiros.

api-version
query True
  • string

Versão da API a ser usada com a solicitação do cliente.

$expand
query
  • string

Pode ser usado para expandir as propriedades dentro de uma exportação. Atualmente, há suporte apenas para 'runHistory' e retornará informações para as últimas 10 execuções da exportação.

Respostas

Name Type Description
200 OK

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

Other Status Codes

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

Segurança

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

ExportGetByBillingAccount
ExportGetByDepartment
ExportGetByEnrollmentAccount
ExportGetByManagementGroup
ExportGetByResourceGroup
ExportGetBySubscription

ExportGetByBillingAccount

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport?api-version=2021-10-01

Sample Response

{
  "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "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": "Custom",
      "timePeriod": {
        "from": "2020-05-01T00:00:00Z",
        "to": "2020-05-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetByDepartment

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport?api-version=2021-10-01

Sample Response

{
  "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "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": "Custom",
      "timePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-06-30T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetByEnrollmentAccount

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport?api-version=2021-10-01

Sample Response

{
  "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "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": "Custom",
      "timePeriod": {
        "from": "2019-09-01T00:00:00Z",
        "to": "2019-10-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetByManagementGroup

Sample Request

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport?api-version=2021-10-01

Sample Response

{
  "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "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": "Custom",
      "timePeriod": {
        "from": "2019-09-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "UsageDate",
            "MeterId",
            "InstanceId",
            "ResourceLocation",
            "UsageQuantity"
          ]
        }
      }
    }
  }
}

ExportGetByResourceGroup

Sample Request

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

Sample Response

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "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": "Custom",
      "timePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-06-30T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetBySubscription

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport?api-version=2021-10-01

Sample Response

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "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": "Custom",
      "timePeriod": {
        "from": "2019-06-01T00:00:00Z",
        "to": "2019-07-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Definições

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. Repita 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 de 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 fornecida, 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 fornecer 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 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.

ExportExecution

Uma execução de exportação.

ExportExecutionListResult

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

ExportRecurrencePeriod

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

ExportSchedule

A agenda associada à 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 de 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 do agendamento.

StatusType

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

TimeframeType

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

CommonExportProperties

As propriedades comuns da exportação.

Name Type Description
definition

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

deliveryInfo

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

format

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 da próxima hora 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: essa opção está disponível atualmente apenas para escopos de comércio modernos.

runHistory

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

ErrorDetails

Os detalhes do erro.

Name Type Description
code
  • string

Código do 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. Repita depois de aguardar o tempo especificado no cabeçalho "Retry-After".

Name Type Description
error

Os detalhes do erro.

ExecutionStatus

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

Name Type Description
Completed
  • string
DataNotAvailable
  • string
Failed
  • string
InProgress
  • string
NewDataNotAvailable
  • string
Queued
  • string
Timeout
  • string

ExecutionType

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

Name Type Description
OnDemand
  • string
Scheduled
  • string

Export

Um recurso de exportação.

Name Type 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 ou não a versão mais recente.

id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.definition

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

properties.deliveryInfo

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

properties.format

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: atualmente, essa opção está disponível apenas para escopos de comércio modernos.

properties.runHistory

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

properties.schedule

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

type
  • string

Tipo de recurso.

ExportDataset

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

Name Type Description
configuration

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

granularity

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 fornecida, a exportação incluirá todas as colunas disponíveis.

Name Type Description
columns
  • string[]

Matriz de nomes de coluna a serem incluídos na exportação. Se não for fornecida, 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.

Name Type Description
dataSet

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

timePeriod

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

timeframe

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

type

O tipo de 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 fornecer 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 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 ).

Name Type 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 onde 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.

Name Type Description
destination

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

ExportExecution

Uma execução de exportação.

Name Type 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 ou não a versão mais recente.

id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.error

Os detalhes de qualquer erro.

properties.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 da exportação foi concluída.

properties.processingStartTime
  • string

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

properties.runSettings

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

properties.status

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

properties.submittedBy
  • string

O identificador da entidade que executou a exportação. Para execuções onDemand, é 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.

ExportExecutionListResult

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

Name Type Description
value

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

ExportRecurrencePeriod

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

Name Type Description
from
  • string

A data de início da recorrência.

to
  • string

A data de término da recorrência.

ExportSchedule

A agenda associada à exportação.

Name Type Description
recurrence

A recorrência do agendamento.

recurrencePeriod

Tem 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

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.

Name Type Description
from
  • string

A data de início para exportar dados.

to
  • string

A data de término para exportar dados.

ExportType

O tipo de 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.

Name Type Description
ActualCost
  • string
AmortizedCost
  • string
Usage
  • string

FormatType

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

Name Type Description
Csv
  • string

GranularityType

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

Name Type Description
Daily
  • string

RecurrenceType

A recorrência do agendamento.

Name Type 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.

Name Type Description
Active
  • string
Inactive
  • string

TimeframeType

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

Name Type Description
BillingMonthToDate
  • string
Custom
  • string
MonthToDate
  • string
TheLastBillingMonth
  • string
TheLastMonth
  • string
WeekToDate
  • string