trusted_id_providers

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

Overview

Name	trusted_id_providers
Type	Resource
Id	azure.datalake_store.trusted_id_providers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
idProvider	string	The URL of this trusted identity provider.
type	string	The resource type.

list_by_account

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
idProvider	string	The URL of this trusted identity provider.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, trusted_id_provider_name, subscription_id		Gets the specified Data Lake Store trusted identity provider.
list_by_account	select	resource_group_name, account_name, subscription_id		Lists the Data Lake Store trusted identity providers within the specified Data Lake Store account.
create_or_update	insert	resource_group_name, account_name, trusted_id_provider_name, subscription_id, properties		Creates or updates the specified trusted identity provider. During update, the trusted identity provider with the specified name will be replaced with this new provider.
update	update	resource_group_name, account_name, trusted_id_provider_name, subscription_id		Updates the specified trusted identity provider.
create_or_update	replace	resource_group_name, account_name, trusted_id_provider_name, subscription_id, properties		Creates or updates the specified trusted identity provider. During update, the trusted identity provider with the specified name will be replaced with this new provider.
delete	delete	resource_group_name, account_name, trusted_id_provider_name, subscription_id		Deletes the specified trusted identity provider from the specified Data Lake Store account.

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
account_name	string	The name of the Data Lake Store account. Required.
resource_group_name	string	The name of the Azure resource group. Required.
subscription_id	string
trusted_id_provider_name	string	The name of the trusted identity provider to delete. Required.

SELECT examples

get

Gets the specified Data Lake Store trusted identity provider.

SELECT
id,
name,
idProvider,
type
FROM azure.datalake_store.trusted_id_providers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND trusted_id_provider_name = '{{ trusted_id_provider_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_account

Lists the Data Lake Store trusted identity providers within the specified Data Lake Store account.

SELECT
id,
name,
idProvider,
type
FROM azure.datalake_store.trusted_id_providers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified trusted identity provider. During update, the trusted identity provider with the specified name will be replaced with this new provider.

INSERT INTO azure.datalake_store.trusted_id_providers (
properties,
resource_group_name,
account_name,
trusted_id_provider_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ trusted_id_provider_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: trusted_id_providers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the trusted_id_providers resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the trusted_id_providers resource.
  - name: trusted_id_provider_name
    value: "{{ trusted_id_provider_name }}"
    description: Required parameter for the trusted_id_providers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the trusted_id_providers resource.
  - name: properties
    value:
      idProvider: "{{ idProvider }}"

UPDATE examples

update

Updates the specified trusted identity provider.

UPDATE azure.datalake_store.trusted_id_providers
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND trusted_id_provider_name = '{{ trusted_id_provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

REPLACE examples

create_or_update

Creates or updates the specified trusted identity provider. During update, the trusted identity provider with the specified name will be replaced with this new provider.

REPLACE azure.datalake_store.trusted_id_providers
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND trusted_id_provider_name = '{{ trusted_id_provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes the specified trusted identity provider from the specified Data Lake Store account.

DELETE FROM azure.datalake_store.trusted_id_providers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND trusted_id_provider_name = '{{ trusted_id_provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;