custom_resource_provider

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

Overview

Name	custom_resource_provider
Type	Resource
Id	azure.custom_providers.custom_resource_provider

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
actions	array	A list of actions that the custom resource provider implements.
location	string	Resource location. Required.
provisioningState	string	The provisioning state of the resource provider. Known values are: "Accepted", "Deleting", "Running", "Succeeded", and "Failed".
resourceTypes	array	A list of resource types that the custom resource provider implements.
tags	object	Resource tags.
type	string	Resource type.
validations	array	A list of validations to run on the custom resource provider's requests.

list_by_resource_group

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
actions	array	A list of actions that the custom resource provider implements.
location	string	Resource location. Required.
provisioningState	string	The provisioning state of the resource provider. Known values are: "Accepted", "Deleting", "Running", "Succeeded", and "Failed".
resourceTypes	array	A list of resource types that the custom resource provider implements.
tags	object	Resource tags.
type	string	Resource type.
validations	array	A list of validations to run on the custom resource provider's requests.

list_by_subscription

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource name.
actions	array	A list of actions that the custom resource provider implements.
location	string	Resource location. Required.
provisioningState	string	The provisioning state of the resource provider. Known values are: "Accepted", "Deleting", "Running", "Succeeded", and "Failed".
resourceTypes	array	A list of resource types that the custom resource provider implements.
tags	object	Resource tags.
type	string	Resource type.
validations	array	A list of validations to run on the custom resource provider's requests.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_provider_name, subscription_id		Gets the custom resource provider manifest.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all the custom resource providers within a resource group.
list_by_subscription	select	subscription_id		Gets all the custom resource providers within a subscription.
create_or_update	insert	resource_group_name, resource_provider_name, subscription_id, location		Creates or updates the custom resource provider.
update	update	resource_group_name, resource_provider_name, subscription_id		Updates an existing custom resource provider. The only value that can be updated via PATCH currently is the tags.
create_or_update	replace	resource_group_name, resource_provider_name, subscription_id, location		Creates or updates the custom resource provider.
delete	delete	resource_group_name, resource_provider_name, subscription_id		Deletes the custom resource provider.

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
resource_group_name	string	The name of the resource group. Required.
resource_provider_name	string	The name of the resource provider. Required.
subscription_id	string

SELECT examples

get

Gets the custom resource provider manifest.

SELECT
id,
name,
actions,
location,
provisioningState,
resourceTypes,
tags,
type,
validations
FROM azure.custom_providers.custom_resource_provider
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_provider_name = '{{ resource_provider_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets all the custom resource providers within a resource group.

SELECT
id,
name,
actions,
location,
provisioningState,
resourceTypes,
tags,
type,
validations
FROM azure.custom_providers.custom_resource_provider
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets all the custom resource providers within a subscription.

SELECT
id,
name,
actions,
location,
provisioningState,
resourceTypes,
tags,
type,
validations
FROM azure.custom_providers.custom_resource_provider
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the custom resource provider.

INSERT INTO azure.custom_providers.custom_resource_provider (
location,
tags,
properties,
resource_group_name,
resource_provider_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_provider_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: custom_resource_provider
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the custom_resource_provider resource.
  - name: resource_provider_name
    value: "{{ resource_provider_name }}"
    description: Required parameter for the custom_resource_provider resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the custom_resource_provider resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    value:
      actions:
        - name: "{{ name }}"
          endpoint: "{{ endpoint }}"
          routingType: "{{ routingType }}"
      resourceTypes:
        - name: "{{ name }}"
          endpoint: "{{ endpoint }}"
          routingType: "{{ routingType }}"
      validations:
        - validationType: "{{ validationType }}"
          specification: "{{ specification }}"

UPDATE examples

update

Updates an existing custom resource provider. The only value that can be updated via PATCH currently is the tags.

UPDATE azure.custom_providers.custom_resource_provider
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_provider_name = '{{ resource_provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates the custom resource provider.

REPLACE azure.custom_providers.custom_resource_provider
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_provider_name = '{{ resource_provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the custom resource provider.

DELETE FROM azure.custom_providers.custom_resource_provider
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_provider_name = '{{ resource_provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;