@azure/ms-rest-nodeauth package

tenantIds の配列を構築します。

function buildTenantList(credentials: TokenCredentialsBase, apiVersion?: string): Promise<string[]>

パラメーター

戻り値

tenantIds の配列に解決され、エラーで拒否される Promise。

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

パラメーター

戻り値

ブラウザーにコピーして貼り付け、その上で認証する必要がある URL とコードを提供します。 成功した場合、ユーザーは DeviceTokenCredentials オブジェクトと、該当するすべてのテナントにわたってその userId に関連付けられているサブスクリプションの一覧を取得します。

個人用アカウントを使用する場合は、domain パラメーターの options プロパティを、そのアカウントのテナントの ID に設定する必要があります。 それ以外の場合、結果の資格情報はアカウントのリソースにアクセスできません。

function interactiveLogin(): Promise<DeviceTokenCredentials>

戻り値

コールバックが最後のパラメーターとして渡された場合、void を返します。それ以外の場合は Promise を返します。 コールバックは、結果として得られる DeviceTokenCredentials オブジェクトと、該当するすべてのテナントに関連するサブスクリプションの一覧を使用して呼び出されます。

function interactiveLogin(options: InteractiveLoginOptions): Promise<DeviceTokenCredentials>

パラメーター

戻り値

function interactiveLogin(options: InteractiveLoginOptions, callback: (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)

パラメーター

function interactiveLogin(callback: any)

パラメーター

ブラウザーにコピーして貼り付け、その上で認証する必要がある URL とコードを提供します。 成功した場合、ユーザーは DeviceTokenCredentials オブジェクトと、該当するすべてのテナントにわたってその userId に関連付けられているサブスクリプションの一覧を取得します。

個人用アカウントを使用する場合は、domain パラメーターの options プロパティを、そのアカウントのテナントの ID に設定する必要があります。 それ以外の場合、結果の資格情報はアカウントのリソースにアクセスできません。

function interactiveLoginWithAuthResponse(options?: InteractiveLoginOptions): Promise<AuthResponse<DeviceTokenCredentials>>

パラメーター

戻り値

AuthResponse に解決され、"資格情報" 配列とオプションの "サブスクリプション" 配列が含まれ、エラーで拒否される Promise。

App Service MSI を使用して認証します。

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

戻り値

コールバックが最後のパラメーターとして渡された場合、void を返します。それ以外の場合は Promise を返します。 結果の MSIAppServiceTokenCredentials オブジェクトを使用してコールバックが呼び出されます。

function loginWithAppServiceMSI(options: MSIAppServiceOptions): Promise<MSIAppServiceTokenCredentials>

パラメーター

戻り値

function loginWithAppServiceMSI(options: MSIAppServiceOptions, callback: Callback<MSIAppServiceTokenCredentials>)

パラメーター

function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>)

パラメーター

この方法を使用する前に、https://github.com/Azure/azure-cli/releasesから az cli をインストールしてください。 次に、az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}を実行します。 別のクラウド/環境用に sp を作成する場合は、次を実行してください。

1. az クラウド リスト
2. az cloud set –n <環境の名前>
3. az ad sp create-for-rbac --sdk-auth > auth.json // シークレットを使用して SP を作成する OR
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate (サービス プリンシパルが既に作成されている場合)、サービス プリンシパル情報を使用してログインします。
5. az login --service-principal -u < clientId> -p <clientSecret> -t <tenantId>
6. AZ account Show --SDK-auth > auth.json

認証ファイルで指定されたサービス プリンシパル情報を使用して認証します。 このメソッドは、認証ファイルの subscriptionId を options パラメーターまたは既定の "AZURE_SUBSCRIPTION_ID" でユーザーが指定した環境変数に設定します。

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

戻り値

コールバックが最後のパラメーターとして渡された場合、void を返します。それ以外の場合は Promise を返します。 コールバックは、結果として得られる ApplicationTokenCredentials オブジェクトまたは ApplicationTokenCertificateCredentials オブジェクトと、該当するすべてのテナントにわたって関連付けられているサブスクリプションの一覧を使用して呼び出されます。

function loginWithAuthFile(options: LoginWithAuthFileOptions): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

パラメーター

戻り値

function loginWithAuthFile(options: LoginWithAuthFileOptions, callback: (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

パラメーター

function loginWithAuthFile(callback: any)

パラメーター

この方法を使用する前に、https://github.com/Azure/azure-cli/releasesから az cli をインストールしてください。 次に、az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}を実行します。 別のクラウド/環境用に sp を作成する場合は、次を実行してください。

1. az クラウド リスト
2. az cloud set –n <環境の名前>
3. az ad sp create-for-rbac --sdk-auth > auth.json // シークレットを使用して SP を作成する OR
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate (サービス プリンシパルが既に作成されている場合)、サービス プリンシパル情報を使用してログインします。
5. az login --service-principal -u < clientId> -p <clientSecret> -t <tenantId>
6. AZ account Show --SDK-auth > auth.json

認証ファイルで指定されたサービス プリンシパル情報を使用して認証します。 このメソッドは、認証ファイルの subscriptionId を options パラメーターまたは既定の "AZURE_SUBSCRIPTION_ID" でユーザーが指定した環境変数に設定します。

function loginWithAuthFileWithAuthResponse(options?: LoginWithAuthFileOptions): Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>>

パラメーター

戻り値

AuthResponse に解決され、"資格情報" 配列とオプションの "サブスクリプション" 配列が含まれ、エラーで拒否される Promise。

ApplicationTokenCertificateCredentials オブジェクトと、該当するすべてのテナントにわたって、その servicePrincipalId/clientId に関連付けられているサブスクリプションの一覧を提供します。

個人用アカウントを使用する場合、domain パラメーターには、そのアカウントのテナントの ID を設定する必要があります。 それ以外の場合、結果の資格情報はアカウントのリソースにアクセスできません。

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string): Promise<ApplicationTokenCertificateCredentials>

パラメーター

戻り値

コールバックが最後のパラメーターとして渡された場合、void を返します。それ以外の場合は Promise を返します。 コールバックは、結果として得られる ApplicationTokenCertificateCredentials オブジェクトと、該当するすべてのテナントに関連するサブスクリプションの一覧を使用して呼び出されます。

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, options: AzureTokenCredentialsOptions): Promise<ApplicationTokenCertificateCredentials>

パラメーター

戻り値

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, options: AzureTokenCredentialsOptions, callback: (err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

パラメーター

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, callback: any)

パラメーター

ApplicationTokenCertificateCredentials オブジェクトと、該当するすべてのテナントにわたって、その servicePrincipalId/clientId に関連付けられているサブスクリプションの一覧を提供します。

個人用アカウントを使用する場合、domain パラメーターには、そのアカウントのテナントの ID を設定する必要があります。 それ以外の場合、結果の資格情報はアカウントのリソースにアクセスできません。

function loginWithServicePrincipalCertificateWithAuthResponse(clientId: string, certificateStringOrFilePath: string, domain: string, options?: AzureTokenCredentialsOptions): Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

パラメーター

戻り値

AuthResponse に解決され、"資格情報" 配列とオプションの "サブスクリプション" 配列が含まれ、エラーで拒否される Promise。

ApplicationTokenCredentials オブジェクトと、該当するすべてのテナントにわたって、その servicePrincipalId/clientId に関連付けられているサブスクリプションの一覧を提供します。

個人用アカウントを使用する場合、domain パラメーターには、そのアカウントのテナントの ID を設定する必要があります。 それ以外の場合、結果の資格情報はアカウントのリソースにアクセスできません。

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string): Promise<ApplicationTokenCredentials>

パラメーター

戻り値

コールバックが最後のパラメーターとして渡された場合、void を返します。それ以外の場合は Promise を返します。 コールバックは、結果として得られる ApplicationTokenCredentials オブジェクトと、該当するすべてのテナントに関連するサブスクリプションの一覧を使用して呼び出されます。

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string, options: AzureTokenCredentialsOptions): Promise<ApplicationTokenCredentials>

パラメーター

戻り値

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string, options: AzureTokenCredentialsOptions, callback: (err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void)

パラメーター

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string, callback: any)

パラメーター

ApplicationTokenCredentials オブジェクトと、該当するすべてのテナントにわたって、その servicePrincipalId/clientId に関連付けられているサブスクリプションの一覧を提供します。

個人用アカウントを使用する場合、domain パラメーターには、そのアカウントのテナントの ID を設定する必要があります。 それ以外の場合、結果の資格情報はアカウントのリソースにアクセスできません。

function loginWithServicePrincipalSecretWithAuthResponse(clientId: string, secret: string, domain: string, options?: AzureTokenCredentialsOptions): Promise<AuthResponse<ApplicationTokenCredentials>>

パラメーター

戻り値

AuthResponse に解決され、"資格情報" 配列とオプションの "サブスクリプション" 配列が含まれ、エラーで拒否される Promise。

UserTokenCredentials オブジェクトと、該当するすべてのテナントにわたってその userId に関連付けられているサブスクリプションの一覧を提供します。

この方法は、2FA が有効になっていない組織 ID にのみ適用されます。それ以外の場合は、対話型ログインを使用してください。

個人用アカウントを使用する場合は、domain パラメーターの options プロパティを、そのアカウントのテナントの ID に設定する必要があります。 それ以外の場合、結果の資格情報はアカウントのリソースにアクセスできません。

function loginWithUsernamePassword(username: string, password: string): Promise<UserTokenCredentials>

パラメーター

戻り値

コールバックが最後のパラメーターとして渡された場合、void を返します。それ以外の場合は Promise を返します。 コールバックは、結果として得られる UserTokenCredentials オブジェクトと、該当するすべてのテナントに関連するサブスクリプションの一覧を使用して呼び出されます。

function loginWithUsernamePassword(username: string, password: string, options: LoginWithUsernamePasswordOptions): Promise<UserTokenCredentials>

パラメーター

戻り値

function loginWithUsernamePassword(username: string, password: string, callback: any)

パラメーター

function loginWithUsernamePassword(username: string, password: string, options: LoginWithUsernamePasswordOptions, callback: (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)

パラメーター

UserTokenCredentials オブジェクトと、該当するすべてのテナントにわたってその userId に関連付けられているサブスクリプションの一覧を提供します。 この方法は、2FA が有効になっていない組織 ID にのみ適用されます。それ以外の場合は、対話型ログインを使用してください。

個人用アカウントを使用する場合は、domain パラメーターの options プロパティを、そのアカウントのテナントの ID に設定する必要があります。 それ以外の場合、結果の資格情報はアカウントのリソースにアクセスできません。

function loginWithUsernamePasswordWithAuthResponse(username: string, password: string, options?: LoginWithUsernamePasswordOptions): Promise<AuthResponse<UserTokenCredentials>>

パラメーター

戻り値

credentials と省略可能な subscriptions 配列を含む AuthResponse に解決され、エラーで拒否される Promise。

この方法を使用する前に、https://github.com/Azure/azure-cli/releasesから az cli をインストールしてください。 az cli でプロビジョニングされた Azure 仮想マシンがあり、MSI が有効になっている場合は、この方法を使用して VM から認証トークンを取得できます。

新しい VM を作成するには、MSI を有効にして、次のコマンドを実行してください。az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> 注: 上記のコマンドでは、既定のポート 50342 でホスト上のサービス エンドポイントが有効になります

既にプロビジョニングされている VM で MSI を有効にするには、次のコマンドを実行します。az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

このコマンドの詳細については、az vm --assign-identity -h を実行してください。

Azure 仮想マシンで実行されている ID サービスを使用して認証します。 このメソッドは、VM でホストされている認証サービスに要求を行い、アクセス トークンを取得します。

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

戻り値

コールバックが最後のパラメーターとして渡された場合、void を返します。それ以外の場合は Promise を返します。 結果の MSIVmTokenCredentials オブジェクトを使用してコールバックが呼び出されます。

function loginWithVmMSI(options: MSIVmOptions): Promise<MSIVmTokenCredentials>

パラメーター

戻り値

function loginWithVmMSI(options: MSIVmOptions, callback: Callback<MSIVmTokenCredentials>)

パラメーター

function loginWithVmMSI(callback: Callback<MSIVmTokenCredentials>)

パラメーター

AuthConstants: { AAD_COMMON_TENANT: string, AZURE_AUTH_LOCATION: string, DEFAULT_ADAL_CLIENT_ID: string, DEFAULT_LANGUAGE: string, RESOURCE_MANAGER_ENDPOINT: string, SDK_INTERNAL_ERROR: string }

型