sap_monitors

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

Overview

Name	sap_monitors
Type	Resource
Id	azure_isv.hanaonazure.sap_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.
enableCustomerAnalytics	boolean	The value indicating whether to send analytics to Microsoft.
location	string	The geo-location where the resource lives. Required.
logAnalyticsWorkspaceArmId	string	The ARM ID of the Log Analytics Workspace that is used for monitoring.
logAnalyticsWorkspaceId	string	The workspace ID of the log analytics workspace to be used for monitoring.
logAnalyticsWorkspaceSharedKey	string	The shared key of the log analytics workspace that is used for monitoring.
managedResourceGroupName	string	The name of the resource group the SAP Monitor resources get deployed into.
monitorSubnet	string	The subnet which the SAP monitor will be deployed in.
provisioningState	string	State of provisioning of the HanaInstance. Known values are: "Accepted", "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating". (Accepted, Creating, Updating, Failed, Succeeded, Deleting, Migrating)
sapMonitorCollectorVersion	string	The version of the payload running in the Collector VM.
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".

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.
enableCustomerAnalytics	boolean	The value indicating whether to send analytics to Microsoft.
location	string	The geo-location where the resource lives. Required.
logAnalyticsWorkspaceArmId	string	The ARM ID of the Log Analytics Workspace that is used for monitoring.
logAnalyticsWorkspaceId	string	The workspace ID of the log analytics workspace to be used for monitoring.
logAnalyticsWorkspaceSharedKey	string	The shared key of the log analytics workspace that is used for monitoring.
managedResourceGroupName	string	The name of the resource group the SAP Monitor resources get deployed into.
monitorSubnet	string	The subnet which the SAP monitor will be deployed in.
provisioningState	string	State of provisioning of the HanaInstance. Known values are: "Accepted", "Creating", "Updating", "Failed", "Succeeded", "Deleting", and "Migrating". (Accepted, Creating, Updating, Failed, Succeeded, Deleting, Migrating)
sapMonitorCollectorVersion	string	The version of the payload running in the Collector VM.
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, sap_monitor_name, subscription_id		Gets properties of a SAP monitor. The product Microsoft.Workloads/sapMonitors (AMS Classic) is officially retired as of May 31, 2023.
list	select	subscription_id		Gets a list of SAP monitors in the specified subscription. The product Microsoft.Workloads/sapMonitors (AMS Classic) is officially retired as of May 31, 2023.
create	insert	resource_group_name, sap_monitor_name, subscription_id, location		Creates a SAP monitor. The product Microsoft.Workloads/sapMonitors (AMS Classic) is officially retired as of May 31, 2023.
update	update	resource_group_name, sap_monitor_name, subscription_id		Patches the Tags field of a SAP monitor. The product Microsoft.Workloads/sapMonitors (AMS Classic) is officially retired as of May 31, 2023.
delete	delete	resource_group_name, sap_monitor_name, subscription_id		Deletes a SAP monitor. The product Microsoft.Workloads/sapMonitors (AMS Classic) is officially retired as of May 31, 2023.

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

SELECT examples

get

Gets properties of a SAP monitor. The product Microsoft.Workloads/sapMonitors (AMS Classic) is officially retired as of May 31, 2023.

SELECT
id,
name,
enableCustomerAnalytics,
location,
logAnalyticsWorkspaceArmId,
logAnalyticsWorkspaceId,
logAnalyticsWorkspaceSharedKey,
managedResourceGroupName,
monitorSubnet,
provisioningState,
sapMonitorCollectorVersion,
systemData,
tags,
type
FROM azure_isv.hanaonazure.sap_monitors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND sap_monitor_name = '{{ sap_monitor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of SAP monitors in the specified subscription. The product Microsoft.Workloads/sapMonitors (AMS Classic) is officially retired as of May 31, 2023.

SELECT
id,
name,
enableCustomerAnalytics,
location,
logAnalyticsWorkspaceArmId,
logAnalyticsWorkspaceId,
logAnalyticsWorkspaceSharedKey,
managedResourceGroupName,
monitorSubnet,
provisioningState,
sapMonitorCollectorVersion,
systemData,
tags,
type
FROM azure_isv.hanaonazure.sap_monitors
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a SAP monitor. The product Microsoft.Workloads/sapMonitors (AMS Classic) is officially retired as of May 31, 2023.

INSERT INTO azure_isv.hanaonazure.sap_monitors (
tags,
location,
properties,
resource_group_name,
sap_monitor_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ sap_monitor_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: sap_monitors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sap_monitors resource.
  - name: sap_monitor_name
    value: "{{ sap_monitor_name }}"
    description: Required parameter for the sap_monitors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sap_monitors resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      SAP monitor properties.
    value:
      provisioningState: "{{ provisioningState }}"
      managedResourceGroupName: "{{ managedResourceGroupName }}"
      logAnalyticsWorkspaceArmId: "{{ logAnalyticsWorkspaceArmId }}"
      enableCustomerAnalytics: {{ enableCustomerAnalytics }}
      logAnalyticsWorkspaceId: "{{ logAnalyticsWorkspaceId }}"
      logAnalyticsWorkspaceSharedKey: "{{ logAnalyticsWorkspaceSharedKey }}"
      sapMonitorCollectorVersion: "{{ sapMonitorCollectorVersion }}"
      monitorSubnet: "{{ monitorSubnet }}"

UPDATE examples

update

Patches the Tags field of a SAP monitor. The product Microsoft.Workloads/sapMonitors (AMS Classic) is officially retired as of May 31, 2023.

UPDATE azure_isv.hanaonazure.sap_monitors
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND sap_monitor_name = '{{ sap_monitor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a SAP monitor. The product Microsoft.Workloads/sapMonitors (AMS Classic) is officially retired as of May 31, 2023.

DELETE FROM azure_isv.hanaonazure.sap_monitors
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND sap_monitor_name = '{{ sap_monitor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;