AzureCliCredentials class

パッケージ:

@azure/ms-rest-nodeauth

Azure CLI を使用してトークンを取得することで、資格情報について説明します。

コンストラクター

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

プロパティ

resource	Azure リソース エンドポイント。 既定では、環境から Azure Resource Manager:AzureCloud が使用されます。 「https://management.azure.com" Azure KeyVault の場合: "https://vault.azure.net" Azure Batch の場合: "https://batch.core.windows.net" Azure Active Directory Graph の場合: "https://graph.windows.net" 他のクラウドのリソースを取得するには: az cloud list
subscriptionInfo	Azure CLI の既定/現在のサブスクリプションに関する情報を提供します。
tokenInfo	Azure CLI の対応するサブスクリプションのアクセス トークンに関する情報を提供します。

メソッド

create(AccessTokenOptions)	JS SDK で Azure cli を使用して Azure と対話するために使用できる資格情報を提供します。 前提条件の azure-cli をインストール。 詳細については、「Azure CLI インストールする」を参照してください。 az login を使用したログインの
getAccessToken(AccessTokenOptions)	既定または指定されたサブスクリプションのアクセス トークンを取得します。
getSubscription(string)	Azure CLI からサブスクリプションを取得します。
getToken()	トークンの有効期限が切れている場合、またはサブスクリプションが変更された場合は、Azure CLI から新しいトークンの取得を試みます。それ以外の場合は、キャッシュされた accessToken が使用されます。
listAllSubscriptions(ListAllSubscriptionOptions)	Azure CLI からすべてのサブスクリプションの一覧を返します。
setDefaultSubscription(string)	指定したサブスクリプションを Azure CLI の既定のサブスクリプションとして設定します。
signRequest(WebResource)	Authentication ヘッダーを使用して要求に署名します。

コンストラクターの詳細

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

new AzureCliCredentials(subscriptionInfo: LinkedSubscription, tokenInfo: CliAccessToken, resource?: string)

パラメーター

subscriptionInfo

LinkedSubscription

tokenInfo

CliAccessToken

resource

string

プロパティの詳細

resource

Azure リソース エンドポイント。

• 既定では、環境から Azure Resource Manager:AzureCloud が使用されます。 「https://management.azure.com"
• Azure KeyVault の場合: "https://vault.azure.net"
• Azure Batch の場合: "https://batch.core.windows.net"
• Azure Active Directory Graph の場合: "https://graph.windows.net"

他のクラウドのリソースを取得するには:

• az cloud list

resource: string

プロパティ値

string

subscriptionInfo

Azure CLI の既定/現在のサブスクリプションに関する情報を提供します。

subscriptionInfo: LinkedSubscription

プロパティ値

LinkedSubscription

tokenInfo

Azure CLI の対応するサブスクリプションのアクセス トークンに関する情報を提供します。

tokenInfo: CliAccessToken

プロパティ値

CliAccessToken

メソッドの詳細

create(AccessTokenOptions)

JS SDK で Azure cli を使用して Azure と対話するために使用できる資格情報を提供します。 前提条件の

• azure-cli をインストール。 詳細については、「Azure CLI インストールする」を参照してください。
• az login を使用したログインの

static function create(options?: AccessTokenOptions): Promise<AzureCliCredentials>

パラメーター

options

AccessTokenOptions

AzureCliCredentials の作成時に指定できる省略可能なパラメーター。

戻り値

Promise<AzureCliCredentials>

getAccessToken(AccessTokenOptions)

既定または指定されたサブスクリプションのアクセス トークンを取得します。

static function getAccessToken(options?: AccessTokenOptions): Promise<CliAccessToken>

パラメーター

options

AccessTokenOptions

アクセス トークンを取得するために指定できる省略可能なパラメーター。

戻り値

Promise<CliAccessToken>

getSubscription(string)

Azure CLI からサブスクリプションを取得します。

static function getSubscription(subscriptionIdOrName?: string): Promise<LinkedSubscription>

パラメーター

subscriptionIdOrName

string

情報が必要なサブスクリプションの名前または ID。

戻り値

Promise<LinkedSubscription>

getToken()

トークンの有効期限が切れている場合、またはサブスクリプションが変更された場合は、Azure CLI から新しいトークンの取得を試みます。それ以外の場合は、キャッシュされた accessToken が使用されます。

function getToken(): Promise<TokenResponse>

戻り値

Promise<TokenResponse>

tokenResponse (tokenType と accessToken は 2 つの重要なプロパティです)。

listAllSubscriptions(ListAllSubscriptionOptions)

Azure CLI からすべてのサブスクリプションの一覧を返します。

static function listAllSubscriptions(options?: ListAllSubscriptionOptions): Promise<LinkedSubscription[]>

パラメーター

options

ListAllSubscriptionOptions

すべてのサブクリプションを一覧表示するときに指定できる省略可能なパラメーター。

戻り値

Promise<LinkedSubscription[]>

setDefaultSubscription(string)

指定したサブスクリプションを Azure CLI の既定のサブスクリプションとして設定します。

static function setDefaultSubscription(subscriptionIdOrName: string): Promise<void>

パラメーター

subscriptionIdOrName

string

既定のサブスクリプションとして設定する必要があるサブサブスクリプションの名前または ID。

戻り値

Promise<void>

signRequest(WebResource)

Authentication ヘッダーを使用して要求に署名します。

function signRequest(webResource: WebResource): Promise<WebResource>

パラメーター

webResource

WebResource

戻り値

Promise<WebResource>