usage_metrics

Creates, updates, deletes, gets or lists a usage_metrics resource.

Overview

Name	usage_metrics
Type	Resource
Id	azure_extras.iot_firmware_defense.usage_metrics

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
monthlyFirmwareUploadCount	integer	The number of firmware analysis jobs that have been submitted in the current month. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "Extracting", and "Analyzing". (Succeeded, Failed, Canceled, Pending, Extracting, Analyzing)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalFirmwareCount	integer	The total number of firmwares that are in the workspace. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
monthlyFirmwareUploadCount	integer	The number of firmware analysis jobs that have been submitted in the current month. Required.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Pending", "Extracting", and "Analyzing". (Succeeded, Failed, Canceled, Pending, Extracting, Analyzing)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
totalFirmwareCount	integer	The total number of firmwares that are in the workspace. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, name, subscription_id		Gets monthly usage information for a workspace.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		Lists monthly usage information for a workspace.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string	The Firmware analysis summary name describing the type of summary. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the firmware analysis workspace. Required.

SELECT examples

get

Gets monthly usage information for a workspace.

SELECT
id,
name,
monthlyFirmwareUploadCount,
provisioningState,
systemData,
totalFirmwareCount,
type
FROM azure_extras.iot_firmware_defense.usage_metrics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

Lists monthly usage information for a workspace.

SELECT
id,
name,
monthlyFirmwareUploadCount,
provisioningState,
systemData,
totalFirmwareCount,
type
FROM azure_extras.iot_firmware_defense.usage_metrics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;