WorkloadIdentityCredential クラス

  • リファレンス

Azure Active Directory ワークロード ID を使用して認証します。

ワークロード ID 認証は、仮想マシン (VM) 上で実行されているアプリケーションが、サービス プリンシパルまたはマネージド ID を必要とせずに他の Azure リソースにアクセスできるようにする Azure の機能です。 ワークロード ID 認証では、アプリケーションは、共有サービス プリンシパルまたはマネージド ID を使用するのではなく、独自の ID を使用して自身を認証します。 ワークロード ID 認証では、Azure によって自動的に作成され、VM に安全に格納されるサービス アカウント資格情報 (SAC) の概念が使用されます。 ワークロード ID 認証を使用することで、各 VM 上の各アプリケーションのサービス プリンシパルまたはマネージド ID を管理およびローテーションする必要がなくなります。 さらに、SAC は Azure によって自動的に作成および管理されるため、機密性の高い資格情報自体の格納とセキュリティ保護について心配する必要はありません。

WorkloadIdentityCredential は、Azure Kubernetes での Azure ワークロード ID 認証をサポートし、Azure Kubernetes 環境で使用できるサービス アカウント資格情報を使用してトークンを取得します。 詳細については、 このワークロード ID の概要 を参照してください。

継承
azure.identity._credentials.client_assertion.ClientAssertionCredential
WorkloadIdentityCredential
azure.identity._credentials.workload_identity.TokenFileMixin
WorkloadIdentityCredential

コンストラクター

WorkloadIdentityCredential(*, tenant_id: str | None = None, client_id: str | None = None, token_file_path: str | None = None, **kwargs: Any)

パラメーター

tenant_id
str

アプリケーションの Azure Active Directory テナントの ID。 "ディレクトリ" ID とも呼ばれます。

client_id
str

Azure AD アプリ登録のクライアント ID。

token_file_path
str

ID を認証する Kubernetes サービス アカウント トークンを含むファイルへのパス。

例

WorkloadIdentityCredential を作成します。


   from azure.identity import WorkloadIdentityCredential

   credential = WorkloadIdentityCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       token_file_path="<token_file_path>",
   )

   # Parameters can be omitted if the following environment variables are set:
   #   - AZURE_TENANT_ID
   #   - AZURE_CLIENT_ID
   #   - AZURE_FEDERATED_TOKEN_FILE
   credential = WorkloadIdentityCredential()

メソッド

close
get_token

スコープのアクセス トークンを要求 します。

このメソッドは、Azure SDK クライアントによって自動的に呼び出されます。

close 

close() -> None

get_token

スコープのアクセス トークンを要求 します。

このメソッドは、Azure SDK クライアントによって自動的に呼び出されます。

get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

パラメーター

scopes
str
必須

アクセス トークンの目的のスコープ。 このメソッドには、少なくとも 1 つのスコープが必要です。 スコープの詳細については、「」を参照してください https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc。

claims
str

承認エラーの後にリソース プロバイダーの要求チャレンジで返される要求など、トークンに必要な追加の要求。

tenant_id
str

トークン要求に含める省略可能なテナント。

enable_cae
bool

は、要求されたトークンに対して継続的アクセス評価 (CAE) を有効にするかどうかを示します。 既定値は False です。

戻り値

目的のスコープを持つアクセス トークン。

の戻り値の型 :

AccessToken

例外

CredentialUnavailableError

資格情報に必要なデータ、状態、またはプラットフォームのサポートがないため、認証を試みることができません

ClientAuthenticationError

認証に失敗しました。 エラーの 属性には message 理由があります。