AzureDeveloperCliCredential 類別

  • 參考

從Azure Developer CLI要求權杖來進行驗證。

Azure Developer CLI是命令列介面工具，可讓開發人員在 Azure 中建立、管理及部署資源。 其建置在 Azure CLI 之上，並提供 Azure 開發人員特有的其他功能。 它可讓使用者以使用者和/或服務主體身分向 Azure Active Directory 進行驗證， (Azure AD) 。 AzureDeveloperCliCredential 會在開發環境中進行驗證，並代表Azure Developer CLI中登入的使用者或服務主體取得權杖。 它會作為Azure Developer CLI登入的使用者或服務主體，並在下方執行 Azure CLI 命令，以向 Azure Active Directory 驗證應用程式。

若要使用此認證，開發人員必須使用下列其中一個命令，在本機Azure Developer CLI進行驗證：

  • 在 Azure Developer CLI 中執行 「azd auth login」，以使用者身分以互動方式進行驗證。

  • 執行 「azd auth login –client-id 'client_id' –client-secret 'client_secret' –tenant-id 'tenant_id'」 來驗證為服務主體。

您可能需要在特定時段後重複此程式，視組織中的重新整理權杖有效性而定。 一般而言，重新整理權杖有效期間是數周到幾個月。 AzureDeveloperCliCredential 會提示您再次登入。

繼承
builtins.object
AzureDeveloperCliCredential

建構函式

AzureDeveloperCliCredential(*, tenant_id: str = '', additionally_allowed_tenants: List[str] | None = None, process_timeout: int = 10)

參數

tenant_id
str

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

additionally_allowed_tenants
List[str]

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

process_timeout
int

等候Azure Developer CLI程式回應的秒數。 預設值為 10 秒。

範例

建立 AzureDeveloperCliCredential。


   from azure.identity import AzureDeveloperCliCredential

   credential = AzureDeveloperCliCredential()

方法

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

認證無法叫用Azure Developer CLI。

ClientAuthenticationError

已叫用認證Azure Developer CLI但未收到存取權杖。