Exports - Get

A operação para obter a exportação para o âmbito 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 do URI

Name In Required Type Description
exportName
path True
  • string

Nome de exportação.

scope
path True
  • string

O âmbito associado às operações de exportação. Isto inclui '/subscrições/{subscriçãoId}/' para o âmbito de subscrição, '/subscrições/{subscriçãoId}/resourceGroups/{resourceGroupName}' para o âmbito do Grupo de Recursos, '/fornecedores/Microsoft.Billing/billingAccounts/{billingAccountId}' para o âmbito da conta de faturação e "/fornecedores/Microsoft.BillingAs/billingAccounts/{billingAccountd}/departments/{departmentId}" para âmbito do Departamento, '/fornecedores/Microsoft.Billing/billingAccounts/{billingAccountd}/registrationAccounts/{ enrollmentsAccountId}' para o âmbito de contagem de matrículas, '/fornecedores/Microsoft.Management/managementGroups/{managementGroupId} para o âmbito do Grupo de Gestão, '/fornecedores/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' para o âmbito de faturaçãoProfile, '/fornecedores/Microsoft.Billing/billingAs/{billingAccountD}/billingProfiles/{billingProfileId}/faturaSections/{faturaSectionId}' para o âmbito de stição da fatura, e "/fornecedores/Microsoft. Faturação/faturaçãoAscounts/{billingAccountD}/clientes/{customerId}' específico para parceiros.

api-version
query True
  • string

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

$expand
query
  • string

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

Respostas

Name Type Description
200 OK

OK. O pedido foi bem sucedido.

Other Status Codes

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

Segurança

azure_auth

Azure Ative Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

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 o pedido de entrada. A razão é fornecida na mensagem de erro.

Algumas respostas de erro:

  • 429 TooManyRequests - Pedido é acelerado. Relemcando depois de esperar pelo tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiçoUn disponível - O serviço está temporariamente indisponível. Tente novamente após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.

ExecutionStatus

O último estatuto conhecido da execução da 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 selecionar colunas para a exportação. Se não for fornecida, a exportação incluirá todas as colunas disponíveis.

ExportDefinition

A definição de exportação.

ExportDeliveryDestination

Isto representa o local da conta de armazenamento blob onde as exportações de custos serão entregues. Há duas maneiras de configurar o destino. A abordagem recomendada para a maioria dos clientes é especificar os recursosId da conta de armazenamento. Isto requer um registo único da subscrição da conta com o fornecedor de recursos Microsoft.CostManagementExports, a fim de dar aos serviços de Gestão de Custos acesso ao armazenamento. Ao criar uma exportação no portal do Azure este registo é realizado automaticamente, mas os utilizadores da API podem ter de registar a subscrição explicitamente (para mais informações ver https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Outra forma de configurar o destino está disponível apenas para parceiros com um plano Contrato de Parceiro da Microsoft que são administradores globais da sua conta de faturação. Estes Parceiros, em vez de especificarem os recursosid de uma conta de armazenamento, podem especificar o nome da conta de armazenamento juntamente com um símbolo SAS para a conta. Isto permite exportar custos para uma conta de armazenamento em qualquer inquilino. O token SAS deve ser criado para o serviço blob com tipos de recursos de serviço/contentor/objeto e com permissões de Read/Write/Delete/List/Add/Create (para mais informações ver 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 fim para o calendário de recorrência.

ExportSchedule

O calendário associado à exportação.

ExportTimePeriod

A gama de datas para os dados na exportação. Isto só deve ser especificado com o tempo definido para 'Personalizado'. O intervalo máximo de data é de 3 meses.

ExportType

O tipo de exportação. Note que o 'Uso' é equivalente ao 'ActualCost' e é aplicável às exportações que ainda não fornecem dados para encargos ou amortizações para reservas de serviços.

FormatType

O formato da exportação a ser entregue. Atualmente apenas é apoiado o "Csv".

GranularityType

A granularidade das linhas na exportação. Atualmente apenas o 'Daily' é suportado.

RecurrenceType

A recorrência do horário.

StatusType

O estado da programação das exportações. Se "Inativo", o calendário das exportações é interrompido.

TimeframeType

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

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 a ser entregue. Atualmente apenas é apoiado o "Csv".

nextRunTimeEstimate
  • string

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

partitionData
  • boolean

Se forem definidos como verdadeiros, os dados exportados serão divididos pelo tamanho e colocados num diretório de bolhas juntamente com um ficheiro manifesto. Nota: esta opção está atualmente disponível apenas para âmbitos 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 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 o pedido de entrada. A razão é fornecida na mensagem de erro.

Algumas respostas de erro:

  • 429 TooManyRequests - Pedido é acelerado. Relemcando depois de esperar pelo tempo especificado no cabeçalho "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiçoUn disponível - O serviço está temporariamente indisponível. Tente novamente após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.

Name Type Description
error

Os detalhes do erro.

ExecutionStatus

O último estatuto conhecido da execução da 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, este campo será utilizado para determinar se o utilizador está ou não a atualizar a versão mais recente.

id
  • string

Identificação de recursos.

name
  • string

Nome de 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 a ser entregue. Atualmente apenas é apoiado o "Csv".

properties.nextRunTimeEstimate
  • string

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

properties.partitionData
  • boolean

Se forem definidos como verdadeiros, os dados exportados serão divididos pelo tamanho e colocados num diretório de bolhas juntamente com um ficheiro manifesto. Nota: esta opção está atualmente disponível apenas para âmbitos 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 agenda 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 apenas o 'Daily' é suportado.

ExportDatasetConfiguration

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

Name Type Description
columns
  • string[]

Conjunto de nomes de colunas a incluir 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 (ver exemplos).

ExportDefinition

A definição de exportação.

Name Type Description
dataSet

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

timePeriod

Tem prazo para retirar dados para a exportação.

timeframe

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

type

O tipo de exportação. Note que o 'Uso' é equivalente ao 'ActualCost' e é aplicável às exportações que ainda não fornecem dados para encargos ou amortizações para reservas de serviços.

ExportDeliveryDestination

Isto representa o local da conta de armazenamento blob onde as exportações de custos serão entregues. Há duas maneiras de configurar o destino. A abordagem recomendada para a maioria dos clientes é especificar os recursosId da conta de armazenamento. Isto requer um registo único da subscrição da conta com o fornecedor de recursos Microsoft.CostManagementExports, a fim de dar aos serviços de Gestão de Custos acesso ao armazenamento. Ao criar uma exportação no portal do Azure este registo é realizado automaticamente, mas os utilizadores da API podem ter de registar a subscrição explicitamente (para mais informações ver https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Outra forma de configurar o destino está disponível apenas para parceiros com um plano Contrato de Parceiro da Microsoft que são administradores globais da sua conta de faturação. Estes Parceiros, em vez de especificarem os recursosid de uma conta de armazenamento, podem especificar o nome da conta de armazenamento juntamente com um símbolo SAS para a conta. Isto permite exportar custos para uma conta de armazenamento em qualquer inquilino. O token SAS deve ser criado para o serviço blob com tipos de recursos de serviço/contentor/objeto e com permissões de Read/Write/Delete/List/Add/Create (para mais informações ver 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 contentor onde as exportações serão carregadas. Se o recipiente não existir, será criado.

resourceId
  • string

A identificação de recursos da conta de armazenamento onde as exportações serão entregues. Isto não é necessário se um sasToken e armazenamentoA contagem são especificadas.

rootFolderPath
  • string

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

sasToken
  • string

Um sinal SAS para a conta de armazenamento. Para um conjunto restrito de clientes Azure isto juntamente com o armazenamentoA contagem pode ser especificada em vez de recursosId. Nota: o valor devolvido pela API para este imóvel será sempre obstinado. A devolução deste mesmo valor obfuscado não resultará na atualização do token SAS. Para atualizar este valor, é necessário especificar um novo token SAS.

storageAccount
  • string

A conta de armazenamento onde as exportações serão carregadas. Para um conjunto restrito de clientes Azure isto juntamente com sasToken pode ser especificado em vez de recursosId.

ExportDeliveryInfo

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

Name Type Description
destination

Tem destino para a exportação ser 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, este campo será utilizado para determinar se o utilizador está ou não a atualizar a versão mais recente.

id
  • string

Identificação de recursos.

name
  • string

Nome de recurso.

properties.error

Os detalhes de qualquer erro.

properties.executionType

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

properties.fileName
  • string

O nome do ficheiro exportado.

properties.processingEndTime
  • string

O tempo em que a execução de exportação terminou.

properties.processingStartTime
  • string

O tempo em que a exportação foi apanhada para ser executada.

properties.runSettings

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

properties.status

O último estatuto conhecido da execução da exportação.

properties.submittedBy
  • string

O identificador da entidade que executou a exportação. Para execuções onDemand é o e-mail do utilizador. Para execuções programadas é "Sistema".

properties.submittedTime
  • string

O tempo em que a exportação foi 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 fim para o calendário de recorrência.

Name Type Description
from
  • string

A data de início da recorrência.

to
  • string

A data final da recorrência.

ExportSchedule

O calendário associado à exportação.

Name Type Description
recurrence

A recorrência do horário.

recurrencePeriod

Tem data de início e fim da recorrência. A data de início deve ser no futuro. Se estiver presente, a data de fim deve ser maior do que a data de início.

status

O estado da programação das exportações. Se "Inativo", o calendário das exportações é interrompido.

ExportTimePeriod

A gama de datas para os dados na exportação. Isto só deve ser especificado com o tempo definido para 'Personalizado'. O intervalo máximo de data é de 3 meses.

Name Type Description
from
  • string

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

to
  • string

A data limite para os dados de exportação.

ExportType

O tipo de exportação. Note que o 'Uso' é equivalente ao 'ActualCost' e é aplicável às exportações que ainda não fornecem dados para encargos ou amortizações para reservas de serviços.

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

FormatType

O formato da exportação a ser entregue. Atualmente apenas é apoiado o "Csv".

Name Type Description
Csv
  • string

GranularityType

A granularidade das linhas na exportação. Atualmente apenas o 'Daily' é suportado.

Name Type Description
Daily
  • string

RecurrenceType

A recorrência do horário.

Name Type Description
Annually
  • string
Daily
  • string
Monthly
  • string
Weekly
  • string

StatusType

O estado da programação das exportações. Se "Inativo", o calendário das exportações é interrompido.

Name Type Description
Active
  • string
Inactive
  • string

TimeframeType

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

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