Add/update configuration options definitions in the docs + add additional option for storage account

packages/azure_metrics/_dev/build/docs/compute_vm.md

@@ -1,6 +1,5 @@
 # Azure Compute VM Integration
 
-
 The Azure Compute VM data stream collects and aggregates storage account related metrics from azure virtual machine type resources where it can be used for analysis, visualization, and alerting.
 The Azure Compute VM will periodically retrieve the azure monitor metrics using the Azure REST APIs as MetricList.
 Additional azure API calls will be executed in order to retrieve information regarding the resources targeted by the user.
@@ -14,20 +13,20 @@ For a more detailed walk-through, have a look at using Azure PowerShell to creat
  It is also possible to create a service principal via the Azure portal https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal.
 Users will have to make sure the roles assigned to the application contain at least reading permissions to the monitor data, more on the roles here https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles.
 
-Required credentials for the `azure` resource metrics integration:
+Required credentials for the `azure_metrics` integration:
 
-`client_id`:: The unique identifier for the application (also known as Application Id)
+`Client ID`:: The unique identifier for the application (also known as Application Id)
 
-`client_secret`:: The client/application secret/key
+`Client Secret`:: The client/application secret/key
 
-`subscription_id`:: The unique identifier for the azure subscription
+`Subscription ID`:: The unique identifier for the azure subscription
 
-`tenant_id`:: The unique identifier of the Azure Active Directory instance
+`Tenant ID`:: The unique identifier of the Azure Active Directory instance
 
 
 The azure credentials keys can be used if configured `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, `AZURE_TENANT_ID`, `AZURE_SUBSCRIPTION_ID`
 
-`resource_manager_endpoint` ::
+`Resource Manager Endpoint` ::
 _string_
 Optional, by default the azure public environment will be used, to override, users can provide a specific resource manager endpoint in order to use a different azure environment.
 Ex:
@@ -36,7 +35,7 @@ https://management.microsoftazure.de for azure GermanCloud
 https://management.azure.com for azure PublicCloud
 https://management.usgovcloudapi.net for azure USGovernmentCloud
 
-`active_directory_endpoint` ::
+`Active Directory Endpoint` ::
 _string_
 Optional, by default the associated active directory endpoint to the resource manager endpoint will be used, to override, users can provide a specific active directory endpoint in order to use a different azure environment.
 Ex:
@@ -46,10 +45,19 @@ https://login.chinacloudapi.cn for azure PublicCloud
 https://login.microsoftonline.de for azure USGovernmentCloud
 
 
-This data stream will collect metrics from the virtual machines, these metrics will have a timegrain every 5 minutes,
-so the `period` for `compute_vm` should be `300s` or multiples of `300s`.
+### Data stream specific configuration notes
+
+`Period`:: (_string_) Reporting interval. Metrics will have a timegrain of 5 minutes, so the `Period` configuration option for `compute_vm` should have a value of `300s` or multiple of `300s`for relevant results.
+
+`Resource IDs`:: (_[]string_) The fully qualified ID's of the resource, including the resource name and resource type. Has the format /subscriptions/{guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}.
+ Should return a list of resources.
+
+`Resource Groups`:: (_[]string_) This option will return all virtual machines inside the resource group.
+
+If no resource filter is specified, then all virtual machines inside the entire subscription will be considered.
+
+The primary aggregation value will be retrieved for all the metrics contained in the namespaces. The aggregation options are `avg`, `sum`, `min`, `max`, `total`, `count`.
 
-{{fields "compute_vm"}}
 
 ## Guest metrics 
 
@@ -61,3 +69,5 @@ Once this monitoring feature is enabled in the Diagnostic Settings area (Perform
 Costs: Metric queries are charged based on the number of standard API calls. More information on pricing here https://azure.microsoft.com/id-id/pricing/details/monitor/.
 
 Authentication: Dedicated authentication token will be created and updated regularly, it is advised to not share the credentials entered.
+
+{{fields "compute_vm"}}

packages/azure_metrics/_dev/build/docs/compute_vm_scaleset.md

@@ -14,20 +14,20 @@ For a more detailed walk-through, have a look at using Azure PowerShell to creat
  It is also possible to create a service principal via the Azure portal https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal.
 Users will have to make sure the roles assigned to the application contain at least reading permissions to the monitor data, more on the roles here https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles.
 
-Required credentials for the `azure` resource metrics integration:
+Required credentials for the `azure_metrics` integration:
 
-`client_id`:: The unique identifier for the application (also known as Application Id)
+`Client ID`:: The unique identifier for the application (also known as Application Id)
 
-`client_secret`:: The client/application secret/key
+`Client Secret`:: The client/application secret/key
 
-`subscription_id`:: The unique identifier for the azure subscription
+`Subscription ID`:: The unique identifier for the azure subscription
 
-`tenant_id`:: The unique identifier of the Azure Active Directory instance
+`Tenant ID`:: The unique identifier of the Azure Active Directory instance
 
 
 The azure credentials keys can be used if configured `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, `AZURE_TENANT_ID`, `AZURE_SUBSCRIPTION_ID`
 
-`resource_manager_endpoint` ::
+`Resource Manager Endpoint` ::
 _string_
 Optional, by default the azure public environment will be used, to override, users can provide a specific resource manager endpoint in order to use a different azure environment.
 Ex:
@@ -36,7 +36,7 @@ https://management.microsoftazure.de for azure GermanCloud
 https://management.azure.com for azure PublicCloud
 https://management.usgovcloudapi.net for azure USGovernmentCloud
 
-`active_directory_endpoint` ::
+`Active Directory Endpoint` ::
 _string_
 Optional, by default the associated active directory endpoint to the resource manager endpoint will be used, to override, users can provide a specific active directory endpoint in order to use a different azure environment.
 Ex:
@@ -46,14 +46,25 @@ https://login.chinacloudapi.cn for azure PublicCloud
 https://login.microsoftonline.de for azure USGovernmentCloud
 
 
-This data stream will collect metrics from the virtual machine scalesets, these metrics will have a timegrain every 5 minutes,
-so the `period` for `compute_vm_scaleset` should be `300s` or multiples of `300s`.
+### Data stream specific configuration notes
+
+`Period`:: (_string_) Reporting interval. Metrics will have a timegrain of 5 minutes, so the `Period` configuration option for `compute_vm_scaleset` should have a value of `300s` or multiple of `300s`for relevant results.
+
+`Resource IDs`:: (_[]string_) The fully qualified ID's of the resource, including the resource name and resource type. Has the format /subscriptions/{guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}.
+ Should return a list of resources.
+
+`Resource Groups`:: (_[]string_) This option will return all virtual machine scalesets inside the resource group.
+
+If no resource filter is specified, then all virtual machine scalesets inside the entire subscription will be considered.
+
+The primary aggregation value will be retrieved for all the metrics contained in the namespaces. The aggregation options are `avg`, `sum`, `min`, `max`, `total`, `count`.
 
-{{fields "compute_vm_scaleset"}}
 
 
 ## Additional notes about metrics and costs
 
 Costs: Metric queries are charged based on the number of standard API calls. More information on pricing here https://azure.microsoft.com/id-id/pricing/details/monitor/.
 
 Authentication: we are handling authentication on our side (creating/renewing the authentication token), so we advise users to use dedicated credentials for metricbeat only.
+
+{{fields "compute_vm_scaleset"}}

packages/azure_metrics/_dev/build/docs/container_instance.md

@@ -14,20 +14,20 @@ For a more detailed walk-through, have a look at using Azure PowerShell to creat
  It is also possible to create a service principal via the Azure portal https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal.
 Users will have to make sure the roles assigned to the application contain at least reading permissions to the monitor data, more on the roles here https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles.
 
-Required credentials for the `azure` resource metrics integration:
+Required credentials for the `azure_metrics` resource metrics integration:
 
-`client_id`:: The unique identifier for the application (also known as Application Id)
+`Client ID`:: The unique identifier for the application (also known as Application Id)
 
-`client_secret`:: The client/application secret/key
+`Client Secret`:: The client/application secret/key
 
-`subscription_id`:: The unique identifier for the azure subscription
+`Subscription ID`:: The unique identifier for the azure subscription
 
-`tenant_id`:: The unique identifier of the Azure Active Directory instance
+`Tenant ID`:: The unique identifier of the Azure Active Directory instance
 
 
 The azure credentials keys can be used if configured `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, `AZURE_TENANT_ID`, `AZURE_SUBSCRIPTION_ID`
 
-`resource_manager_endpoint` ::
+`Resource Manager Endpoint` ::
 _string_
 Optional, by default the azure public environment will be used, to override, users can provide a specific resource manager endpoint in order to use a different azure environment.
 Ex:
@@ -36,7 +36,7 @@ https://management.microsoftazure.de for azure GermanCloud
 https://management.azure.com for azure PublicCloud
 https://management.usgovcloudapi.net for azure USGovernmentCloud
 
-`active_directory_endpoint` ::
+`Active Directory Endpoint` ::
 _string_
 Optional, by default the associated active directory endpoint to the resource manager endpoint will be used, to override, users can provide a specific active directory endpoint in order to use a different azure environment.
 Ex:
@@ -46,14 +46,25 @@ https://login.chinacloudapi.cn for azure PublicCloud
 https://login.microsoftonline.de for azure USGovernmentCloud
 
 
-This data stream will collect metrics from specified container groups, these metrics will have a timegrain every 5 minutes,
-so the `period` for `container_instance` should be `300s` or multiples of `300s`.
+### Data stream specific configuration notes
+
+`Period`:: (_string_) Reporting interval. Metrics will have a timegrain of 5 minutes, so the `Period` configuration option for `container_instance` should have a value of `300s` or multiple of `300s`for relevant results.
+
+`Resource IDs`:: (_[]string_) The fully qualified ID's of the resource, including the resource name and resource type. Has the format /subscriptions/{guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}.
+ Should return a list of resources.
+
+`Resource Groups`:: (_[]string_) This option will return all container instances inside the resource group.
+
+If no resource filter is specified, then all container instances inside the entire subscription will be considered.
+
+The primary aggregation value will be retrieved for all the metrics contained in the namespaces. The aggregation options are `avg`, `sum`, `min`, `max`, `total`, `count`.
 
-{{fields "container_instance"}}
 
 
 ## Additional notes about metrics and costs
 
 Costs: Metric queries are charged based on the number of standard API calls. More information on pricing here https://azure.microsoft.com/id-id/pricing/details/monitor/.
 
 Authentication: we are handling authentication on our side (creating/renewing the authentication token), so we advise users to use dedicated credentials for metricbeat only.
+
+{{fields "container_instance"}}

packages/azure_metrics/_dev/build/docs/container_registry.md

@@ -14,20 +14,20 @@ For a more detailed walk-through, have a look at using Azure PowerShell to creat
  It is also possible to create a service principal via the Azure portal https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal.
 Users will have to make sure the roles assigned to the application contain at least reading permissions to the monitor data, more on the roles here https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles.
 
-Required credentials for the `azure` resource metrics integration:
+Required credentials for the `azure_metrics` integration:
 
-`client_id`:: The unique identifier for the application (also known as Application Id)
+`Client ID`:: The unique identifier for the application (also known as Application Id)
 
-`client_secret`:: The client/application secret/key
+`Client Secret`:: The client/application secret/key
 
-`subscription_id`:: The unique identifier for the azure subscription
+`Subscription ID`:: The unique identifier for the azure subscription
 
-`tenant_id`:: The unique identifier of the Azure Active Directory instance
+`Tenant ID`:: The unique identifier of the Azure Active Directory instance
 
 
 The azure credentials keys can be used if configured `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, `AZURE_TENANT_ID`, `AZURE_SUBSCRIPTION_ID`
 
-`resource_manager_endpoint` ::
+`Resource Manager Endpoint` ::
 _string_
 Optional, by default the azure public environment will be used, to override, users can provide a specific resource manager endpoint in order to use a different azure environment.
 Ex:
@@ -36,7 +36,7 @@ https://management.microsoftazure.de for azure GermanCloud
 https://management.azure.com for azure PublicCloud
 https://management.usgovcloudapi.net for azure USGovernmentCloud
 
-`active_directory_endpoint` ::
+`Active Directory Endpoint` ::
 _string_
 Optional, by default the associated active directory endpoint to the resource manager endpoint will be used, to override, users can provide a specific active directory endpoint in order to use a different azure environment.
 Ex:
@@ -46,14 +46,25 @@ https://login.chinacloudapi.cn for azure PublicCloud
 https://login.microsoftonline.de for azure USGovernmentCloud
 
 
-This data stream will collect metrics from the container registries, these metrics will have a timegrain every 5 minutes,
-so the `period` for `container_registry` should be `300s` or multiples of `300s`.
+### Data stream specific configuration notes
+
+`Period`:: (_string_) Reporting interval. Metrics will have a timegrain of 5 minutes, so the `Period` configuration option for `container_registry` should have a value of `300s` or multiple of `300s`for relevant results.
+
+`Resource IDs`:: (_[]string_) The fully qualified ID's of the resource, including the resource name and resource type. Has the format /subscriptions/{guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}.
+ Should return a list of resources.
+
+`Resource Groups`:: (_[]string_) This option will return all container registries inside the resource group.
+
+If no resource filter is specified, then all container registries inside the entire subscription will be considered.
+
+The primary aggregation value will be retrieved for all the metrics contained in the namespaces. The aggregation options are `avg`, `sum`, `min`, `max`, `total`, `count`.
 
-{{fields "container_registry"}}
 
 
 ## Additional notes about metrics and costs
 
 Costs: Metric queries are charged based on the number of standard API calls. More information on pricing here https://azure.microsoft.com/id-id/pricing/details/monitor/.
 
 Authentication: we are handling authentication on our side (creating/renewing the authentication token), so we advise users to use dedicated credentials for metricbeat only.
+
+{{fields "container_registry"}}

packages/azure_metrics/_dev/build/docs/container_service.md

@@ -14,20 +14,20 @@ For a more detailed walk-through, have a look at using Azure PowerShell to creat
  It is also possible to create a service principal via the Azure portal https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal.
 Users will have to make sure the roles assigned to the application contain at least reading permissions to the monitor data, more on the roles here https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles.
 
-Required credentials for the `azure` resource metrics integration:
+Required credentials for the `azure_metrics` integration:
 
-`client_id`:: The unique identifier for the application (also known as Application Id)
+`Client ID`:: The unique identifier for the application (also known as Application Id)
 
-`client_secret`:: The client/application secret/key
+`Client Secret`:: The client/application secret/key
 
-`subscription_id`:: The unique identifier for the azure subscription
+`Subscription ID`:: The unique identifier for the azure subscription
 
-`tenant_id`:: The unique identifier of the Azure Active Directory instance
+`Tenant ID`:: The unique identifier of the Azure Active Directory instance
 
 
 The azure credentials keys can be used if configured `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, `AZURE_TENANT_ID`, `AZURE_SUBSCRIPTION_ID`
 
-`resource_manager_endpoint` ::
+`Resource Manager Endpoint` ::
 _string_
 Optional, by default the azure public environment will be used, to override, users can provide a specific resource manager endpoint in order to use a different azure environment.
 Ex:
@@ -36,7 +36,7 @@ https://management.microsoftazure.de for azure GermanCloud
 https://management.azure.com for azure PublicCloud
 https://management.usgovcloudapi.net for azure USGovernmentCloud
 
-`active_directory_endpoint` ::
+`Active Directory Endpoint` ::
 _string_
 Optional, by default the associated active directory endpoint to the resource manager endpoint will be used, to override, users can provide a specific active directory endpoint in order to use a different azure environment.
 Ex:
@@ -46,13 +46,26 @@ https://login.chinacloudapi.cn for azure PublicCloud
 https://login.microsoftonline.de for azure USGovernmentCloud
 
 
-This data stream will collect metrics from the container services, these metrics will have a timegrain every 5 minutes,
-so the `period` for `container_service` should be `300s` or multiples of `300s`.
+### Data stream specific configuration notes
+
+`Period`:: (_string_) Reporting interval. Metrics will have a timegrain of 5 minutes, so the `Period` configuration option for `container_service` should have a value of `300s` or multiple of `300s`for relevant results.
+
+`Resource IDs`:: (_[]string_) The fully qualified ID's of the resource, including the resource name and resource type. Has the format /subscriptions/{guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}.
+ Should return a list of resources.
+
+`Resource Groups`:: (_[]string_) This option will return all container services inside the resource group.
+
+If no resource filter is specified, then all container services inside the entire subscription will be considered.
+
+The primary aggregation value will be retrieved for all the metrics contained in the namespaces. The aggregation options are `avg`, `sum`, `min`, `max`, `total`, `count`.
+
+
 
-{{fields "container_service"}}
 
 ## Additional notes about metrics and costs
 
 Costs: Metric queries are charged based on the number of standard API calls. More information on pricing here https://azure.microsoft.com/id-id/pricing/details/monitor/.
 
 Authentication: we are handling authentication on our side (creating/renewing the authentication token), so we advise users to use dedicated credentials for metricbeat only.
+
+{{fields "container_service"}}