EnvironmentCredential 類別

  • 參考

環境變數所設定的認證。

此認證能夠使用用戶端密碼或憑證，或以使用者名稱和密碼的使用者身分驗證為服務主體。 使用下列環境變數，依此順序嘗試設定：

具有秘密的服務主體：

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

  • AZURE_CLIENT_ID：服務主體的用戶端識別碼

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

  • AZURE_AUTHORITY_HOST：Azure Active Directory 端點的授權單位，例如「login.microsoftonline.com」，這是 Azure 公用雲端的授權單位，這是未指定任何值時的預設值。

具有憑證的服務主體：

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

  • AZURE_CLIENT_ID：服務主體的用戶端識別碼

  • AZURE_CLIENT_CERTIFICATE_PATH：PEM 或 PKCS12 憑證檔案的路徑，包括私密金鑰。

  • AZURE_CLIENT_CERTIFICATE_PASSWORD：如果有的話， (憑證檔案的選擇性) 密碼。

  • AZURE_AUTHORITY_HOST：Azure Active Directory 端點的授權單位，例如「login.microsoftonline.com」，這是 Azure 公用雲端的授權單位，這是未指定任何值時的預設值。

具有使用者名稱和密碼的使用者：

  • AZURE_CLIENT_ID：應用程式的用戶端識別碼

  • AZURE_USERNAME：使用者名稱 (通常是電子郵件地址)

  • AZURE_PASSWORD：該使用者的密碼

  • AZURE_TENANT_ID： (服務主體租使用者的選擇性) 識別碼。 也稱為其 'directory' 識別碼。 如果未提供，預設為「組織」租使用者，僅支援 Azure Active Directory 公司或學校帳戶。

  • AZURE_AUTHORITY_HOST：Azure Active Directory 端點的授權單位，例如「login.microsoftonline.com」，這是 Azure 公用雲端的授權單位，這是未指定任何值時的預設值。

繼承
builtins.object
EnvironmentCredential

建構函式

EnvironmentCredential(**kwargs: Any)

範例

建立 EnvironmentCredential。


   from azure.identity import EnvironmentCredential

   credential = EnvironmentCredential()

方法

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
必要

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

claims
str

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

tenant_id
str

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

傳回

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

傳回類型

AccessToken

例外狀況

CredentialUnavailableError

環境變數組態不完整