custom_resource_providers

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

Overview

Name	custom_resource_providers
Type	Resource
Id	azure.custom_providers.custom_resource_providers

Fields

The following fields are returned by SELECT queries:

get

OK response definition with the existing resource.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	The manifest for the custom resource provider
tags	object	Resource tags
type	string	Resource type

list_by_resource_group

OK - Returns an array of custom resource providers.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	The manifest for the custom resource provider
tags	object	Resource tags
type	string	Resource type

list_by_subscription

OK - Returns an array of custom resource providers.

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	The manifest for the custom resource provider
tags	object	Resource tags
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceProviderName		Gets the custom resource provider manifest.
list_by_resource_group	select	subscriptionId, resourceGroupName		Gets all the custom resource providers within a resource group.
list_by_subscription	select	subscriptionId		Gets all the custom resource providers within a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, resourceProviderName		Creates or updates the custom resource provider.
update	update	subscriptionId, resourceGroupName, resourceProviderName		Updates an existing custom resource provider. The only value that can be updated via PATCH currently is the tags.
delete	delete	subscriptionId, resourceGroupName, resourceProviderName		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
resourceGroupName	string	The name of the resource group.
resourceProviderName	string	The name of the resource provider.
subscriptionId	string	The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)

SELECT examples

get

Gets the custom resource provider manifest.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.custom_providers.custom_resource_providers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceProviderName = '{{ resourceProviderName }}' -- required
;

list_by_resource_group

Gets all the custom resource providers within a resource group.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.custom_providers.custom_resource_providers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Gets all the custom resource providers within a subscription.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.custom_providers.custom_resource_providers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates the custom resource provider.

INSERT INTO azure.custom_providers.custom_resource_providers (
data__properties,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
resourceProviderName
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceProviderName }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: custom_resource_providers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the custom_resource_providers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the custom_resource_providers resource.
    - name: resourceProviderName
      value: string
      description: Required parameter for the custom_resource_providers resource.
    - name: properties
      value: object
      description: |
        The manifest for the custom resource provider
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

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_providers
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceProviderName = '{{ resourceProviderName }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the custom resource provider.

DELETE FROM azure.custom_providers.custom_resource_providers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceProviderName = '{{ resourceProviderName }}' --required
;