TrustedIdProvidersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

DataLakeStoreAccountManagementClient's

<xref:trusted_id_providers> attribute.

Inheritance
builtins.object
TrustedIdProvidersOperations

Constructor

TrustedIdProvidersOperations(*args, **kwargs)

Methods

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.

delete

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

get

Gets the specified Data Lake Store trusted identity provider.

list_by_account

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

update

Updates the specified trusted identity provider.

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.

create_or_update(resource_group_name: str, account_name: str, trusted_id_provider_name: str, parameters: _models.CreateOrUpdateTrustedIdProviderParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TrustedIdProvider

Parameters

Name Description
resource_group_name
Required
str

The name of the Azure resource group. Required.

account_name
Required
str

The name of the Data Lake Store account. Required.

trusted_id_provider_name
Required
str

The name of the trusted identity provider. This is used for differentiation of providers in the account. Required.

parameters
Required

Parameters supplied to create or replace the trusted identity provider. Is either a CreateOrUpdateTrustedIdProviderParameters type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.

cls

A custom type or function that will be passed the direct response

Returns

Type Description

TrustedIdProvider or the result of cls(response)

Exceptions

Type Description

delete

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

delete(resource_group_name: str, account_name: str, trusted_id_provider_name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the Azure resource group. Required.

account_name
Required
str

The name of the Data Lake Store account. Required.

trusted_id_provider_name
Required
str

The name of the trusted identity provider to delete. Required.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

Returns

Type Description

None or the result of cls(response)

Exceptions

Type Description

get

Gets the specified Data Lake Store trusted identity provider.

get(resource_group_name: str, account_name: str, trusted_id_provider_name: str, **kwargs: Any) -> TrustedIdProvider

Parameters

Name Description
resource_group_name
Required
str

The name of the Azure resource group. Required.

account_name
Required
str

The name of the Data Lake Store account. Required.

trusted_id_provider_name
Required
str

The name of the trusted identity provider to retrieve. Required.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

Returns

Type Description

TrustedIdProvider or the result of cls(response)

Exceptions

Type Description

list_by_account

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

list_by_account(resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable[TrustedIdProvider]

Parameters

Name Description
resource_group_name
Required
str

The name of the Azure resource group. Required.

account_name
Required
str

The name of the Data Lake Store account. Required.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

Returns

Type Description

An iterator like instance of either TrustedIdProvider or the result of cls(response)

Exceptions

Type Description

update

Updates the specified trusted identity provider.

update(resource_group_name: str, account_name: str, trusted_id_provider_name: str, parameters: _models.UpdateTrustedIdProviderParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TrustedIdProvider

Parameters

Name Description
resource_group_name
Required
str

The name of the Azure resource group. Required.

account_name
Required
str

The name of the Data Lake Store account. Required.

trusted_id_provider_name
Required
str

The name of the trusted identity provider. This is used for differentiation of providers in the account. Required.

parameters
Required

Parameters supplied to update the trusted identity provider. Is either a UpdateTrustedIdProviderParameters type or a IO type. Default value is None.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.

cls

A custom type or function that will be passed the direct response

Returns

Type Description

TrustedIdProvider or the result of cls(response)

Exceptions

Type Description

Attributes

models

models = <module 'azure.mgmt.datalake.store.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\datalake\\store\\models\\__init__.py'>