Azure

obstore.auth.azure.DEFAULT_SCOPES module-attribute

DEFAULT_SCOPES = ('https://storage.azure.com/.default',)

Default scopes used for Azure credential providers.

obstore.auth.azure.AzureCredentialProvider

A CredentialProvider for AzureStore that uses azure.identity.

This credential provider uses azure-identity, and will error if this cannot be imported.

Example:

from obstore.auth.azure import AzureCredentialProvider
from obstore.store import AzureStore

credential_provider = AzureCredentialProvider(credential=...)
store = AzureStore("container", credential_provider=credential_provider)

__init__

__init__(
    credential: AuthorizationCodeCredential
    | AzureCliCredential
    | AzureDeveloperCliCredential
    | AzurePipelinesCredential
    | AzurePowerShellCredential
    | CertificateCredential
    | ChainedTokenCredential
    | ClientAssertionCredential
    | ClientSecretCredential
    | DefaultAzureCredential
    | DeviceCodeCredential
    | EnvironmentCredential
    | InteractiveBrowserCredential
    | ManagedIdentityCredential
    | OnBehalfOfCredential
    | SharedTokenCacheCredential
    | UsernamePasswordCredential
    | VisualStudioCodeCredential
    | WorkloadIdentityCredential
    | None = None,
    scopes: Iterable[str] = DEFAULT_SCOPES,
    tenant_id: str | None = None,
) -> None

Create a new AzureCredentialProvider.

Parameters:

• credential (AuthorizationCodeCredential | AzureCliCredential | AzureDeveloperCliCredential | AzurePipelinesCredential | AzurePowerShellCredential | CertificateCredential | ChainedTokenCredential | ClientAssertionCredential | ClientSecretCredential | DefaultAzureCredential | DeviceCodeCredential | EnvironmentCredential | InteractiveBrowserCredential | ManagedIdentityCredential | OnBehalfOfCredential | SharedTokenCacheCredential | UsernamePasswordCredential | VisualStudioCodeCredential | WorkloadIdentityCredential | None, default: None ) –

  Credential to use for this provider. Defaults to None, in which case azure.identity.DefaultAzureCredential will be called to find default credentials.

• scopes (Iterable[str], default: DEFAULT_SCOPES ) –

  Scopes required by the access token.

• tenant_id (str | None, default: None ) –

  Optionally specify the Azure Tenant ID which will be passed to the credential's get_token method.

__call__

__call__() -> AzureCredential

Fetch the credential.

obstore.auth.azure.AzureAsyncCredentialProvider

An async CredentialProvider for AzureStore that uses azure.identity.

This credential provider uses azure-identity and aiohttp, and will error if these cannot be imported.

Example:

import asyncio
import obstore
from obstore.auth.azure import AzureAsyncCredentialProvider
from obstore.store import AzureStore

credential_provider = AzureAsyncCredentialProvider(credential=...)
store = AzureStore("container", credential_provider=credential_provider)

async def fetch_blobs():
    blobs = await obstore.list(store).collect_async()
    print(blobs)

asyncio.run(fetch_blobs())

__init__

__init__(
    credential: AuthorizationCodeCredential
    | AzureCliCredential
    | AzureDeveloperCliCredential
    | AzurePipelinesCredential
    | AzurePowerShellCredential
    | CertificateCredential
    | ChainedTokenCredential
    | ClientAssertionCredential
    | ClientSecretCredential
    | DefaultAzureCredential
    | EnvironmentCredential
    | ManagedIdentityCredential
    | OnBehalfOfCredential
    | SharedTokenCacheCredential
    | VisualStudioCodeCredential
    | WorkloadIdentityCredential
    | None = None,
    scopes: Iterable[str] = DEFAULT_SCOPES,
    tenant_id: str | None = None,
) -> None

Create a new AzureAsyncCredentialProvider.

Parameters:

• credential (AuthorizationCodeCredential | AzureCliCredential | AzureDeveloperCliCredential | AzurePipelinesCredential | AzurePowerShellCredential | CertificateCredential | ChainedTokenCredential | ClientAssertionCredential | ClientSecretCredential | DefaultAzureCredential | EnvironmentCredential | ManagedIdentityCredential | OnBehalfOfCredential | SharedTokenCacheCredential | VisualStudioCodeCredential | WorkloadIdentityCredential | None, default: None ) –

  Credential to use for this provider. Defaults to None, in which case azure.identity.aio.DefaultAzureCredential will be called to find default credentials.

• scopes (Iterable[str], default: DEFAULT_SCOPES ) –

  Scopes required by the access token.

• tenant_id (str | None, default: None ) –

  Optionally specify the Azure Tenant ID which will be passed to the credential's get_token method.

__call__ async

__call__() -> AzureCredential

Fetch the credential.