sap_landscape_monitor

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

Overview

Name	sap_landscape_monitor
Type	Resource
Id	azure_isv.workloads.sap_landscape_monitor

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.
grouping	object	Gets or sets the SID groupings by landscape and Environment.
provisioningState	string	State of provisioning of the SAP monitor. Known values are: "Accepted", "Created", "Failed", "Succeeded", and "Canceled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topMetricsThresholds	array	Gets or sets the list Top Metric Thresholds for SAP Landscape Monitor Dashboard.
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, monitor_name, subscription_id		Gets configuration values for Single Pane Of Glass for SAP monitor. Gets configuration values for Single Pane Of Glass for SAP monitor for the specified subscription, resource group, and resource name.
create	insert	resource_group_name, monitor_name, subscription_id		Creates a SAP Landscape Monitor Dashboard. Creates a SAP Landscape Monitor Dashboard for the specified subscription, resource group, and resource name.
update	update	resource_group_name, monitor_name, subscription_id		Patches the SAP Landscape Monitor Dashboard. Patches the SAP Landscape Monitor Dashboard for the specified subscription, resource group, and SAP monitor name.
delete	delete	resource_group_name, monitor_name, subscription_id		Deletes a SAP Landscape Monitor Dashboard. Deletes a SAP Landscape Monitor Dashboard with the specified subscription, resource group, and SAP monitor name.
list_raw	exec	resource_group_name, monitor_name, subscription_id		Gets configuration values for Single Pane Of Glass for SAP monitor. Gets configuration values for Single Pane Of Glass for SAP monitor for the specified subscription, resource group, and resource 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 configuration values for Single Pane Of Glass for SAP monitor. Gets configuration values for Single Pane Of Glass for SAP monitor for the specified subscription, resource group, and resource name.

SELECT
id,
name,
grouping,
provisioningState,
systemData,
topMetricsThresholds,
type
FROM azure_isv.workloads.sap_landscape_monitor
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND monitor_name = '{{ monitor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a SAP Landscape Monitor Dashboard. Creates a SAP Landscape Monitor Dashboard for the specified subscription, resource group, and resource name.

INSERT INTO azure_isv.workloads.sap_landscape_monitor (
properties,
resource_group_name,
monitor_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ monitor_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sap_landscape_monitor
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sap_landscape_monitor resource.
  - name: monitor_name
    value: "{{ monitor_name }}"
    description: Required parameter for the sap_landscape_monitor resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sap_landscape_monitor resource.
  - name: properties
    value:
      grouping:
        landscape:
          - name: "{{ name }}"
            topSid: "{{ topSid }}"
        sapApplication:
          - name: "{{ name }}"
            topSid: "{{ topSid }}"
      topMetricsThresholds:
        - name: "{{ name }}"
          green: {{ green }}
          yellow: {{ yellow }}
          red: {{ red }}

UPDATE examples

update

Patches the SAP Landscape Monitor Dashboard. Patches the SAP Landscape Monitor Dashboard for the specified subscription, resource group, and SAP monitor name.

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

DELETE examples

delete

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

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

Lifecycle Methods

list_raw

Gets configuration values for Single Pane Of Glass for SAP monitor. Gets configuration values for Single Pane Of Glass for SAP monitor for the specified subscription, resource group, and resource name.

EXEC azure_isv.workloads.sap_landscape_monitor.list_raw 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;