monitors

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

Overview

Name	monitors
Type	Resource
Id	azure_isv.workloads.monitors

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.
appLocation	string	The SAP monitor resources will be deployed in the SAP monitoring region. The subnet region should be same as the SAP monitoring region.
errors	object	Defines the SAP monitor errors.
identity	object	[currently not in use] Managed service identity(user assigned identities).
location	string	The geo-location where the resource lives. Required.
logAnalyticsWorkspaceArmId	string	The ARM ID of the Log Analytics Workspace that is used for SAP monitoring.
managedResourceGroupConfiguration	object	Managed resource group configuration.
monitorSubnet	string	The subnet which the SAP monitor will be deployed in.
msiArmId	string	The ARM ID of the MSI used for SAP monitoring.
provisioningState	string	State of provisioning of the SAP monitor. Known values are: "Accepted", "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating".
routingPreference	string	Sets the routing preference of the SAP monitor. By default only RFC1918 traffic is routed to the customer VNET. Known values are: "Default" and "RouteAll".
storageAccountArmId	string	The ARM ID of the Storage account used for SAP monitoring.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zoneRedundancyPreference	string	Sets the preference for zone redundancy on resources created for the SAP monitor. By default resources will be created which do not support zone redundancy.

list_by_resource_group

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.
appLocation	string	The SAP monitor resources will be deployed in the SAP monitoring region. The subnet region should be same as the SAP monitoring region.
errors	object	Defines the SAP monitor errors.
identity	object	[currently not in use] Managed service identity(user assigned identities).
location	string	The geo-location where the resource lives. Required.
logAnalyticsWorkspaceArmId	string	The ARM ID of the Log Analytics Workspace that is used for SAP monitoring.
managedResourceGroupConfiguration	object	Managed resource group configuration.
monitorSubnet	string	The subnet which the SAP monitor will be deployed in.
msiArmId	string	The ARM ID of the MSI used for SAP monitoring.
provisioningState	string	State of provisioning of the SAP monitor. Known values are: "Accepted", "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating".
routingPreference	string	Sets the routing preference of the SAP monitor. By default only RFC1918 traffic is routed to the customer VNET. Known values are: "Default" and "RouteAll".
storageAccountArmId	string	The ARM ID of the Storage account used for SAP monitoring.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zoneRedundancyPreference	string	Sets the preference for zone redundancy on resources created for the SAP monitor. By default resources will be created which do not support zone redundancy.

list

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.
appLocation	string	The SAP monitor resources will be deployed in the SAP monitoring region. The subnet region should be same as the SAP monitoring region.
errors	object	Defines the SAP monitor errors.
identity	object	[currently not in use] Managed service identity(user assigned identities).
location	string	The geo-location where the resource lives. Required.
logAnalyticsWorkspaceArmId	string	The ARM ID of the Log Analytics Workspace that is used for SAP monitoring.
managedResourceGroupConfiguration	object	Managed resource group configuration.
monitorSubnet	string	The subnet which the SAP monitor will be deployed in.
msiArmId	string	The ARM ID of the MSI used for SAP monitoring.
provisioningState	string	State of provisioning of the SAP monitor. Known values are: "Accepted", "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating".
routingPreference	string	Sets the routing preference of the SAP monitor. By default only RFC1918 traffic is routed to the customer VNET. Known values are: "Default" and "RouteAll".
storageAccountArmId	string	The ARM ID of the Storage account used for SAP monitoring.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zoneRedundancyPreference	string	Sets the preference for zone redundancy on resources created for the SAP monitor. By default resources will be created which do not support zone redundancy.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, monitor_name, subscription_id		Gets properties of a SAP monitor. Gets properties of a SAP monitor for the specified subscription, resource group, and resource name.
list_by_resource_group	select	resource_group_name, subscription_id		Gets a list of SAP monitors. Gets a list of SAP monitors in the specified resource group.
list	select	subscription_id		Gets a list of SAP monitors in the specified subscription. Gets a list of SAP monitors in the specified subscription. The operations returns various properties of each SAP monitor.
create	insert	resource_group_name, monitor_name, subscription_id, location		Creates a SAP monitor. Creates a SAP monitor for the specified subscription, resource group, and resource name.
update	update	resource_group_name, monitor_name, subscription_id		Patches the Tags field of a SAP monitor. Patches the Tags field of a SAP monitor for the specified subscription, resource group, and SAP monitor name.
delete	delete	resource_group_name, monitor_name, subscription_id		Deletes a SAP monitor. Deletes a SAP monitor with the specified subscription, resource group, and SAP monitor name.

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
monitor_name	string	Name of the SAP monitor resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets properties of a SAP monitor. Gets properties of a SAP monitor for the specified subscription, resource group, and resource name.

SELECT
id,
name,
appLocation,
errors,
identity,
location,
logAnalyticsWorkspaceArmId,
managedResourceGroupConfiguration,
monitorSubnet,
msiArmId,
provisioningState,
routingPreference,
storageAccountArmId,
systemData,
tags,
type,
zoneRedundancyPreference
FROM azure_isv.workloads.monitors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND monitor_name = '{{ monitor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets a list of SAP monitors. Gets a list of SAP monitors in the specified resource group.

SELECT
id,
name,
appLocation,
errors,
identity,
location,
logAnalyticsWorkspaceArmId,
managedResourceGroupConfiguration,
monitorSubnet,
msiArmId,
provisioningState,
routingPreference,
storageAccountArmId,
systemData,
tags,
type,
zoneRedundancyPreference
FROM azure_isv.workloads.monitors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of SAP monitors in the specified subscription. Gets a list of SAP monitors in the specified subscription. The operations returns various properties of each SAP monitor.

SELECT
id,
name,
appLocation,
errors,
identity,
location,
logAnalyticsWorkspaceArmId,
managedResourceGroupConfiguration,
monitorSubnet,
msiArmId,
provisioningState,
routingPreference,
storageAccountArmId,
systemData,
tags,
type,
zoneRedundancyPreference
FROM azure_isv.workloads.monitors
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a SAP monitor. Creates a SAP monitor for the specified subscription, resource group, and resource name.

INSERT INTO azure_isv.workloads.monitors (
tags,
location,
identity,
properties,
resource_group_name,
monitor_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ monitor_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: monitors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the monitors resource.
  - name: monitor_name
    value: "{{ monitor_name }}"
    description: Required parameter for the monitors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the monitors resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: identity
    description: |
      [currently not in use] Managed service identity(user assigned identities).
    value:
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      appLocation: "{{ appLocation }}"
      routingPreference: "{{ routingPreference }}"
      zoneRedundancyPreference: "{{ zoneRedundancyPreference }}"
      managedResourceGroupConfiguration:
        name: "{{ name }}"
      logAnalyticsWorkspaceArmId: "{{ logAnalyticsWorkspaceArmId }}"
      monitorSubnet: "{{ monitorSubnet }}"

UPDATE examples

update

Patches the Tags field of a SAP monitor. Patches the Tags field of a SAP monitor for the specified subscription, resource group, and SAP monitor name.

UPDATE azure_isv.workloads.monitors
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND monitor_name = '{{ monitor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a SAP monitor. Deletes a SAP monitor with the specified subscription, resource group, and SAP monitor name.

DELETE FROM azure_isv.workloads.monitors
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND monitor_name = '{{ monitor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;