instances

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

Overview

Name	instances
Type	Resource
Id	azure_extras.dyn365_fraud_protection.instances

Fields

The following fields are returned by SELECT queries:

list_by_resource_group

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
location	string	Location of the DFP resource.
properties	object	Properties of the provision operation request.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Key-value pairs of additional resource provisioning properties.
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
location	string	Location of the DFP resource.
properties	object	Properties of the provision operation request.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Key-value pairs of additional resource provisioning properties.
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
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all the Dedicated instance for the given resource group.
list	select	subscriptionId		Lists all the Dedicated instances for the given subscription.
create	insert	resourceGroupName, instanceName, subscriptionId, data__location		Provisions the specified DFP instance based on the configuration specified in the request.
update	update	resourceGroupName, instanceName, subscriptionId		Updates the current state of the specified DFP instance.
delete	delete	resourceGroupName, instanceName, subscriptionId		Deletes the specified DFP instance.
check_name_availability	exec	location, subscriptionId		Check the name availability in the target location.

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	The name of the DFP instance. It must be at least 3 characters in length, and no more than 63.
location	string	The region name which the operation will lookup into.
resourceGroupName	string	The name of the Azure Resource group of which a given DFP instance is part. This name must be at least 1 character in length, and no more than 90.
subscriptionId	string	A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

list_by_resource_group

Gets all the Dedicated instance for the given resource group.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure_extras.dyn365_fraud_protection.instances
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all the Dedicated instances for the given subscription.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure_extras.dyn365_fraud_protection.instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Provisions the specified DFP instance based on the configuration specified in the request.

INSERT INTO azure_extras.dyn365_fraud_protection.instances (
data__properties,
data__location,
data__tags,
resourceGroupName,
instanceName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ location }}' /* required */,
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ instanceName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: instances
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the instances resource.
    - name: instanceName
      value: string
      description: Required parameter for the instances resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the instances resource.
    - name: properties
      value: object
      description: |
        Properties of the provision operation request.
    - name: location
      value: string
      description: |
        Location of the DFP resource.
    - name: tags
      value: object
      description: |
        Key-value pairs of additional resource provisioning properties.

UPDATE examples

update

Updates the current state of the specified DFP instance.

UPDATE azure_extras.dyn365_fraud_protection.instances
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND instanceName = '{{ instanceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified DFP instance.

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

Lifecycle Methods

check_name_availability

Check the name availability in the target location.

EXEC azure_extras.dyn365_fraud_protection.instances.check_name_availability 
@location='{{ location }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;