ClientSecretCredential 類別

  • 參考

使用用戶端密碼以服務主體身分驗證。

繼承
azure.identity.aio._internal.AsyncContextManager
ClientSecretCredential
azure.identity.aio._internal.get_token_mixin.GetTokenMixin
ClientSecretCredential

建構函式

ClientSecretCredential(tenant_id: str, client_id: str, client_secret: str, **kwargs: Any)

參數

tenant_id
str
必要

服務主體租使用者的識別碼。 也稱為其 'directory' 識別碼。

client_id
str
必要

服務主體的用戶端識別碼

client_secret
str
必要

其中一個服務主體的用戶端密碼

authority
str

Azure Active Directory 端點的授權單位，例如「login.microsoftonline.com」，這是 Azure 公用雲端 (的授權單位，這是預設) 。 AzureAuthorityHosts 定義其他雲端的授權單位。

cache_persistence_options
TokenCachePersistenceOptions

永續性權杖快取的組態。 如果未指定，認證將會快取記憶體中的權杖。

additionally_allowed_tenants
List[str]

除了認證可能取得權杖的指定「tenant_id」之外，指定租使用者。 新增萬用字元值 「*」，以允許認證取得應用程式可存取之任何租使用者的權杖。

範例

建立 ClientSecretCredential。


   from azure.identity.aio import ClientSecretCredential

   credential = ClientSecretCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       client_secret="<client_secret>",
   )

方法

close

關閉認證的傳輸會話。
get_token

要求 範圍的存取權杖。

Azure SDK 用戶端會自動呼叫此方法。

close

關閉認證的傳輸會話。

async close() -> None

get_token

要求 範圍的存取權杖。

Azure SDK 用戶端會自動呼叫此方法。

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

參數

scopes
str
必要

存取權杖所需的範圍。 這個方法至少需要一個範圍。 如需範圍的詳細資訊，請參閱 https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc 。

claims
str

權杖中所需的其他宣告，例如在授權失敗之後，在資源提供者的宣告挑戰中傳回的其他宣告。

tenant_id
str

要包含在權杖要求中的選擇性租使用者。

enable_cae
bool

指出是否為要求的權杖啟用持續存取評估 (CAE) 。 預設為 False。

傳回

具有所需範圍的存取權杖。

傳回類型

AccessToken

例外狀況

CredentialUnavailableError

認證無法嘗試驗證，因為它缺少必要的資料、狀態或平臺支援

ClientAuthenticationError

驗證失敗。 錯誤的 message 屬性會提供原因。