trusted_id_providers

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

Overview

Name	trusted_id_providers
Type	Resource
Id	azure.data_lake_store.trusted_id_providers

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved details of the specified trusted identity provider.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
properties	object	The trusted identity provider properties.
type	string	The resource type.

list_by_account

Successfully retrieved the list of trusted identity providers.

Name	Datatype	Description
id	string	The resource identifier.
name	string	The resource name.
properties	object	The trusted identity provider properties.
type	string	The resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, trustedIdProviderName		Gets the specified Data Lake Store trusted identity provider.
list_by_account	select	subscriptionId, resourceGroupName, accountName		Lists the Data Lake Store trusted identity providers within the specified Data Lake Store account.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, trustedIdProviderName, data__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	subscriptionId, resourceGroupName, accountName, trustedIdProviderName		Updates the specified trusted identity provider.
delete	delete	subscriptionId, resourceGroupName, accountName, trustedIdProviderName		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
accountName	string	The name of the Data Lake Store account.
resourceGroupName	string	The name of the Azure resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
trustedIdProviderName	string	The name of the trusted identity provider to delete.

SELECT examples

get

Gets the specified Data Lake Store trusted identity provider.

SELECT
id,
name,
properties,
type
FROM azure.data_lake_store.trusted_id_providers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND trustedIdProviderName = '{{ trustedIdProviderName }}' -- required
;

list_by_account

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

SELECT
id,
name,
properties,
type
FROM azure.data_lake_store.trusted_id_providers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- 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.data_lake_store.trusted_id_providers (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
trustedIdProviderName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ trustedIdProviderName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: trusted_id_providers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the trusted_id_providers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the trusted_id_providers resource.
    - name: accountName
      value: string
      description: Required parameter for the trusted_id_providers resource.
    - name: trustedIdProviderName
      value: string
      description: Required parameter for the trusted_id_providers resource.
    - name: properties
      value: object
      description: |
        The trusted identity provider properties to use when creating a new trusted identity provider.

UPDATE examples

update

Updates the specified trusted identity provider.

UPDATE azure.data_lake_store.trusted_id_providers
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND trustedIdProviderName = '{{ trustedIdProviderName }}' --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.data_lake_store.trusted_id_providers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND trustedIdProviderName = '{{ trustedIdProviderName }}' --required
;