managed_gateways

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

Overview

Name	managed_gateways
Type	Resource
Id	azure.scom.managed_gateways

Fields

The following fields are returned by SELECT queries:

get

Managed gateway retrieved successfully.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	The properties of a gateway resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	subscriptionId, resourceGroupName, instanceName, managedGatewayName		Retrieve the details of the gateway resource.
create_or_update	insert	subscriptionId, resourceGroupName, instanceName, managedGatewayName		Create or update a gateway resource.
delete	delete	subscriptionId, resourceGroupName, instanceName, managedGatewayName		Remove a gateway resource.

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.
managedGatewayName	string	The gateway resource name.
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.

SELECT examples

get

Retrieve the details of the gateway resource.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.scom.managed_gateways
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND instanceName = '{{ instanceName }}' -- required
AND managedGatewayName = '{{ managedGatewayName }}' -- required
;

INSERT examples

create_or_update

Create or update a gateway resource.

INSERT INTO azure.scom.managed_gateways (
subscriptionId,
resourceGroupName,
instanceName,
managedGatewayName
)
SELECT 
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ instanceName }}',
'{{ managedGatewayName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_gateways
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the managed_gateways resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the managed_gateways resource.
    - name: instanceName
      value: string
      description: Required parameter for the managed_gateways resource.
    - name: managedGatewayName
      value: string
      description: Required parameter for the managed_gateways resource.

DELETE examples

delete

Remove a gateway resource.

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