instances

Creates, updates, deletes, gets or lists an instances resource.

Overview

Name	instances
Type	Resource
Id	azure.scom.instances

Fields

The following fields are returned by SELECT queries:

get

Operation completed successfully.

Name	Datatype	Description
identity	object	The Azure Active Directory identity of the SCOM instance
location	string	The geo-location where the resource lives
properties	object	The properties of a SCOM instance resource
tags	object	Resource tags.

list_by_resource_group

Operation completed successfully.

Name	Datatype	Description
identity	object	The Azure Active Directory identity of the SCOM instance
location	string	The geo-location where the resource lives
properties	object	The properties of a SCOM instance resource
tags	object	Resource tags.

list_by_subscription

Operation completed successfully.

Name	Datatype	Description
identity	object	The Azure Active Directory identity of the SCOM instance
location	string	The geo-location where the resource lives
properties	object	The properties of a SCOM instance resource
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, instanceName		Get SCOM managed instance details
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all SCOM managed instances in a resource group
list_by_subscription	select	subscriptionId		Lists all SCOM managed instances in a subscription
create_or_update	insert	subscriptionId, resourceGroupName, instanceName	validationMode	Create or update SCOM managed instance
update	update	subscriptionId, resourceGroupName, instanceName		Patch SCOM managed instance
delete	delete	subscriptionId, resourceGroupName, instanceName		Delete a SCOM managed instance
scale	exec	subscriptionId, resourceGroupName, instanceName		Scaling SCOM managed instance.
patch_servers	exec	subscriptionId, resourceGroupName, instanceName		Update SCOM servers with latest scom software.
link_log_analytics	exec	subscriptionId, resourceGroupName, instanceName		Link Log Analytics workspace for SCOM monitoring instance
unlink_log_analytics	exec	subscriptionId, resourceGroupName, instanceName		Unlink Log Analytics workspace for SCOM monitoring instance

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
instanceName	string	Name of the SCOM managed instance.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
validationMode	boolean	Validation mode for the SCOM managed instance

SELECT examples

get

Get SCOM managed instance details

SELECT
identity,
location,
properties,
tags
FROM azure.scom.instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND instanceName = '{{ instanceName }}' -- required
;

list_by_resource_group

Lists all SCOM managed instances in a resource group

SELECT
identity,
location,
properties,
tags
FROM azure.scom.instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Lists all SCOM managed instances in a subscription

SELECT
identity,
location,
properties,
tags
FROM azure.scom.instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update SCOM managed instance

INSERT INTO azure.scom.instances (
data__tags,
data__location,
data__properties,
data__identity,
subscriptionId,
resourceGroupName,
instanceName,
validationMode
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ instanceName }}',
'{{ validationMode }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: instances
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the instances resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the instances resource.
    - name: instanceName
      value: string
      description: Required parameter for the instances resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        The properties of a SCOM instance resource
    - name: identity
      value: object
      description: |
        The Azure Active Directory identity of the SCOM instance
    - name: validationMode
      value: boolean
      description: Validation mode for the SCOM managed instance

UPDATE examples

update

Patch SCOM managed instance

UPDATE azure.scom.instances
SET 
data__identity = '{{ identity }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND instanceName = '{{ instanceName }}' --required
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Delete a SCOM managed instance

DELETE FROM azure.scom.instances
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND instanceName = '{{ instanceName }}' --required
;

Lifecycle Methods

scale

Scaling SCOM managed instance.

EXEC azure.scom.instances.scale 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@instanceName='{{ instanceName }}' --required 
@@json=
'{
"serverCount": {{ serverCount }}
}'
;

patch_servers

Update SCOM servers with latest scom software.

EXEC azure.scom.instances.patch_servers 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@instanceName='{{ instanceName }}' --required
;

link_log_analytics

Link Log Analytics workspace for SCOM monitoring instance

EXEC azure.scom.instances.link_log_analytics 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@instanceName='{{ instanceName }}' --required 
@@json=
'{
"workspaceId": "{{ workspaceId }}", 
"dataTypes": "{{ dataTypes }}", 
"importData": {{ importData }}
}'
;

unlink_log_analytics

Unlink Log Analytics workspace for SCOM monitoring instance

EXEC azure.scom.instances.unlink_log_analytics 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@instanceName='{{ instanceName }}' --required
;