AzureCliCredentials class

Pakiet:

@azure/ms-rest-nodeauth

Opisuje poświadczenia przez pobieranie tokenu za pośrednictwem interfejsu wiersza polecenia platformy Azure.

Konstruktory

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

Właściwości

resource	Punkty końcowe zasobów platformy Azure. Domyślnie usługa Azure Resource Manager ze środowiska: AzureCloud. "https://management.azure.com" W przypadku usługi Azure KeyVault: "https://vault.azure.net" W przypadku usługi Azure Batch: "https://batch.core.windows.net" W przypadku usługi Azure Active Directory Graph: "https://graph.windows.net" Aby uzyskać zasób dla innych chmur: az cloud list
subscriptionInfo	Zawiera informacje o domyślnej/bieżącej subskrypcji dla interfejsu wiersza polecenia platformy Azure.
tokenInfo	Zawiera informacje o tokenie dostępu dla odpowiedniej subskrypcji dla interfejsu wiersza polecenia platformy Azure.

Metody

create(AccessTokenOptions)	Udostępnia poświadczenia, które mogą być używane przez zestaw JS SDK do interakcji z platformą Azure za pośrednictwem interfejsu wiersza polecenia platformy Azure. wymagania wstępne zainstalować interfejsu wiersza polecenia platformy Azure. Aby uzyskać więcej informacji, zobacz Instalowanie interfejsu wiersza polecenia platformy Azure logowanie za pośrednictwem az login
getAccessToken(AccessTokenOptions)	Pobiera token dostępu dla domyślnej lub określonej subskrypcji.
getSubscription(string)	Pobiera subskrypcję z interfejsu wiersza polecenia platformy Azure.
getToken()	Próbuje uzyskać nowy token z interfejsu wiersza polecenia platformy Azure, jeśli token wygasł lub subskrypcja uległa zmianie, inne używa buforowanego tokenu accessToken.
listAllSubscriptions(ListAllSubscriptionOptions)	Zwraca listę wszystkich subskrypcji z interfejsu wiersza polecenia platformy Azure.
setDefaultSubscription(string)	Ustawia określoną subskrypcję jako domyślną subskrypcję interfejsu wiersza polecenia platformy Azure.
signRequest(WebResource)	Podpisuje żądanie z nagłówkiem Authentication (Uwierzytelnianie).

Szczegóły konstruktora

AzureCliCredentials(LinkedSubscription, CliAccessToken, string)

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

Parametry

subscriptionInfo

LinkedSubscription

tokenInfo

CliAccessToken

resource

string

Szczegóły właściwości

resource

Punkty końcowe zasobów platformy Azure.

• Domyślnie usługa Azure Resource Manager ze środowiska: AzureCloud. "https://management.azure.com"
• W przypadku usługi Azure KeyVault: "https://vault.azure.net"
• W przypadku usługi Azure Batch: "https://batch.core.windows.net"
• W przypadku usługi Azure Active Directory Graph: "https://graph.windows.net"

Aby uzyskać zasób dla innych chmur:

• az cloud list

resource: string

Wartość właściwości

string

subscriptionInfo

Zawiera informacje o domyślnej/bieżącej subskrypcji dla interfejsu wiersza polecenia platformy Azure.

subscriptionInfo: LinkedSubscription

Wartość właściwości

LinkedSubscription

tokenInfo

Zawiera informacje o tokenie dostępu dla odpowiedniej subskrypcji dla interfejsu wiersza polecenia platformy Azure.

tokenInfo: CliAccessToken

Wartość właściwości

CliAccessToken

Szczegóły metody

create(AccessTokenOptions)

Udostępnia poświadczenia, które mogą być używane przez zestaw JS SDK do interakcji z platformą Azure za pośrednictwem interfejsu wiersza polecenia platformy Azure. wymagania wstępne

• zainstalować interfejsu wiersza polecenia platformy Azure. Aby uzyskać więcej informacji, zobacz Instalowanie interfejsu wiersza polecenia platformy Azure
• logowanie za pośrednictwem az login

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

Parametry

options

AccessTokenOptions

Opcjonalne parametry, które można podać podczas tworzenia obiektów AzureCliCredentials.

Zwraca

Promise<AzureCliCredentials>

getAccessToken(AccessTokenOptions)

Pobiera token dostępu dla domyślnej lub określonej subskrypcji.

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

Parametry

options

AccessTokenOptions

Opcjonalne parametry, które można podać w celu uzyskania tokenu dostępu.

Zwraca

Promise<CliAccessToken>

getSubscription(string)

Pobiera subskrypcję z interfejsu wiersza polecenia platformy Azure.

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

Parametry

subscriptionIdOrName

string

Nazwa lub identyfikator subskrypcji, dla której wymagane są informacje.

Zwraca

Promise<LinkedSubscription>

getToken()

Próbuje uzyskać nowy token z interfejsu wiersza polecenia platformy Azure, jeśli token wygasł lub subskrypcja uległa zmianie, inne używa buforowanego tokenu accessToken.

function getToken(): Promise<TokenResponse>

Zwraca

Promise<TokenResponse>

TokenResponse (tokenType i accessToken są dwiema ważnymi właściwościami).

listAllSubscriptions(ListAllSubscriptionOptions)

Zwraca listę wszystkich subskrypcji z interfejsu wiersza polecenia platformy Azure.

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

Parametry

options

ListAllSubscriptionOptions

Opcjonalne parametry, które można podać podczas wyświetlania listy wszystkich podkraków.

Zwraca

Promise<LinkedSubscription[]>

setDefaultSubscription(string)

Ustawia określoną subskrypcję jako domyślną subskrypcję interfejsu wiersza polecenia platformy Azure.

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

Parametry

subscriptionIdOrName

string

Nazwa lub identyfikator subsciption, które należy ustawić jako domyślną subskrypcję.

Zwraca

Promise<void>

signRequest(WebResource)

Podpisuje żądanie z nagłówkiem Authentication (Uwierzytelnianie).

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

Parametry

webResource

WebResource

Zwraca

Promise<WebResource>