Query - Usage By Scope
A definiált hatókör használati adatainak lekérdezése.
POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/query?api-version=2019-09-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
scope
|
path | True |
string |
A lekérdezési és exportálási műveletekhez társított hatókör. Ide tartoznak a resourceGroup-hatókörhöz tartozó "/subscriptions/{subscriptionId}/" előfizetési hatókör, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}", "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" a számlázási fiók hatóköréhez és a "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" a részleg hatóköréhez, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}" a EnrollmentAccount hatókörhöz, a felügyeleti csoport hatóköréhez pedig a "/providers/Microsoft.Management/managementGroups/{managementGroupId}". |
api-version
|
query | True |
string |
Az ügyfélkéréshez használandó API verziója. A jelenlegi verzió: 2018-05-31. |
Kérelem törzse
Name | Kötelező | Típus | Description |
---|---|---|---|
timeframe | True |
A lekérdezés adatainak lekérésének időkerete. Ha egyéni, akkor meg kell adni egy adott időtartamot. |
|
type | True |
A lekérdezés típusa. |
|
dataset |
A lekérdezésben szereplő adatok definíciója. |
||
timePeriod |
Rendelkezik a lekérdezés adatainak lekéréséhez szükséges idővel. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OKÉ. A kérés sikeres volt. |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy miért nem sikerült a művelet. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
user_impersonation | a felhasználói fiók megszemélyesítése |
Példák
BillingAccountQuery
Mintakérelem
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/query?api-version=2019-09-01
{
"type": "Usage",
"timeframe": "MonthToDate",
"dataset": {
"granularity": "Daily",
"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"
]
}
}
]
}
}
}
Mintaválasz
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2018-05-31&$skiptoken=AQAAAA%3D%3D",
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
0.16677720329728665,
"gs-stms-dev",
20180331,
"USD"
]
]
}
}
]
}
BillingAccountQueryGrouping
Mintakérelem
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/query?api-version=2019-09-01
{
"type": "Usage",
"timeframe": "TheLastMonth",
"dataset": {
"granularity": "None",
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"grouping": [
{
"type": "Dimension",
"name": "ResourceGroup"
}
]
}
}
Mintaválasz
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2018-05-31&$skiptoken=AQAAAA%3D%3D",
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
"USD"
]
]
}
}
]
}
DepartmentQuery
Mintakérelem
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/query?api-version=2019-09-01
{
"type": "Usage",
"timeframe": "MonthToDate",
"dataset": {
"granularity": "Daily",
"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"
]
}
}
]
}
}
}
Mintaválasz
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2019-01-01&$skiptoken=AQAAAA%3D%3D",
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
0.16677720329728665,
"gs-stms-dev",
20180331,
"USD"
]
]
}
}
]
}
DepartmentQueryGrouping
Mintakérelem
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/query?api-version=2019-09-01
{
"type": "Usage",
"timeframe": "TheLastMonth",
"dataset": {
"granularity": "None",
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"grouping": [
{
"type": "Dimension",
"name": "ResourceGroup"
}
]
}
}
Mintaválasz
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2019-01-01&$skiptoken=AQAAAA%3D%3D",
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
"USD"
]
]
}
}
]
}
EnrollmentAccountQuery
Mintakérelem
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/query?api-version=2019-09-01
{
"type": "Usage",
"timeframe": "MonthToDate",
"dataset": {
"granularity": "Daily",
"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"
]
}
}
]
}
}
}
Mintaválasz
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2019-01-01&$skiptoken=AQAAAA%3D%3D",
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
0.16677720329728665,
"gs-stms-dev",
20180331,
"USD"
]
]
}
}
]
}
EnrollmentAccountQueryGrouping
Mintakérelem
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/query?api-version=2019-09-01
{
"type": "Usage",
"timeframe": "TheLastMonth",
"dataset": {
"granularity": "Daily",
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"grouping": [
{
"type": "Dimension",
"name": "ResourceGroup"
}
],
"sorting": [
{
"name": "ResourceGroup"
}
]
}
}
Mintaválasz
{
"value": [
{
"id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2019-01-01&$skiptoken=AQAAAA%3D%3D",
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
]
]
}
}
]
}
ManagementGroupQuery
Mintakérelem
POST https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/query?api-version=2019-09-01
{
"type": "Usage",
"timeframe": "MonthToDate",
"dataset": {
"granularity": "Daily",
"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"
]
}
}
]
}
}
}
Mintaválasz
{
"value": [
{
"id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2018-05-31&$skiptoken=AQAAAA%3D%3D",
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
0.16677720329728665,
"gs-stms-dev",
20180331,
"USD"
]
]
}
}
]
}
ManagementGroupQueryGrouping
Mintakérelem
POST https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/query?api-version=2019-09-01
{
"type": "Usage",
"timeframe": "TheLastMonth",
"dataset": {
"granularity": "None",
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"grouping": [
{
"type": "Dimension",
"name": "ResourceGroup"
}
],
"sorting": [
{
"name": "ResourceGroup",
"querySortingDirection": "Descending"
}
]
}
}
Mintaválasz
{
"value": [
{
"id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd",
"type": "microsoft.costmanagement/Query",
"properties": {
"nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2018-05-31&$skiptoken=AQAAAA%3D%3D",
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
20.35941656262545,
"VSTSHOL-1595322048000",
20180331,
"USD"
],
[
173.41979241290323,
"RVIIOT-TRIAL",
20180331,
"USD"
],
[
19.545363672276512,
"JapanUnifia-Trial",
20180331,
"USD"
]
]
}
}
]
}
ResourceGroupQuery
Mintakérelem
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/query?api-version=2019-09-01
{
"type": "Usage",
"timeframe": "MonthToDate",
"dataset": {
"granularity": "Daily",
"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"
]
}
}
]
}
}
}
Mintaválasz
{
"value": [
{
"id": "subscriptions/55312978-ba1b-415c-9304-c4b9c43c0481/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb",
"name": "9af9459d-441d-4055-9ed0-83d4c4a363fb",
"type": "microsoft.costmanagement/Query",
"properties": {
"nextLink": null,
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
2.10333307059661,
"ScreenSharingTest-peer",
20180417,
"USD"
],
[
20.10333307059661,
"ScreenSharingTest-peer",
20180418,
"USD"
]
]
}
}
]
}
ResourceGroupQueryGrouping
Mintakérelem
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/query?api-version=2019-09-01
{
"type": "Usage",
"timeframe": "TheLastMonth",
"dataset": {
"granularity": "Daily",
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"grouping": [
{
"type": "Dimension",
"name": "ResourceType"
}
],
"sorting": [
{
"name": "ResourceType",
"querySortingDirection": "Descending"
}
]
}
}
Mintaválasz
{
"value": [
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb",
"name": "9af9459d-441d-4055-9ed0-83d4c4a363fb",
"type": "microsoft.costmanagement/Query",
"properties": {
"nextLink": null,
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceType",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
2.10333307059661,
"Microsoft.SqlServer",
20180417,
"USD"
],
[
20.10333307059661,
"Microsoft.Compute",
20180418,
"USD"
]
]
}
}
]
}
SubscriptionQuery
Mintakérelem
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/query?api-version=2019-09-01
{
"type": "Usage",
"timeframe": "MonthToDate",
"dataset": {
"granularity": "Daily",
"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"
]
}
}
]
},
"sorting": [
{
"name": "UsageDate",
"querySortingDirection": "Ascending"
}
]
}
}
Mintaválasz
{
"value": [
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000",
"name": "55312978-ba1b-415c-9304-cfd9c43c0481",
"type": "microsoft.costmanagement/Query",
"properties": {
"nextLink": null,
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "UsageDate",
"type": "Number"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
2.10333307059661,
"ScreenSharingTest-peer",
20180331,
"USD"
],
[
218.68795741935486,
"Ict_StratAndPlan_GoldSprova_Prod",
20180331,
"USD"
],
[
0.14384913581657052,
"ssbciotelement01",
20180401,
"USD"
],
[
0.009865586851323632,
"ict_stratandplan_goldsprova_prod",
20180429,
"USD"
]
]
}
}
]
}
SubscriptionQueryGrouping
Mintakérelem
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/query?api-version=2019-09-01
{
"type": "Usage",
"timeframe": "TheLastMonth",
"dataset": {
"granularity": "None",
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"grouping": [
{
"type": "Dimension",
"name": "ResourceGroup"
}
],
"sorting": [
{
"name": "ResourceGroup"
}
]
}
}
Mintaválasz
{
"value": [
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000",
"name": "55312978-ba1b-415c-9304-cfd9c43c0481",
"type": "microsoft.costmanagement/Query",
"properties": {
"nextLink": null,
"columns": [
{
"name": "PreTaxCost",
"type": "Number"
},
{
"name": "ResourceGroup",
"type": "String"
},
{
"name": "Currency",
"type": "String"
}
],
"rows": [
[
0.009865586851323632,
"Ict_StratAndPlan_GoldSprova_Prod_0",
"USD"
],
[
218.68795741935486,
"Ict_StratAndPlan_GoldSprova_Prod_1",
"USD"
],
[
2.10333307059661,
"ScreenSharingTest-peer1",
"USD"
],
[
0.14384913581657052,
"Ssbciotelement01",
"USD"
]
]
}
}
]
}
Definíciók
Name | Description |
---|---|
Error |
A hiba részletei. |
Error |
A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg. |
Export |
A lekérdezés típusa. |
Function |
A használni kívánt összesítő függvény neve. |
Granularity |
A lekérdezés sorainak részletessége. |
Operator |
Az összehasonlításhoz használni kívánt operátor. |
Query | |
Query |
A lekérdezésben használandó összesítési kifejezés. |
Query |
|
Query |
Az exportálásban szereplő oszlop típusa. |
Query |
A lekérdezésben használandó összehasonlító kifejezés. |
Query |
A lekérdezésben található adatok definíciója. |
Query |
Az adathalmaz konfigurációja a lekérdezésben. |
Query |
A lekérdezés definíciója. |
Query |
Az exportálásban használandó szűrőkifejezés. |
Query |
A lekérdezésben használandó kifejezés szerinti csoportosítás. |
Query |
A lekérdezés eredménye. A csoportosítások és összesítések alatt felsorolt összes oszlopot tartalmazza. |
Query |
A lekérdezés rendezési konfigurációja. |
Query |
A lekérdezés adatainak lekérésének kezdő és záró dátuma. |
Sort |
A rendezési irány |
Timeframe |
A lekérdezés adatainak lekérésének időkerete. Ha egyéni, akkor meg kell adni egy adott időtartamot. |
ErrorDetails
A hiba részletei.
Name | Típus | Description |
---|---|---|
code |
string |
Hibakód. |
message |
string |
A művelet sikertelen voltát jelző hibaüzenet. |
ErrorResponse
A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.
Name | Típus | Description |
---|---|---|
error |
A hiba részletei. |
ExportType
A lekérdezés típusa.
Érték | Description |
---|---|
Usage |
FunctionType
A használni kívánt összesítő függvény neve.
Érték | Description |
---|---|
Sum |
GranularityType
A lekérdezés sorainak részletessége.
Érték | Description |
---|---|
Daily | |
Hourly |
OperatorType
Az összehasonlításhoz használni kívánt operátor.
Érték | Description |
---|---|
In |
Query
Name | Típus | Description |
---|---|---|
id |
string |
Erőforrás-azonosító. |
name |
string |
Erőforrás neve. |
properties.columns |
Oszlopok tömbje |
|
properties.nextLink |
string |
|
properties.rows |
Rows[] |
|
tags |
object |
Erőforráscímkék. |
type |
string |
Erőforrás típusa. |
QueryAggregation
A lekérdezésben használandó összesítési kifejezés.
Name | Típus | Description |
---|---|---|
function |
A használni kívánt összesítő függvény neve. |
|
name |
string |
Az összesítendő oszlop neve. |
QueryColumn
Name | Típus | Description |
---|---|---|
name |
string |
|
type |
string |
QueryColumnType
Az exportálásban szereplő oszlop típusa.
Érték | Description |
---|---|
Dimension | |
Tag |
QueryComparisonExpression
A lekérdezésben használandó összehasonlító kifejezés.
Name | Típus | Description |
---|---|---|
name |
string |
Az összehasonlítandó oszlop neve. |
operator |
Az összehasonlításhoz használni kívánt operátor. |
|
values |
string[] |
Összehasonlításhoz használandó értékek tömbje |
QueryDataset
A lekérdezésben található adatok definíciója.
Name | Típus | Description |
---|---|---|
aggregation |
<string,
Query |
A lekérdezésben használandó összesítési kifejezés szótára. A szótár minden elemének kulcsa az összesített oszlop aliasa. A lekérdezés legfeljebb 2 összesítési záradékkal rendelkezhet. |
configuration |
Konfigurációs információkat tartalmaz az exportálásban lévő adatokról. A konfiguráció figyelmen kívül lesz hagyva, ha az összesítés és a csoportosítás meg van adva. |
|
filter |
A lekérdezésben használandó szűrőkifejezés. A szűrő megfelelő formázásához tekintse meg a Query API REST dokumentációját. |
|
granularity |
A lekérdezés sorainak részletessége. |
|
grouping |
A lekérdezésben használandó csoportosítási kifejezés tömbje. A lekérdezés legfeljebb 2 csoportot tartalmazhat záradékok szerint. |
|
sorting |
A lekérdezés oszlopai szerinti rendezés tömbje. |
QueryDatasetConfiguration
Az adathalmaz konfigurációja a lekérdezésben.
Name | Típus | Description |
---|---|---|
columns |
string[] |
A lekérdezésben szerepeltetni kívánt oszlopnevek tömbje. Bármely érvényes lekérdezésoszlop neve engedélyezett. Ha nincs megadva, akkor a lekérdezés az összes oszlopot tartalmazza. |
QueryDefinition
A lekérdezés definíciója.
Name | Típus | Description |
---|---|---|
dataset |
A lekérdezésben szereplő adatok definíciója. |
|
timePeriod |
Rendelkezik a lekérdezés adatainak lekéréséhez szükséges idővel. |
|
timeframe |
A lekérdezés adatainak lekérésének időkerete. Ha egyéni, akkor meg kell adni egy adott időtartamot. |
|
type |
A lekérdezés típusa. |
QueryFilter
Az exportálásban használandó szűrőkifejezés.
Name | Típus | Description |
---|---|---|
and |
A logikai "AND" kifejezés. Legalább 2 elemnek kell lennie. |
|
dimension |
Dimenzió összehasonlító kifejezéssel rendelkezik |
|
not |
A logikai "NOT" kifejezés. |
|
or |
A logikai "OR" kifejezés. Legalább 2 elemnek kell lennie. |
|
tag |
Címkéhez tartozó összehasonlító kifejezéssel rendelkezik |
QueryGrouping
A lekérdezésben használandó kifejezés szerinti csoportosítás.
Name | Típus | Description |
---|---|---|
name |
string |
A csoportosítandó oszlop neve. |
type |
A csoportosítandó oszlop típusa. |
QueryResult
A lekérdezés eredménye. A csoportosítások és összesítések alatt felsorolt összes oszlopot tartalmazza.
Name | Típus | Description |
---|---|---|
value |
Query[] |
A használati adatok listája. |
QuerySortingConfiguration
A lekérdezés rendezési konfigurációja.
Name | Típus | Description |
---|---|---|
name |
string |
A rendezéshez használni kívánt oszlop neve. |
querySortingDirection |
A rendezési irány |
QueryTimePeriod
A lekérdezés adatainak lekérésének kezdő és záró dátuma.
Name | Típus | Description |
---|---|---|
from |
string (date-time) |
Az adatok lekérésének kezdő dátuma. |
to |
string (date-time) |
Az adatok lekérésének záró dátuma. |
SortDirection
A rendezési irány
Érték | Description |
---|---|
Ascending | |
Descending |
TimeframeType
A lekérdezés adatainak lekérésének időkerete. Ha egyéni, akkor meg kell adni egy adott időtartamot.
Érték | Description |
---|---|
Custom | |
MonthToDate | |
TheLastMonth | |
TheLastWeek | |
TheLastYear | |
WeekToDate | |
YearToDate |