@azure/ms-rest-nodeauth package

Создает массив идентификаторов клиента.

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

Параметры

Возвращаемое значение

Обещание, разрешающее массив идентификаторов клиента и отклоняющее ошибку.

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

Параметры

Возвращаемое значение

Предоставляет URL-адрес и код, который необходимо скопировать и вставить в браузере и пройти проверку подлинности. В случае успешного выполнения пользователь получит объект DeviceTokenCredentials и список подписок, связанных с этим идентификатором пользователя во всех применимых клиентах.

При использовании личных учетных записей свойство domain в параметре options необходимо задать идентификатор клиента для этой учетной записи. В противном случае полученные учетные данные не смогут получить доступ к ресурсам учетной записи.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Возвращаемое значение

Если обратный вызов был передан в качестве последнего параметра, он возвращает void else возвращает обещание. Обратный вызов вызывается с результирующий объект 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 и список подписок, связанных с этим идентификатором пользователя во всех применимых клиентах.

При использовании личных учетных записей свойство domain в параметре options необходимо задать идентификатор клиента для этой учетной записи. В противном случае полученные учетные данные не смогут получить доступ к ресурсам учетной записи.

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

Параметры

Возвращаемое значение

Обещание, которое разрешается в AuthResponse, которое содержит "учетные данные" и необязательный массив "подписки" и отклоняет ошибку.

Проверка подлинности с помощью MSI службы приложений.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Возвращаемое значение

Если обратный вызов был передан в качестве последнего параметра, он возвращает void else возвращает обещание. Обратный вызов вызывается с результирующий объект MSIAppServiceTokenCredentials.

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

Параметры

Возвращаемое значение

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

Параметры

function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>)

Параметры

Прежде чем использовать этот метод, установите az cli из https://github.com/Azure/azure-cli/releases. Затем выполните az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Если вы хотите создать sp для другого облака или среды, выполните следующую команду:

1. AZ Cloud List
2. az cloud set –n <name of environment>
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp с помощью секретного ИЛИ
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate If the service principal is already create then login with service principal info:
5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
6. AZ account show --SDK-auth > auth.json

Выполняет проверку подлинности с помощью сведений субъекта-службы, предоставленных в файле проверки подлинности. Этот метод задает идентификатор подписки из файла проверки подлинности для указанной пользователем переменной среды в параметре параметров или по умолчанию "AZURE_SUBSCRIPTION_ID".

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Возвращаемое значение

Если обратный вызов был передан в качестве последнего параметра, он возвращает void else возвращает обещание. Обратный вызов вызывается с полученным объектом 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)

Параметры

Прежде чем использовать этот метод, установите az cli из https://github.com/Azure/azure-cli/releases. Затем выполните az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Если вы хотите создать sp для другого облака или среды, выполните следующую команду:

1. AZ Cloud List
2. az cloud set –n <name of environment>
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp с помощью секретного ИЛИ
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate If the service principal is already create then login with service principal info:
5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
6. AZ account show --SDK-auth > auth.json

Выполняет проверку подлинности с помощью сведений субъекта-службы, предоставленных в файле проверки подлинности. Этот метод задает идентификатор подписки из файла проверки подлинности для указанной пользователем переменной среды в параметре параметров или по умолчанию "AZURE_SUBSCRIPTION_ID".

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

Параметры

Возвращаемое значение

Обещание, которое разрешается в AuthResponse, которое содержит "учетные данные" и необязательный массив "подписки" и отклоняет ошибку.

Предоставляет объект ApplicationTokenCertificateCredentials и список подписок, связанных с этой службойPrincipalId/clientId во всех применимых клиентах.

При использовании личных учетных записей для этой учетной записи необходимо задать параметр domain идентификатор клиента. В противном случае полученные учетные данные не смогут получить доступ к ресурсам учетной записи.

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

Параметры

Возвращаемое значение

Если обратный вызов был передан в качестве последнего параметра, он возвращает void else возвращает обещание. Обратный вызов вызывается с результирующий объект 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 и список подписок, связанных с этой службойPrincipalId/clientId во всех применимых клиентах.

При использовании личных учетных записей для этой учетной записи необходимо задать параметр domain идентификатор клиента. В противном случае полученные учетные данные не смогут получить доступ к ресурсам учетной записи.

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

Параметры

Возвращаемое значение

Обещание, которое разрешается в AuthResponse, которое содержит "учетные данные" и необязательный массив "подписки" и отклоняет ошибку.

Предоставляет объект ApplicationTokenCredentials и список подписок, связанных с этой службойPrincipalId/clientId во всех применимых клиентах.

При использовании личных учетных записей для этой учетной записи необходимо задать параметр domain идентификатор клиента. В противном случае полученные учетные данные не смогут получить доступ к ресурсам учетной записи.

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

Параметры

Возвращаемое значение

Если обратный вызов был передан в качестве последнего параметра, он возвращает void else возвращает обещание. Обратный вызов вызывается с результирующий объект 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 и список подписок, связанных с этой службойPrincipalId/clientId во всех применимых клиентах.

При использовании личных учетных записей для этой учетной записи необходимо задать параметр domain идентификатор клиента. В противном случае полученные учетные данные не смогут получить доступ к ресурсам учетной записи.

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

Параметры

Возвращаемое значение

Обещание, которое разрешается в AuthResponse, которое содержит "учетные данные" и необязательный массив "подписки" и отклоняет ошибку.

Предоставляет объект UserTokenCredentials и список подписок, связанных с этим идентификатором пользователя во всех применимых клиентах.

Этот метод применим только для идентификаторов организации, не включенных в 2FA, в противном случае используйте интерактивное имя входа.

При использовании личных учетных записей свойство domain в параметре options необходимо задать идентификатор клиента для этой учетной записи. В противном случае полученные учетные данные не смогут получить доступ к ресурсам учетной записи.

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

Параметры

Возвращаемое значение

Если обратный вызов был передан в качестве последнего параметра, он возвращает void else возвращает обещание. Обратный вызов вызывается с результирующий объект 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 и список подписок, связанных с этим идентификатором пользователя во всех применимых клиентах. Этот метод применим только для идентификаторов организации, не включенных в 2FA, в противном случае используйте интерактивное имя входа.

При использовании личных учетных записей свойство domain в параметре options необходимо задать идентификатор клиента для этой учетной записи. В противном случае полученные учетные данные не смогут получить доступ к ресурсам учетной записи.

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

Параметры

Возвращаемое значение

Обещание, которое разрешается в AuthResponse, которое содержит credentials и необязательный массив subscriptions и отклоняет ошибку.

Прежде чем использовать этот метод, установите az cli из https://github.com/Azure/azure-cli/releases. Если у вас есть виртуальная машина Azure, подготовленная с помощью az cli и включена MSI, можно использовать этот метод для получения маркеров проверки подлинности с виртуальной машины.

Чтобы создать новую виртуальную машину, включите MSI, выполните следующую команду: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Примечание. Приведенная выше команда включает конечную точку службы на узле с портом по умолчанию 50342

Чтобы включить MSI на уже подготовленной виртуальной машине, выполните следующую команду: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

Чтобы узнать больше об этой команде, выполните команду az vm --assign-identity -h

Выполняет проверку подлинности с помощью службы удостоверений, работающей на виртуальной машине Azure. Этот метод выполняет запрос к службе проверки подлинности, размещенной на виртуальной машине, и возвращает маркер доступа.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Возвращаемое значение

Если обратный вызов был передан в качестве последнего параметра, он возвращает void else возвращает обещание. Обратный вызов вызывается с результирующий объект 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 }

Тип