Report Config - List By Resource Group Name

Usługa:

Cost Management

Wersja interfejsu API:

2018-05-31

Wyświetla listę wszystkich konfiguracji raportu dla grupy zasobów w ramach subskrypcji.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/reportconfigs?api-version=2018-05-31

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów platformy Azure.
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta. Bieżąca wersja to 2018-05-31.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ReportConfigListResult	OK. Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ReportConfigList

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/reportconfigs?api-version=2018-05-31

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/reportconfigs/TestReportConfig1",
      "name": "TestReportConfig1",
      "type": "Microsoft.Consumption/reportconfigs",
      "properties": {
        "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": "Custom",
          "timePeriod": {
            "from": "2018-06-01T00:00:00Z",
            "to": "2018-10-31T00:00:00Z"
          },
          "dataset": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "InstanceId",
                "ResourceLocation",
                "PreTaxCost"
              ]
            },
            "aggregation": {
              "costSum": {
                "name": "PreTaxCost",
                "function": "Sum"
              }
            },
            "grouping": [
              {
                "columnType": "Dimension",
                "name": "SubscriptionName"
              }
            ],
            "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/TestReportConfig2",
      "name": "TestReportConfig2",
      "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": "WeekToDate",
          "dataset": {
            "granularity": "Daily",
            "configuration": {
              "columns": [
                "Date",
                "MeterId",
                "InstanceId",
                "ResourceLocation",
                "UsageQuantity"
              ]
            },
            "aggregation": {
              "usageSum": {
                "name": "UsageQuantity",
                "function": "Sum"
              }
            },
            "grouping": [
              {
                "columnType": "Tag",
                "name": "Environment"
              }
            ],
            "filter": {
              "and": [
                {
                  "dimension": {
                    "name": "ResourceLocation",
                    "operator": "In",
                    "values": [
                      "East US",
                      "West Europe"
                    ]
                  }
                },
                {
                  "tag": {
                    "name": "Environment",
                    "operator": "In",
                    "values": [
                      "UAT",
                      "Prod"
                    ]
                  }
                }
              ]
            }
          }
        }
      }
    }
  ]
}

Definicje

Nazwa	Opis
ErrorDetails	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.
FormatType	Format dostarczanego raportu.
FunctionType	Nazwa funkcji agregacji do użycia.
GranularityType	Stopień szczegółowości wierszy w raporcie.
OperatorType	Operator, który ma być używany do porównania.
RecurrenceType	Cykl harmonogramu.
ReportConfig	Zasób konfiguracji raportu.
ReportConfigAggregation	Wyrażenie agregacji, które ma być używane w raporcie.
ReportConfigColumnType	Typ kolumny w raporcie.
ReportConfigComparisonExpression	Wyrażenie porównania, które ma być używane w raporcie.
ReportConfigDataset	Definicja danych znajdujących się w raporcie.
ReportConfigDatasetConfiguration	Konfiguracja zestawu danych w raporcie.
ReportConfigDefinition	Definicja konfiguracji raportu.
ReportConfigDeliveryDestination	Informacje docelowe dotyczące dostarczania raportu.
ReportConfigDeliveryInfo	Informacje o dostarczaniu skojarzone z konfiguracją raportu.
ReportConfigFilter	Wyrażenie filtru do użycia w raporcie.
ReportConfigGrouping	Grupa według wyrażenia, która ma być używana w raporcie.
ReportConfigListResult	Wynik wyświetlania listy konfiguracji raportu. Zawiera listę dostępnych konfiguracji raportów w podanym zakresie.
ReportConfigRecurrencePeriod	Data rozpoczęcia i zakończenia harmonogramu cyklu.
ReportConfigSchedule	Harmonogram skojarzony z konfiguracją raportu.
ReportConfigTimePeriod	Data rozpoczęcia i zakończenia ściągania danych dla raportu.
ReportType	Typ raportu.
StatusType	Stan harmonogramu. Bez względu na to, czy jest aktywny, czy nie. Jeśli nieaktywne, zaplanowane wykonanie raportu zostanie wstrzymane.
TimeframeType	Przedział czasu na ściąganie danych dla raportu. Jeśli jest to niestandardowe, należy podać określony okres.

ErrorDetails

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponse

Objekt

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. Przyczyna jest podana w komunikacie o błędzie.

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu.

FormatType

Wyliczanie

Format dostarczanego raportu.

Wartość	Opis
Csv

FunctionType

Wyliczanie

Nazwa funkcji agregacji do użycia.

Wartość	Opis
Sum

GranularityType

Wyliczanie

Stopień szczegółowości wierszy w raporcie.

Wartość	Opis
Daily

OperatorType

Wyliczanie

Operator, który ma być używany do porównania.

Wartość	Opis
In

RecurrenceType

Wyliczanie

Cykl harmonogramu.

Wartość	Opis
Daily
Weekly
Monthly
Annually

ReportConfig

Objekt

Zasób konfiguracji raportu.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.definition	ReportConfigDefinition	Zawiera definicję konfiguracji raportu.
properties.deliveryInfo	ReportConfigDeliveryInfo	Zawiera informacje o dostarczaniu dla konfiguracji raportu.
properties.format	FormatType	Format dostarczanego raportu.
properties.schedule	ReportConfigSchedule	Zawiera informacje o harmonogramie konfiguracji raportu.
tags	object	Tagi zasobów.
type	string	Typ zasobu.

ReportConfigAggregation

Objekt

Wyrażenie agregacji, które ma być używane w raporcie.

Nazwa	Typ	Opis
function	FunctionType	Nazwa funkcji agregacji do użycia.
name	string	Nazwa kolumny do agregowania.

ReportConfigColumnType

Wyliczanie

Typ kolumny w raporcie.

Wartość	Opis
Tag
Dimension

ReportConfigComparisonExpression

Objekt

Wyrażenie porównania, które ma być używane w raporcie.

Nazwa	Typ	Opis
name	string	Nazwa kolumny do użycia w porównaniu.
operator	OperatorType	Operator, który ma być używany do porównania.
values	string[]	Tablica wartości do użycia do porównania

ReportConfigDataset

Objekt

Definicja danych znajdujących się w raporcie.

Nazwa	Typ	Opis
aggregation	<string,  ReportConfigAggregation>	Słownik wyrażenia agregacji do użycia w raporcie. Kluczem każdego elementu w słowniku jest alias kolumny zagregowanej. Raport może mieć maksymalnie 2 klauzule agregacji.
configuration	ReportConfigDatasetConfiguration	Zawiera informacje o konfiguracji danych w raporcie. Konfiguracja zostanie zignorowana, jeśli podano agregację i grupowanie.
filter	ReportConfigFilter	Zawiera wyrażenie filtru do użycia w raporcie.
granularity	GranularityType	Stopień szczegółowości wierszy w raporcie.
grouping	ReportConfigGrouping[]	Tablica grupowania według wyrażenia do użycia w raporcie. Raport może mieć maksymalnie 2 klauzule grupowania.

ReportConfigDatasetConfiguration

Objekt

Konfiguracja zestawu danych w raporcie.

Nazwa	Typ	Opis
columns	string[]	Tablica nazw kolumn, które mają być uwzględnione w raporcie. Dowolna prawidłowa nazwa kolumny raportu jest dozwolona. Jeśli nie zostanie podany, raport zawiera wszystkie kolumny.

ReportConfigDefinition

Objekt

Definicja konfiguracji raportu.

Nazwa	Typ	Opis
dataset	ReportConfigDataset	Zawiera definicję danych w tej konfiguracji raportu.
timePeriod	ReportConfigTimePeriod	Zawiera okres czasu na ściąganie danych dla raportu.
timeframe	TimeframeType	Przedział czasu na ściąganie danych dla raportu. Jeśli jest to niestandardowe, należy podać określony okres.
type	ReportType	Typ raportu.

ReportConfigDeliveryDestination

Objekt

Informacje docelowe dotyczące dostarczania raportu.

Nazwa	Typ	Opis
container	string	Nazwa kontenera, w którym będą przekazywane raporty.
resourceId	string	Identyfikator zasobu konta magazynu, na którym będą dostarczane raporty.
rootFolderPath	string	Nazwa katalogu, w którym będą przekazywane raporty.

ReportConfigDeliveryInfo

Objekt

Informacje o dostarczaniu skojarzone z konfiguracją raportu.

Nazwa	Typ	Opis
destination	ReportConfigDeliveryDestination	Ma miejsce docelowe dla dostarczanego raportu.

ReportConfigFilter

Objekt

Wyrażenie filtru do użycia w raporcie.

Nazwa	Typ	Opis
and	ReportConfigFilter[]	Logiczne wyrażenie "AND". Musi zawierać co najmniej 2 elementy.
dimension	ReportConfigComparisonExpression	Zawiera wyrażenie porównania dla wymiaru
not	ReportConfigFilter	Wyrażenie logiczne "NOT".
or	ReportConfigFilter[]	Logiczne wyrażenie "OR". Musi zawierać co najmniej 2 elementy.
tag	ReportConfigComparisonExpression	Zawiera wyrażenie porównania dla tagu

ReportConfigGrouping

Objekt

Grupa według wyrażenia, która ma być używana w raporcie.

Nazwa	Typ	Opis
columnType	ReportConfigColumnType	Ma typ kolumny do grupy.
name	string	Nazwa kolumny do grupy.

ReportConfigListResult

Objekt

Wynik wyświetlania listy konfiguracji raportu. Zawiera listę dostępnych konfiguracji raportów w podanym zakresie.

Nazwa	Typ	Opis
value	ReportConfig[]	Lista konfiguracji raportu.

ReportConfigRecurrencePeriod

Objekt

Data rozpoczęcia i zakończenia harmonogramu cyklu.

Nazwa	Typ	Opis
from	string (date-time)	Data rozpoczęcia cyklu.
to	string (date-time)	Data zakończenia cyklu. Jeśli nie zostanie podana, wartość domyślna to 10 lat od daty rozpoczęcia.

ReportConfigSchedule

Objekt

Harmonogram skojarzony z konfiguracją raportu.

Nazwa	Typ	Opis
recurrence	RecurrenceType	Cykl harmonogramu.
recurrencePeriod	ReportConfigRecurrencePeriod	Ma datę rozpoczęcia i zakończenia cyklu. Data rozpoczęcia musi być w przyszłości. Jeśli jest obecna, data zakończenia musi być większa niż data rozpoczęcia.
status	StatusType	Stan harmonogramu. Bez względu na to, czy jest aktywny, czy nie. Jeśli nieaktywne, zaplanowane wykonanie raportu zostanie wstrzymane.

ReportConfigTimePeriod

Objekt

Data rozpoczęcia i zakończenia ściągania danych dla raportu.

Nazwa	Typ	Opis
from	string (date-time)	Data rozpoczęcia ściągania danych.
to	string (date-time)	Data zakończenia do ściągnięcia danych.

ReportType

Wyliczanie

Typ raportu.

Wartość	Opis
Usage

StatusType

Wyliczanie

Stan harmonogramu. Bez względu na to, czy jest aktywny, czy nie. Jeśli nieaktywne, zaplanowane wykonanie raportu zostanie wstrzymane.

Wartość	Opis
Active
Inactive

TimeframeType

Wyliczanie

Przedział czasu na ściąganie danych dla raportu. Jeśli jest to niestandardowe, należy podać określony okres.

Wartość	Opis
WeekToDate
MonthToDate
YearToDate
Custom