Report Config - Create Or Update
A operação para criar ou atualizar uma configuração de relatório. A operação de atualização requer que a eTag mais recente seja definida na solicitação obrigatoriamente. 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/subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/reportconfigs/{reportConfigName}?api-version=2018-05-31
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
report
|
path | True |
string |
Nome da Configuração do Relatório. |
subscription
|
path | True |
string |
ID da Assinatura do Azure. |
api-version
|
query | True |
string |
Versão da API a ser usada com a solicitação do cliente. A versão atual é 2018-05-31. |
Corpo da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
properties.definition | True |
Tem definição para a configuração do relatório. |
|
properties.deliveryInfo | True |
Tem informações de entrega para a configuração do relatório. |
|
properties.format |
O formato do relatório que está sendo entregue. |
||
properties.schedule |
Tem informações de agendamento para a configuração do relatório. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
OKEY. A solicitação foi bem-sucedida. |
|
201 Created |
Criado. |
|
Other Status Codes |
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
CreateOrUpdateReport
Solicitação de exemplo
PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/reportconfigs/TestReportConfig?api-version=2018-05-31
{
"properties": {
"schedule": {
"status": "Active",
"recurrence": "Weekly",
"recurrencePeriod": {
"from": "2018-06-01T00:00:00Z",
"to": "2018-10-31T00:00:00Z"
}
},
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "reports",
"rootFolderPath": "ad-hoc"
}
},
"definition": {
"type": "Usage",
"timeframe": "MonthToDate",
"dataset": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"InstanceId",
"ResourceLocation",
"PreTaxCost"
]
},
"aggregation": {
"costSum": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"grouping": [
{
"columnType": "Dimension",
"name": "SubscriptionName"
},
{
"columnType": "Tag",
"name": "Environment"
}
],
"filter": {
"and": [
{
"or": [
{
"dimension": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tag": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimension": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
}
}
}
}
}
Resposta de exemplo
{
"id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/reportconfigs/TestReportConfig",
"name": "TestReportConfig",
"type": "Microsoft.Consumption/reportconfigs",
"properties": {
"schedule": {
"status": "Active",
"recurrence": "Weekly",
"recurrencePeriod": {
"from": "2018-06-01T00:00:00Z",
"to": "2018-10-31T00:00:00Z"
}
},
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "reports",
"rootFolderPath": "ad-hoc"
}
},
"definition": {
"type": "Usage",
"timeframe": "MonthToDate",
"dataset": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"InstanceId",
"ResourceLocation",
"PreTaxCost"
]
},
"aggregation": {
"costSum": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"grouping": [
{
"columnType": "Dimension",
"name": "SubscriptionName"
},
{
"columnType": "Tag",
"name": "Environment"
}
],
"filter": {
"and": [
{
"or": [
{
"dimension": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tag": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimension": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
}
}
}
}
}
{
"id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/reportconfigs/TestReportConfig",
"name": "TestReportConfig",
"type": "Microsoft.Consumption/reportconfigs",
"properties": {
"schedule": {
"status": "Active",
"recurrence": "Weekly",
"recurrencePeriod": {
"from": "2018-06-01T00:00:00Z",
"to": "2018-10-31T00:00:00Z"
}
},
"format": "Csv",
"deliveryInfo": {
"destination": {
"resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
"container": "reports",
"rootFolderPath": "ad-hoc"
}
},
"definition": {
"type": "Usage",
"timeframe": "MonthToDate",
"dataset": {
"granularity": "Daily",
"configuration": {
"columns": [
"Date",
"MeterId",
"InstanceId",
"ResourceLocation",
"PreTaxCost"
]
},
"aggregation": {
"costSum": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"grouping": [
{
"columnType": "Dimension",
"name": "SubscriptionName"
},
{
"columnType": "Tag",
"name": "Environment"
}
],
"filter": {
"and": [
{
"or": [
{
"dimension": {
"name": "ResourceLocation",
"operator": "In",
"values": [
"East US",
"West Europe"
]
}
},
{
"tag": {
"name": "Environment",
"operator": "In",
"values": [
"UAT",
"Prod"
]
}
}
]
},
{
"dimension": {
"name": "ResourceGroup",
"operator": "In",
"values": [
"API"
]
}
}
]
}
}
}
}
}
Definições
Nome | Description |
---|---|
Error |
Os detalhes do erro. |
Error |
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. |
Format |
O formato do relatório que está sendo entregue. |
Function |
O nome da função de agregação a ser usada. |
Granularity |
A granularidade das linhas no relatório. |
Operator |
O operador a ser usado para comparação. |
Recurrence |
A recorrência de agendamento. |
Report |
Um recurso de configuração de relatório. |
Report |
A expressão de agregação a ser usada no relatório. |
Report |
O tipo da coluna no relatório. |
Report |
A expressão de comparação a ser usada no relatório. |
Report |
A definição de dados presentes no relatório. |
Report |
A configuração do conjunto de dados no relatório. |
Report |
A definição de uma configuração de relatório. |
Report |
As informações de destino para a entrega do relatório. |
Report |
As informações de entrega associadas a uma configuração de relatório. |
Report |
A expressão de filtro a ser usada no relatório. |
Report |
O grupo por expressão a ser usado no relatório. |
Report |
A data de início e término do agendamento de recorrência. |
Report |
A agenda associada a uma configuração de relatório. |
Report |
A data de início e término para efetuar pull de dados para o relatório. |
Report |
O tipo do relatório. |
Status |
O status da agenda. Ativo ou não. Se inativa, a execução agendada do relatório será pausada. |
Timeframe |
O período para efetuar pull de dados para o relatório. Se personalizado, um período de tempo específico deve ser fornecido. |
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.
Nome | Tipo | Description |
---|---|---|
error |
Os detalhes do erro. |
FormatType
O formato do relatório que está sendo entregue.
Nome | Tipo | Description |
---|---|---|
Csv |
string |
FunctionType
O nome da função de agregação a ser usada.
Nome | Tipo | Description |
---|---|---|
Sum |
string |
GranularityType
A granularidade das linhas no relatório.
Nome | Tipo | Description |
---|---|---|
Daily |
string |
OperatorType
O operador a ser usado para comparação.
Nome | Tipo | Description |
---|---|---|
In |
string |
RecurrenceType
A recorrência de agendamento.
Nome | Tipo | Description |
---|---|---|
Annually |
string |
|
Daily |
string |
|
Monthly |
string |
|
Weekly |
string |
ReportConfig
Um recurso de configuração de relatório.
Nome | Tipo | Description |
---|---|---|
id |
string |
ID do recurso. |
name |
string |
Nome do recurso. |
properties.definition |
Tem definição para a configuração do relatório. |
|
properties.deliveryInfo |
Tem informações de entrega para a configuração do relatório. |
|
properties.format |
O formato do relatório que está sendo entregue. |
|
properties.schedule |
Tem informações de agendamento para a configuração do relatório. |
|
tags |
object |
Marcas de recurso. |
type |
string |
Tipo de recurso. |
ReportConfigAggregation
A expressão de agregação a ser usada no relatório.
Nome | Tipo | Description |
---|---|---|
function |
O nome da função de agregação a ser usada. |
|
name |
string |
O nome da coluna a ser agregada. |
ReportConfigColumnType
O tipo da coluna no relatório.
Nome | Tipo | Description |
---|---|---|
Dimension |
string |
|
Tag |
string |
ReportConfigComparisonExpression
A expressão de comparação a ser usada no relatório.
Nome | Tipo | Description |
---|---|---|
name |
string |
O nome da coluna a ser usada em comparação. |
operator |
O operador a ser usado para comparação. |
|
values |
string[] |
Matriz de valores a serem usados para comparação |
ReportConfigDataset
A definição de dados presentes no relatório.
Nome | Tipo | Description |
---|---|---|
aggregation |
<string,
Report |
Dicionário de expressão de agregação a ser usado no relatório. A chave de cada item no dicionário é o alias da coluna agregada. O relatório pode ter até 2 cláusulas de agregação. |
configuration |
Tem informações de configuração para os dados no relatório. A configuração será ignorada se a agregação e o agrupamento forem fornecidos. |
|
filter |
Tem expressão de filtro a ser usada no relatório. |
|
granularity |
A granularidade das linhas no relatório. |
|
grouping |
Matriz de grupo por expressão a ser usada no relatório. O relatório pode ter até 2 cláusulas de grupo por. |
ReportConfigDatasetConfiguration
A configuração do conjunto de dados no relatório.
Nome | Tipo | Description |
---|---|---|
columns |
string[] |
Matriz de nomes de coluna a serem incluídos no relatório. Qualquer nome de coluna de relatório válido é permitido. Se não for fornecido, o relatório inclui todas as colunas. |
ReportConfigDefinition
A definição de uma configuração de relatório.
Nome | Tipo | Description |
---|---|---|
dataset |
Tem definição de dados nesta configuração de relatório. |
|
timePeriod |
Tem um período de tempo para efetuar pull de dados para o relatório. |
|
timeframe |
O período para efetuar pull de dados para o relatório. Se personalizado, um período de tempo específico deve ser fornecido. |
|
type |
O tipo do relatório. |
ReportConfigDeliveryDestination
As informações de destino para a entrega do relatório.
Nome | Tipo | Description |
---|---|---|
container |
string |
O nome do contêiner em que os relatórios serão carregados. |
resourceId |
string |
A ID do recurso da conta de armazenamento em que os relatórios serão entregues. |
rootFolderPath |
string |
O nome do diretório em que os relatórios serão carregados. |
ReportConfigDeliveryInfo
As informações de entrega associadas a uma configuração de relatório.
Nome | Tipo | Description |
---|---|---|
destination |
Tem o destino do relatório que está sendo entregue. |
ReportConfigFilter
A expressão de filtro a ser usada no relatório.
Nome | Tipo | Description |
---|---|---|
and |
A expressão lógica "AND". Deve ter pelo menos 2 itens. |
|
dimension |
Tem expressão de comparação para uma dimensão |
|
not |
A expressão lógica "NOT". |
|
or |
A expressão lógica "OR". Deve ter pelo menos 2 itens. |
|
tag |
Tem expressão de comparação para uma marca |
ReportConfigGrouping
O grupo por expressão a ser usado no relatório.
Nome | Tipo | Description |
---|---|---|
columnType |
Tem o tipo da coluna a ser agrupada. |
|
name |
string |
O nome da coluna a ser agrupada. |
ReportConfigRecurrencePeriod
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. Se não for fornecido, o padrão será de 10 anos a partir da data de início. |
ReportConfigSchedule
A agenda associada a uma configuração de relatório.
Nome | Tipo | Description |
---|---|---|
recurrence |
A recorrência de agendamento. |
|
recurrencePeriod |
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 |
O status da agenda. Ativo ou não. Se inativa, a execução agendada do relatório será pausada. |
ReportConfigTimePeriod
A data de início e término para efetuar pull de dados para o relatório.
Nome | Tipo | Description |
---|---|---|
from |
string |
A data de início da qual os dados serão extraídos. |
to |
string |
A data de término para a qual efetuar pull de dados. |
ReportType
O tipo do relatório.
Nome | Tipo | Description |
---|---|---|
Usage |
string |
StatusType
O status da agenda. Ativo ou não. Se inativa, a execução agendada do relatório será pausada.
Nome | Tipo | Description |
---|---|---|
Active |
string |
|
Inactive |
string |
TimeframeType
O período para efetuar pull de dados para o relatório. Se personalizado, um período de tempo específico deve ser fornecido.
Nome | Tipo | Description |
---|---|---|
Custom |
string |
|
MonthToDate |
string |
|
WeekToDate |
string |
|
YearToDate |
string |