Exports - List

Referência

Service:: Cost Management

API Version:: 2023-11-01

A operação para listar todas as exportações no âmbito especificado.

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

With optional parameters:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
scope	path	True	string	O âmbito associado às operações de exportação. Isto inclui "/subscriptions/{subscriptionId}/" para o âmbito da subscrição, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" para o âmbito resourceGroup, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" para o âmbito da Conta de Faturação e "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" para o âmbito do Departamento, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}" para o âmbito EnrollmentAccount, "/providers/Microsoft.Management/managementGroups/{managementGroupId} para o âmbito do Grupo de Gestão, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" para o âmbito billingProfile, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}" para o âmbito invoiceSection e "/providers/Microsoft. Faturação/faturaçãoContas/{faturaçãoAccountId}/customers/{customerId}' específicas para parceiros.
api-version	query	True	string	A versão da API a utilizar para esta operação.
$expand	query		string	Pode ser utilizado para expandir as propriedades numa exportação. Atualmente, apenas o "runHistory" é suportado e irá devolver informações sobre a última execução de cada exportação.

Respostas

Name	Tipo	Description
200 OK	ExportListResult	OK. O pedido foi efetuada com êxito.
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ExportsGetByBillingAccount

ExportsGetByDepartment

ExportsGetByEnrollmentAccount

ExportsGetByManagementGroup

ExportsGetByResourceGroup

ExportsGetBySubscription

ExportsGetByBillingAccount

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport1",
      "name": "TestExport1",
      "type": "Microsoft.CostManagement/exports",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "tenantId": "00000000-0000-0000-0000-000000000000"
      },
      "location": "centralus",
      "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-10-31T00:00:00Z"
          },
          "dataSet": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "ResourceId",
                "ResourceLocation",
                "Quantity"
              ]
            }
          }
        }
      }
    },
    {
      "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport2",
      "name": "TestExport2",
      "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": "WeekToDate",
          "dataSet": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "ResourceId",
                "ResourceLocation",
                "Quantity"
              ]
            }
          }
        }
      }
    }
  ]
}

ExportsGetByDepartment

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12/departments/123/providers/Microsoft.CostManagement/exports?api-version=2023-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport1",
      "name": "TestExport1",
      "type": "Microsoft.CostManagement/exports",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "tenantId": "00000000-0000-0000-0000-000000000000"
      },
      "location": "centralus",
      "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-10-31T00:00:00Z"
          },
          "dataSet": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "ResourceId",
                "ResourceLocation",
                "Quantity"
              ]
            }
          }
        }
      }
    },
    {
      "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport2",
      "name": "TestExport2",
      "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": "WeekToDate",
          "dataSet": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "ResourceId",
                "ResourceLocation",
                "Quantity"
              ]
            }
          }
        }
      }
    }
  ]
}

ExportsGetByEnrollmentAccount

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport1",
      "name": "TestExport1",
      "type": "Microsoft.CostManagement/exports",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "tenantId": "00000000-0000-0000-0000-000000000000"
      },
      "location": "centralus",
      "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-10-31T00:00:00Z"
          },
          "dataSet": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "ResourceId",
                "ResourceLocation",
                "Quantity"
              ]
            }
          }
        }
      }
    },
    {
      "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport2",
      "name": "TestExport2",
      "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": "WeekToDate",
          "dataSet": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "ResourceId",
                "ResourceLocation",
                "Quantity"
              ]
            }
          }
        }
      }
    }
  ]
}

ExportsGetByManagementGroup

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport1",
      "name": "TestExport1",
      "type": "Microsoft.CostManagement/exports",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "tenantId": "00000000-0000-0000-0000-000000000000"
      },
      "location": "centralus",
      "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-10-31T00:00:00Z"
          },
          "dataSet": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "ResourceId",
                "ResourceLocation",
                "Quantity"
              ]
            }
          }
        }
      }
    },
    {
      "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport2",
      "name": "TestExport2",
      "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": "WeekToDate",
          "dataSet": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "ResourceId",
                "ResourceLocation",
                "Quantity"
              ]
            }
          }
        }
      }
    }
  ]
}

ExportsGetByResourceGroup

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport1",
      "name": "TestExport1",
      "type": "Microsoft.CostManagement/exports",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "tenantId": "00000000-0000-0000-0000-000000000000"
      },
      "location": "centralus",
      "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-10-31T00:00:00Z"
          },
          "dataSet": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "ResourceId",
                "ResourceLocation",
                "Quantity"
              ]
            }
          }
        }
      }
    },
    {
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport2",
      "name": "TestExport2",
      "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": "WeekToDate",
          "dataSet": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "ResourceId",
                "ResourceLocation",
                "Quantity"
              ]
            }
          }
        }
      }
    }
  ]
}

ExportsGetBySubscription

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport1",
      "name": "TestExport1",
      "type": "Microsoft.CostManagement/exports",
      "identity": {
        "type": "SystemAssigned",
        "principalId": "00000000-0000-0000-0000-000000000000",
        "tenantId": "00000000-0000-0000-0000-000000000000"
      },
      "location": "centralus",
      "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-10-31T00:00:00Z"
          },
          "dataSet": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "ResourceId",
                "ResourceLocation",
                "Quantity"
              ]
            }
          }
        }
      }
    },
    {
      "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport2",
      "name": "TestExport2",
      "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": "WeekToDate",
          "dataSet": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "ResourceId",
                "ResourceLocation",
                "Quantity"
              ]
            }
          }
        }
      }
    }
  ]
}

Definições

Name	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 consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro. Algumas Respostas de erro: 429 TooManyRequests – o pedido é limitado. Repita 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 após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.
ExecutionStatus	O último estado conhecido da execução da 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	Isto representa a localização da conta de armazenamento de blobs onde as exportações de custos serão entregues. Existem duas formas de configurar o destino. A abordagem recomendada para a maioria dos clientes é especificar o resourceId da conta de armazenamento. Isto requer um registo único da subscrição da conta com o fornecedor de recursos Microsoft.CostManagementExports para dar aos serviços do Cost Management acesso ao armazenamento. Ao criar uma exportação no portal do Azure este registo é efetuado automaticamente, mas os utilizadores da API poderão ter de registar a subscrição explicitamente (para obter mais informações, consulte 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 de Contrato de Parceiro da Microsoft que são administradores globais da respetiva conta de faturação. Estes Parceiros, em vez de especificarem o resourceId de uma conta de armazenamento, podem especificar o nome da conta de armazenamento juntamente com um token de SAS para a conta. Isto permite exportar os custos para uma conta de armazenamento em qualquer inquilino. O token de SAS deve ser criado para o serviço de blobs com os tipos de recursos Serviço/Contentor/Objeto e com permissões de Leitura/Escrita/Eliminaçã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.
ExportListResult	Resultado da listagem de exportações. Contém uma lista de exportações disponíveis no âmbito fornecido.
ExportRecurrencePeriod	A data de início e de fim da agenda de periodicidade.
ExportRun	Uma execução de exportação.
ExportSchedule	A agenda associada à exportação.
ExportTimePeriod	O intervalo de datas dos dados na exportação. Esta definição só deve ser especificada com timeFrame definido como "Personalizado". O intervalo de datas máximo é de 3 meses.
ExportType	O tipo de exportação. Tenha em atenção que "Utilização" é equivalente a "ActualCost" e é aplicável às exportações que ainda não fornecem dados para custos ou amortizações para reservas de serviço.
FormatType	O formato da exportação que está a ser entregue. Atualmente, só é suportado "Csv".
GranularityType	A granularidade das linhas na exportação. Atualmente, só é suportado "Diariamente".
RecurrenceType	A periodicidade da agenda.
StatusType	O estado da agenda da exportação. Se estiver "Inativo", a agenda da exportação será colocada em pausa.
SystemAssignedServiceIdentity	Identidade de serviço gerida (ou sistema atribuído ou nenhum)
SystemAssignedServiceIdentityType	Tipo de identidade de serviço gerida (ou sistema atribuído ou nenhum).
TimeframeType	O período de tempo para solicitar dados para a exportação. Se for personalizado, tem de ser fornecido um período de tempo específico.

CommonExportProperties

As propriedades comuns da exportação.

Name	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á a ser entregue. Atualmente, só é suportado "Csv".
nextRunTimeEstimate	string	Se a exportação tiver uma agenda ativa, fornece uma estimativa da hora de execução seguinte.
partitionData	boolean	Se definido como verdadeiro, os dados exportados serão particionados por tamanho e colocados num diretório de blobs juntamente com um ficheiro de manifesto. Nota: esta opção está atualmente disponível apenas para âmbitos de comércio Contrato de Cliente Microsoft.
runHistory	ExportExecutionListResult	Se solicitado, tem o histórico de execuções mais recente para a exportação.

ErrorDetails

Os detalhes do erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro a indicar o motivo pela qual a operação falhou.

ErrorResponse

A resposta de erro indica que o serviço não consegue processar o pedido recebido. O motivo é fornecido na mensagem de erro.

Algumas Respostas de erro:

429 TooManyRequests – o pedido é limitado. Repita 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 após aguardar durante o tempo especificado no cabeçalho “Tentar novamente após”.

Name	Tipo	Description
error	ErrorDetails	Os detalhes do erro.

ExecutionStatus

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

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

Name	Tipo	Description
OnDemand	string
Scheduled	string

Export

Um recurso de exportação.

Name	Tipo	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	ID do Recurso.
identity	SystemAssignedServiceIdentity	A identidade gerida associada à Exportação
location	string	A localização da identidade gerida da Exportação. Só é necessário ao utilizar a identidade gerida.
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á a ser entregue. Atualmente, só é suportado "Csv".
properties.nextRunTimeEstimate	string	Se a exportação tiver uma agenda ativa, fornece uma estimativa da hora de execução seguinte.
properties.partitionData	boolean	Se definido como verdadeiro, os dados exportados serão particionados por tamanho e colocados num diretório de blobs juntamente com um ficheiro de manifesto. Nota: esta opção está atualmente disponível apenas para âmbitos de comércio Contrato de Cliente 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.

Name	Tipo	Description
configuration	ExportDatasetConfiguration	A configuração do conjunto de dados de exportação.
granularity	GranularityType	A granularidade das linhas na exportação. Atualmente, só é suportado "Diariamente".

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.

Name	Tipo	Description
columns	string[]	Matriz de nomes de coluna a incluir na exportação. Se não for fornecido, a exportação incluirá todas as colunas disponíveis. As colunas disponíveis podem variar consoante o canal do cliente (veja exemplos).

ExportDefinition

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

Name	Tipo	Description
dataSet	ExportDataset	A definição de dados na exportação.
timePeriod	ExportTimePeriod	Tem um período de tempo para solicitar dados para a exportação.
timeframe	TimeframeType	O período de tempo para solicitar dados para a exportação. Se for personalizado, tem de ser fornecido um período de tempo específico.
type	ExportType	O tipo de exportação. Tenha em atenção que "Utilização" é equivalente a "ActualCost" e é aplicável às exportações que ainda não fornecem dados para custos ou amortizações para reservas de serviço.

ExportDeliveryDestination

Isto representa a localização da conta de armazenamento de blobs onde as exportações de custos serão entregues. Existem duas formas de configurar o destino. A abordagem recomendada para a maioria dos clientes é especificar o resourceId da conta de armazenamento. Isto requer um registo único da subscrição da conta com o fornecedor de recursos Microsoft.CostManagementExports para dar aos serviços do Cost Management acesso ao armazenamento. Ao criar uma exportação no portal do Azure este registo é efetuado automaticamente, mas os utilizadores da API poderão ter de registar a subscrição explicitamente (para obter mais informações, consulte 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 de Contrato de Parceiro da Microsoft que são administradores globais da respetiva conta de faturação. Estes Parceiros, em vez de especificarem o resourceId de uma conta de armazenamento, podem especificar o nome da conta de armazenamento juntamente com um token de SAS para a conta. Isto permite exportar os custos para uma conta de armazenamento em qualquer inquilino. O token de SAS deve ser criado para o serviço de blobs com os tipos de recursos Serviço/Contentor/Objeto e com permissões de Leitura/Escrita/Eliminaçã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	Tipo	Description
container	string	O nome do contentor onde as exportações serão carregadas. Se o contentor não existir, será criado.
resourceId	string	O ID de recurso da conta de armazenamento onde serão fornecidas as exportações. Isto não é necessário se for especificado um sasToken e storageAccount.
rootFolderPath	string	O nome do diretório onde as exportações serão carregadas.
sasToken	string	Um token de SAS para a conta de armazenamento. Para um conjunto restrito de clientes do Azure, isto juntamente com storageAccount pode ser especificado em vez de resourceId. Nota: o valor devolvido pela API para esta propriedade será sempre ocultado. Devolver este mesmo valor ocultado não resultará na atualização do token de SAS. Para atualizar este valor, tem de especificar um novo token de SAS.
storageAccount	string	A conta de armazenamento onde as exportações serão carregadas. Para um conjunto restrito de clientes do Azure, isto juntamente com sasToken pode ser especificado em vez de resourceId.

ExportDeliveryInfo

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

Name	Tipo	Description
destination	ExportDeliveryDestination	Tem o destino para a exportação que está a ser entregue.

ExportExecutionListResult

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

Name	Tipo	Description
value	ExportRun[]	Uma lista de execuções de exportação.

ExportListResult

Resultado da listagem de exportações. Contém uma lista de exportações disponíveis no âmbito fornecido.

Name	Tipo	Description
value	Export[]	A lista de exportações.

ExportRecurrencePeriod

A data de início e de fim da agenda de periodicidade.

Name	Tipo	Description
from	string	A data de início da periodicidade.
to	string	A data de fim da periodicidade.

ExportRun

Uma execução de exportação.

Name	Tipo	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	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 ficheiro 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	CommonExportProperties	As definições de exportação que estavam em vigor para esta execução.
properties.status	ExecutionStatus	O último estado conhecido da execução da exportação.
properties.submittedBy	string	O identificador da entidade que acionou a exportação. Para execuções a pedido, é o e-mail do utilizador. Para execuções agendadas, é "Sistema".
properties.submittedTime	string	O tempo em que a exportação foi em fila de colocação em fila para ser executada.
type	string	Tipo de recurso.

ExportSchedule

A agenda associada à exportação.

Name	Tipo	Description
recurrence	RecurrenceType	A periodicidade da agenda.
recurrencePeriod	ExportRecurrencePeriod	Tem a data de início e de fim da periodicidade. A data de início tem de ser futura. Se estiver presente, a data de fim tem de ser maior do que a data de início.
status	StatusType	O estado da agenda da exportação. Se estiver "Inativo", a agenda da exportação será colocada em pausa.

ExportTimePeriod

O intervalo de datas dos dados na exportação. Esta definição só deve ser especificada com timeFrame definido como "Personalizado". O intervalo de datas máximo é de 3 meses.

Name	Tipo	Description
from	string	A data de início para exportar dados.
to	string	A data de fim dos dados de exportação.

ExportType

O tipo de exportação. Tenha em atenção que "Utilização" é equivalente a "ActualCost" e é aplicável às exportações que ainda não fornecem dados para custos ou amortizações para reservas de serviço.

Name	Tipo	Description
ActualCost	string
AmortizedCost	string
Usage	string

FormatType

O formato da exportação que está a ser entregue. Atualmente, só é suportado "Csv".

Name	Tipo	Description
Csv	string

GranularityType

A granularidade das linhas na exportação. Atualmente, só é suportado "Diariamente".

Name	Tipo	Description
Daily	string

RecurrenceType

A periodicidade da agenda.

Name	Tipo	Description
Annually	string
Daily	string
Monthly	string
Weekly	string

StatusType

O estado da agenda da exportação. Se estiver "Inativo", a agenda da exportação será colocada em pausa.

Name	Tipo	Description
Active	string
Inactive	string

SystemAssignedServiceIdentity

Identidade de serviço gerida (ou sistema atribuído ou nenhum)

Name	Tipo	Description
principalId	string	O ID do principal de serviço da identidade atribuída pelo sistema. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema.
tenantId	string	O ID de inquilino da identidade atribuída pelo sistema. Esta propriedade só será fornecida para uma identidade atribuída pelo sistema.
type	SystemAssignedServiceIdentityType	Tipo de identidade de serviço gerida (ou sistema atribuído ou nenhum).

SystemAssignedServiceIdentityType

Tipo de identidade de serviço gerida (ou sistema atribuído ou nenhum).

Name	Tipo	Description
None	string
SystemAssigned	string

TimeframeType

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

Name	Tipo	Description
BillingMonthToDate	string
Custom	string
MonthToDate	string
TheLastBillingMonth	string
TheLastMonth	string
WeekToDate	string

Exports - List

Parâmetros do URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

ExportsGetByBillingAccount

Sample Request

Sample Response

ExportsGetByDepartment

Sample Request

Sample Response

ExportsGetByEnrollmentAccount

Sample Request

Sample Response

ExportsGetByManagementGroup

Sample Request

Sample Response

ExportsGetByResourceGroup

Sample Request

Sample Response

ExportsGetBySubscription

Sample Request

Sample Response

Definições

CommonExportProperties

ErrorDetails

ErrorResponse

ExecutionStatus

ExecutionType

Export

ExportDataset

ExportDatasetConfiguration

ExportDefinition

ExportDeliveryDestination

ExportDeliveryInfo

ExportExecutionListResult

ExportListResult

ExportRecurrencePeriod

ExportRun

ExportSchedule

ExportTimePeriod

ExportType

FormatType

GranularityType

RecurrenceType

StatusType

SystemAssignedServiceIdentity

SystemAssignedServiceIdentityType

TimeframeType

Recursos adicionais