providers

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

Overview

Name	providers
Type	Resource
Id	azure.resource.providers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The provider ID.
namespace	string	The namespace of the resource provider.
providerAuthorizationConsentState	string	The provider authorization consent state. Known values are: "NotSpecified", "Required", "NotRequired", and "Consented". (NotSpecified, Required, NotRequired, Consented)
registrationPolicy	string	The registration policy of the resource provider.
registrationState	string	The registration state of the resource provider.
resourceTypes	array	The collection of provider resource types.

list

Name	Datatype	Description
id	string	The provider ID.
namespace	string	The namespace of the resource provider.
providerAuthorizationConsentState	string	The provider authorization consent state. Known values are: "NotSpecified", "Required", "NotRequired", and "Consented". (NotSpecified, Required, NotRequired, Consented)
registrationPolicy	string	The registration policy of the resource provider.
registrationState	string	The registration state of the resource provider.
resourceTypes	array	The collection of provider resource types.

get_at_tenant_scope

Name	Datatype	Description
id	string	The provider ID.
namespace	string	The namespace of the resource provider.
providerAuthorizationConsentState	string	The provider authorization consent state. Known values are: "NotSpecified", "Required", "NotRequired", and "Consented". (NotSpecified, Required, NotRequired, Consented)
registrationPolicy	string	The registration policy of the resource provider.
registrationState	string	The registration state of the resource provider.
resourceTypes	array	The collection of provider resource types.

list_at_tenant_scope

Name	Datatype	Description
id	string	The provider ID.
namespace	string	The namespace of the resource provider.
providerAuthorizationConsentState	string	The provider authorization consent state. Known values are: "NotSpecified", "Required", "NotRequired", and "Consented". (NotSpecified, Required, NotRequired, Consented)
registrationPolicy	string	The registration policy of the resource provider.
registrationState	string	The registration state of the resource provider.
resourceTypes	array	The collection of provider resource types.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_provider_namespace, subscription_id	$expand	Gets the specified resource provider.
list	select	subscription_id	$expand	Gets all resource providers for a subscription.
get_at_tenant_scope	select	resource_provider_namespace	$expand	Gets the specified resource provider at the tenant level.
list_at_tenant_scope	select		$expand	Gets all resource providers for the tenant.
unregister	exec	resource_provider_namespace, subscription_id		Unregisters a subscription from a resource provider.
register_at_management_group_scope	exec	resource_provider_namespace, group_id		Registers a management group with a resource provider. Use this operation to register a resource provider with resource types that can be deployed at the management group scope. It does not recursively register subscriptions within the management group. Instead, you must register subscriptions individually.
provider_permissions	exec	resource_provider_namespace, subscription_id		Get the provider permissions.
register	exec	resource_provider_namespace, subscription_id		Registers a subscription with a 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
group_id	string	Required.
resource_provider_namespace	string	The namespace of the resource provider to register. Required.
subscription_id	string
$expand	string	The properties to include in the results. Default value is None.

SELECT examples

get

Gets the specified resource provider.

SELECT
id,
namespace,
providerAuthorizationConsentState,
registrationPolicy,
registrationState,
resourceTypes
FROM azure.resource.providers
WHERE resource_provider_namespace = '{{ resource_provider_namespace }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all resource providers for a subscription.

SELECT
id,
namespace,
providerAuthorizationConsentState,
registrationPolicy,
registrationState,
resourceTypes
FROM azure.resource.providers
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

get_at_tenant_scope

Gets the specified resource provider at the tenant level.

SELECT
id,
namespace,
providerAuthorizationConsentState,
registrationPolicy,
registrationState,
resourceTypes
FROM azure.resource.providers
WHERE resource_provider_namespace = '{{ resource_provider_namespace }}' -- required
AND $expand = '{{ $expand }}'
;

list_at_tenant_scope

Gets all resource providers for the tenant.

SELECT
id,
namespace,
providerAuthorizationConsentState,
registrationPolicy,
registrationState,
resourceTypes
FROM azure.resource.providers
WHERE $expand = '{{ $expand }}'
;

Lifecycle Methods

unregister

Unregisters a subscription from a resource provider.

EXEC azure.resource.providers.unregister 
@resource_provider_namespace='{{ resource_provider_namespace }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

register_at_management_group_scope

Registers a management group with a resource provider. Use this operation to register a resource provider with resource types that can be deployed at the management group scope. It does not recursively register subscriptions within the management group. Instead, you must register subscriptions individually.

EXEC azure.resource.providers.register_at_management_group_scope 
@resource_provider_namespace='{{ resource_provider_namespace }}' --required, 
@group_id='{{ group_id }}' --required
;

provider_permissions

Get the provider permissions.

EXEC azure.resource.providers.provider_permissions 
@resource_provider_namespace='{{ resource_provider_namespace }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

register

Registers a subscription with a resource provider.

EXEC azure.resource.providers.register 
@resource_provider_namespace='{{ resource_provider_namespace }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"thirdPartyProviderConsent": "{{ thirdPartyProviderConsent }}"
}'
;