instances

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

Overview

Name	instances
Type	Resource
Id	azure.scom.instances

Fields

vw_instances

Name	Datatype	Description
azure_hybrid_benefit	text	field from the properties object
database_instance	text	field from the properties object
domain_controller	text	field from the properties object
domain_user_credentials	text	field from the properties object
gmsa_details	text	field from the properties object
identity	text	Azure Active Directory identity configuration for a resource.
instanceName	text	field from the properties object
location	text	The geo-location where the resource lives
log_analytics_properties	text	field from the properties object
management_endpoints	text	field from the properties object
operations_status	text	field from the properties object
product_version	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
vnet_subnet_id	text	field from the properties object

instances

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	instanceName, resourceGroupName, subscriptionId	Get SCOM managed instance details
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	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	instanceName, resourceGroupName, subscriptionId	Create or update SCOM managed instance
delete	DELETE	instanceName, resourceGroupName, subscriptionId	Delete a SCOM managed instance
update	UPDATE	instanceName, resourceGroupName, subscriptionId	Patch SCOM managed instance
link_log_analytics	EXEC	instanceName, resourceGroupName, subscriptionId	Link Log Analytics workspace for SCOM monitoring instance
patch_servers	EXEC	instanceName, resourceGroupName, subscriptionId	Update SCOM servers with latest scom software.
scale	EXEC	instanceName, resourceGroupName, subscriptionId	Scaling SCOM managed instance.
unlink_log_analytics	EXEC	instanceName, resourceGroupName, subscriptionId	Unlink Log Analytics workspace for SCOM monitoring instance

SELECT examples

Lists all SCOM managed instances in a subscription

vw_instances

SELECT
azure_hybrid_benefit,
database_instance,
domain_controller,
domain_user_credentials,
gmsa_details,
identity,
instanceName,
location,
log_analytics_properties,
management_endpoints,
operations_status,
product_version,
provisioning_state,
resourceGroupName,
subscriptionId,
tags,
vnet_subnet_id
FROM azure.scom.vw_instances
WHERE subscriptionId = '{{ subscriptionId }}';

instances

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

INSERT example

Use the following StackQL query and manifest file to create a new instances resource.

All Properties

/*+ create */
INSERT INTO azure.scom.instances (
instanceName,
resourceGroupName,
subscriptionId,
tags,
location,
properties,
identity
)
SELECT 
'{{ instanceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ identity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: properties
      value:
        - name: productVersion
          value: string
        - name: vNetSubnetId
          value: string
        - name: managementEndpoints
          value:
            - - name: serverName
                value: string
              - name: vmResId
                value: string
              - name: fqdn
                value: string
              - name: serverRoles
                value: string
              - name: healthState
                value: string
        - name: databaseInstance
          value:
            - name: databaseInstanceId
              value: string
            - name: databaseFqdn
              value: string
            - name: dwDatabaseName
              value: string
            - name: operationalDatabaseId
              value: string
            - name: dwDatabaseId
              value: string
        - name: domainController
          value:
            - name: domainName
              value: string
            - name: dnsServer
              value: string
            - name: ouPath
              value: string
        - name: domainUserCredentials
          value:
            - name: keyVaultUrl
              value: string
            - name: userNameSecret
              value: string
            - name: passwordSecret
              value: string
        - name: gmsaDetails
          value:
            - name: loadBalancerIP
              value: string
            - name: gmsaAccount
              value: string
            - name: managementServerGroupName
              value: string
            - name: dnsName
              value: string
        - name: azureHybridBenefit
          value:
            - name: scomLicenseType
              value: []
        - name: provisioningState
          value: string
        - name: logAnalyticsProperties
          value:
            - name: workspaceId
              value: string
            - name: dataTypes
              value:
                - string
            - name: importData
              value: boolean
        - name: operationsStatus
          value:
            - - name: operationName
                value: string
              - name: operationState
                value: string
              - name: id
                value: string
    - name: identity
      value:
        - name: type
          value: string
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: userAssignedIdentities
          value: object

UPDATE example

Updates a instances resource.

/*+ update */
UPDATE azure.scom.instances
SET 
identity = '{{ identity }}',
tags = '{{ tags }}'
WHERE 
instanceName = '{{ instanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified instances resource.

/*+ delete */
DELETE FROM azure.scom.instances
WHERE instanceName = '{{ instanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';