| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448 |
- import * as adal from "adal-node";
- import { Environment } from "@azure/ms-rest-azure-env";
- import { TokenCredentialsBase } from "./credentials/tokenCredentialsBase";
- import { ApplicationTokenCredentials } from "./credentials/applicationTokenCredentials";
- import { ApplicationTokenCertificateCredentials } from "./credentials/applicationTokenCertificateCredentials";
- import { DeviceTokenCredentials } from "./credentials/deviceTokenCredentials";
- import { UserTokenCredentials } from "./credentials/userTokenCredentials";
- import { TokenAudience } from "./util/authConstants";
- import { LinkedSubscription } from "./subscriptionManagement/subscriptionUtils";
- import { MSIVmTokenCredentials, MSIVmOptions } from "./credentials/msiVmTokenCredentials";
- import { MSIAppServiceTokenCredentials, MSIAppServiceOptions } from "./credentials/msiAppServiceTokenCredentials";
- /**
- * @interface AzureTokenCredentialsOptions - Describes optional parameters for serviceprincipal/secret authentication.
- */
- export interface AzureTokenCredentialsOptions {
- /**
- * @property {TokenAudience} [tokenAudience] - The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
- * If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
- */
- tokenAudience?: TokenAudience;
- /**
- * @property {AzureEnvironment} [environment] - The Azure environment to authenticate with.
- */
- environment?: Environment;
- /**
- * @property {TokenCache} [tokenCache] - The token cache. Default value is MemoryCache from adal.
- */
- tokenCache?: adal.TokenCache;
- }
- /**
- * @interface LoginWithUsernamePasswordOptions - Describes optional parameters for username/password authentication.
- */
- export interface LoginWithUsernamePasswordOptions extends AzureTokenCredentialsOptions {
- /**
- * @property {string} [clientId] - The active directory application client id.
- * See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
- * for an example.
- */
- clientId?: string;
- /**
- * @property {string} [domain] - The domain or tenant id containing this application. Default value is "common".
- */
- domain?: string;
- }
- /**
- * @interface InteractiveLoginOptions - Describes optional parameters for interactive authentication.
- */
- export interface InteractiveLoginOptions extends LoginWithUsernamePasswordOptions {
- /**
- * @property {object|function} [userCodeResponseLogger] A logger that logs the user code response message required for interactive login. When
- * this option is specified the usercode response message will not be logged to console.
- */
- userCodeResponseLogger?: any;
- /**
- * @property {string} [language] The language code specifying how the message should be localized to. Default value "en-us".
- */
- language?: string;
- }
- /**
- * @interface AuthResponse - Describes the authentication response.
- */
- export interface AuthResponse {
- /**
- * @property {TokenCredentialsBase} credentials - The credentials object.
- */
- credentials: TokenCredentialsBase;
- /**
- * @property {Array<LinkedSubscription>} [subscriptions] List of associated subscriptions.
- */
- subscriptions?: LinkedSubscription[];
- }
- /**
- * @interface LoginWithAuthFileOptions - Describes optional parameters for login withAuthFile.
- */
- export interface LoginWithAuthFileOptions {
- /**
- * @property {string} [filePath] - Absolute file path to the auth file. If not provided
- * then please set the environment variable AZURE_AUTH_LOCATION.
- */
- filePath?: string;
- /**
- * @property {string} [subscriptionEnvVariableName] - The subscriptionId environment variable
- * name. Default is "AZURE_SUBSCRIPTION_ID".
- */
- subscriptionEnvVariableName?: string;
- }
- /**
- * Generic callback type definition.
- *
- * @property {Error} error - The error occurred if any, while executing the request; otherwise undefined
- * @property {TResult} result - Result when call was successful.
- */
- export declare type Callback<TResult> = (error?: Error, result?: TResult) => void;
- /**
- * Provides a UserTokenCredentials object and the list of subscriptions associated with that userId across all the applicable tenants.
- * This method is applicable only for organizational ids that are not 2FA enabled otherwise please use interactive login.
- *
- * @param {string} username The user name for the Organization Id account.
- * @param {string} password The password for the Organization Id account.
- * @param {object} [options] Object representing optional parameters.
- * @param {string} [options.clientId] The active directory application client id.
- * See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
- * for an example.
- * @param {string} [options.tokenAudience] The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
- * If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
- * @param {string} [options.domain] The domain or tenant id containing this application. Default value "common".
- * @param {Environment} [options.environment] The azure environment to authenticate with.
- * @param {object} [options.tokenCache] The token cache. Default value is the MemoryCache object from adal.
- *
- * @returns {Promise<AuthResponse>} A Promise that resolves to AuthResponse that contains "credentials" and optional "subscriptions" array and rejects with an Error.
- */
- export declare function withUsernamePasswordWithAuthResponse(username: string, password: string, options?: LoginWithUsernamePasswordOptions): Promise<AuthResponse>;
- /**
- * Provides an ApplicationTokenCredentials object and the list of subscriptions associated with that servicePrinicpalId/clientId across all the applicable tenants.
- *
- * @param {string} clientId The active directory application client id also known as the SPN (ServicePrincipal Name).
- * See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
- * for an example.
- * @param {string} secret The application secret for the service principal.
- * @param {string} domain The domain or tenant id containing this application.
- * @param {object} [options] Object representing optional parameters.
- * @param {string} [options.tokenAudience] The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
- * If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
- * @param {Environment} [options.environment] The azure environment to authenticate with.
- * @param {object} [options.tokenCache] The token cache. Default value is the MemoryCache object from adal.
- *
- * @returns {Promise<AuthResponse>} A Promise that resolves to AuthResponse that contains "credentials" and optional "subscriptions" array and rejects with an Error.
- */
- export declare function withServicePrincipalSecretWithAuthResponse(clientId: string, secret: string, domain: string, options?: AzureTokenCredentialsOptions): Promise<AuthResponse>;
- /**
- * Provides an ApplicationTokenCertificateCredentials object and the list of subscriptions associated with that servicePrinicpalId/clientId across all the applicable tenants.
- *
- * @param {string} clientId The active directory application client id also known as the SPN (ServicePrincipal Name).
- * See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
- * for an example.
- * @param {string} certificateStringOrFilePath A PEM encoded certificate and private key OR an absolute filepath to the .pem file containing that information. For example:
- * - CertificateString: "-----BEGIN PRIVATE KEY-----\n<xxxxx>\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n<yyyyy>\n-----END CERTIFICATE-----\n"
- * - CertificateFilePath: **Absolute** file path of the .pem file.
- * @param {string} domain The domain or tenant id containing this application.
- * @param {object} [options] Object representing optional parameters.
- * @param {string} [options.tokenAudience] The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
- * If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
- * @param {Environment} [options.environment] The azure environment to authenticate with.
- * @param {object} [options.tokenCache] The token cache. Default value is the MemoryCache object from adal.
- *
- * @returns {Promise<AuthResponse>} A Promise that resolves to AuthResponse that contains "credentials" and optional "subscriptions" array and rejects with an Error.
- */
- export declare function withServicePrincipalCertificateWithAuthResponse(clientId: string, certificateStringOrFilePath: string, domain: string, options?: AzureTokenCredentialsOptions): Promise<AuthResponse>;
- /**
- * Before using this method please install az cli from https://github.com/Azure/azure-cli/releases. Then execute `az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}`.
- * If you want to create the sp for a different cloud/environment then please execute:
- * 1. az cloud list
- * 2. az cloud set –n <name of the environment>
- * 3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret
- * **OR**
- * 3. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate
- * If the service principal is already created then login with service principal info:
- * 4. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
- * 5. az account show --sdk-auth > auth.json
- *
- * Authenticates using the service principal information provided in the auth file. This method will set
- * the subscriptionId from the auth file to the user provided environment variable in the options
- * parameter or the default "AZURE_SUBSCRIPTION_ID".
- *
- * @param {object} [options] - Optional parameters
- * @param {string} [options.filePath] - Absolute file path to the auth file. If not provided
- * then please set the environment variable AZURE_AUTH_LOCATION.
- * @param {string} [options.subscriptionEnvVariableName] - The subscriptionId environment variable
- * name. Default is "AZURE_SUBSCRIPTION_ID".
- * @param {function} [optionalCallback] The optional callback.
- *
- * @returns {Promise<AuthResponse>} A Promise that resolves to AuthResponse that contains "credentials" and optional "subscriptions" array and rejects with an Error.
- */
- export declare function withAuthFileWithAuthResponse(options?: LoginWithAuthFileOptions): Promise<AuthResponse>;
- /**
- * Provides a url and code that needs to be copy and pasted in a browser and authenticated over there. If successful, the user will get a
- * DeviceTokenCredentials object and the list of subscriptions associated with that userId across all the applicable tenants.
- *
- * @param {object} [options] Object representing optional parameters.
- *
- * @param {string} [options.clientId] The active directory application client id.
- * See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
- * for an example.
- *
- * @param {string} [options.tokenAudience] The audience for which the token is requested. Valid value is "graph".If tokenAudience is provided
- * then domain should also be provided its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
- *
- * @param {string} [options.domain] The domain or tenant id containing this application. Default value is "common".
- *
- * @param {Environment} [options.environment] The azure environment to authenticate with. Default environment is "Public Azure".
- *
- * @param {object} [options.tokenCache] The token cache. Default value is the MemoryCache object from adal.
- *
- * @param {object} [options.language] The language code specifying how the message should be localized to. Default value "en-us".
- *
- * @param {object|function} [options.userCodeResponseLogger] A logger that logs the user code response message required for interactive login. When
- * this option is specified the usercode response message will not be logged to console.
- *
- * @param {function} [optionalCallback] The optional callback.
- *
- * @returns {Promise<AuthResponse>} A Promise that resolves to AuthResponse that contains "credentials" and optional "subscriptions" array and rejects with an Error.
- */
- export declare function withInteractiveWithAuthResponse(options?: InteractiveLoginOptions): Promise<AuthResponse>;
- /**
- * Before using this method please install az cli from https://github.com/Azure/azure-cli/releases. Then execute `az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}`.
- * If you want to create the sp for a different cloud/environment then please execute:
- * 1. az cloud list
- * 2. az cloud set –n <name of the environment>
- * 3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret
- * **OR**
- * 3. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate
- * If the service principal is already created then login with service principal info:
- * 4. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
- * 5. az account show --sdk-auth > auth.json
- *
- * Authenticates using the service principal information provided in the auth file. This method will set
- * the subscriptionId from the auth file to the user provided environment variable in the options
- * parameter or the default "AZURE_SUBSCRIPTION_ID".
- *
- * @param {object} [options] - Optional parameters
- * @param {string} [options.filePath] - Absolute file path to the auth file. If not provided
- * then please set the environment variable AZURE_AUTH_LOCATION.
- * @param {string} [options.subscriptionEnvVariableName] - The subscriptionId environment variable
- * name. Default is "AZURE_SUBSCRIPTION_ID".
- * @param {function} [optionalCallback] The optional callback.
- *
- * @returns {function | Promise} If a callback was passed as the last parameter then it returns the callback else returns a Promise.
- *
- * {function} optionalCallback(err, credentials)
- * {Error} [err] - The Error object if an error occurred, null otherwise.
- * {ApplicationTokenCredentials} [credentials] - The ApplicationTokenCredentials object.
- * {Array} [subscriptions] - List of associated subscriptions across all the applicable tenants.
- * {Promise} A promise is returned.
- * @resolve {ApplicationTokenCredentials} The ApplicationTokenCredentials object.
- * @reject {Error} - The error object.
- */
- export declare function withAuthFile(): Promise<TokenCredentialsBase>;
- export declare function withAuthFile(options: LoginWithAuthFileOptions): Promise<TokenCredentialsBase>;
- export declare function withAuthFile(options: LoginWithAuthFileOptions, callback: {
- (err: Error, credentials: ApplicationTokenCredentials, subscriptions: Array<LinkedSubscription>): void;
- }): void;
- export declare function withAuthFile(callback: any): void;
- /**
- * Provides a url and code that needs to be copy and pasted in a browser and authenticated over there. If successful, the user will get a
- * DeviceTokenCredentials object and the list of subscriptions associated with that userId across all the applicable tenants.
- *
- * @param {object} [options] Object representing optional parameters.
- * @param {string} [options.clientId] The active directory application client id.
- * See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
- * for an example.
- * @param {string} [options.tokenAudience] The audience for which the token is requested. Valid value is "graph".If tokenAudience is provided
- * then domain should also be provided its value should not be the default "common" tenant. It must be a string (preferrably in a guid format).
- * @param {string} [options.domain] The domain or tenant id containing this application. Default value is "common".
- * @param {Environment} [options.environment] The azure environment to authenticate with. Default environment is "Public Azure".
- * @param {object} [options.tokenCache] The token cache. Default value is the MemoryCache object from adal.
- * @param {object} [options.language] The language code specifying how the message should be localized to. Default value "en-us".
- * @param {object|function} [options.userCodeResponseLogger] A logger that logs the user code response message required for interactive login. When
- * this option is specified the usercode response message will not be logged to console.
- * @param {function} [optionalCallback] The optional callback.
- *
- * @returns {function | Promise} If a callback was passed as the last parameter then it returns the callback else returns a Promise.
- *
- * {function} optionalCallback(err, credentials)
- * {Error} [err] - The Error object if an error occurred, null otherwise.
- * {DeviceTokenCredentials} [credentials] - The DeviceTokenCredentials object.
- * {Array} [subscriptions] - List of associated subscriptions across all the applicable tenants.
- * {Promise} A promise is returned.
- * @resolve {DeviceTokenCredentials} The DeviceTokenCredentials object.
- * @reject {Error} - The error object.
- */
- export declare function interactive(): Promise<DeviceTokenCredentials>;
- export declare function interactive(options: InteractiveLoginOptions): Promise<DeviceTokenCredentials>;
- export declare function interactive(options: InteractiveLoginOptions, callback: {
- (err: Error, credentials: DeviceTokenCredentials, subscriptions: Array<LinkedSubscription>): void;
- }): void;
- export declare function interactive(callback: any): void;
- /**
- * Provides an ApplicationTokenCredentials object and the list of subscriptions associated with that servicePrinicpalId/clientId across all the applicable tenants.
- *
- * @param {string} clientId The active directory application client id also known as the SPN (ServicePrincipal Name).
- * See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
- * for an example.
- * @param {string} secret The application secret for the service principal.
- * @param {string} domain The domain or tenant id containing this application.
- * @param {object} [options] Object representing optional parameters.
- * @param {string} [options.tokenAudience] The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
- * If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
- * @param {Environment} [options.environment] The azure environment to authenticate with.
- * @param {object} [options.tokenCache] The token cache. Default value is the MemoryCache object from adal.
- * @param {function} [optionalCallback] The optional callback.
- *
- * @returns {function | Promise} If a callback was passed as the last parameter then it returns the callback else returns a Promise.
- *
- * {function} optionalCallback(err, credentials)
- * {Error} [err] - The Error object if an error occurred, null otherwise.
- * {ApplicationTokenCredentials} [credentials] - The ApplicationTokenCredentials object.
- * {Array} [subscriptions] - List of associated subscriptions across all the applicable tenants.
- * {Promise} A promise is returned.
- * @resolve {ApplicationTokenCredentials} The ApplicationTokenCredentials object.
- * @reject {Error} - The error object.
- */
- export declare function withServicePrincipalSecret(clientId: string, secret: string, domain: string): Promise<ApplicationTokenCredentials>;
- export declare function withServicePrincipalSecret(clientId: string, secret: string, domain: string, options: AzureTokenCredentialsOptions): Promise<ApplicationTokenCredentials>;
- export declare function withServicePrincipalSecret(clientId: string, secret: string, domain: string, options: AzureTokenCredentialsOptions, callback: {
- (err: Error, credentials: ApplicationTokenCredentials, subscriptions: Array<LinkedSubscription>): void;
- }): void;
- export declare function withServicePrincipalSecret(clientId: string, secret: string, domain: string, callback: any): void;
- /**
- * Provides an ApplicationTokenCertificateCredentials object and the list of subscriptions associated with that servicePrinicpalId/clientId across all the applicable tenants.
- *
- * @param {string} clientId The active directory application client id also known as the SPN (ServicePrincipal Name).
- * See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
- * for an example.
- * @param {string} certificateStringOrFilePath A PEM encoded certificate and private key OR an absolute filepath to the .pem file containing that information. For example:
- * - CertificateString: "-----BEGIN PRIVATE KEY-----\n<xxxxx>\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n<yyyyy>\n-----END CERTIFICATE-----\n"
- * - CertificateFilePath: **Absolute** file path of the .pem file.
- * @param {string} domain The domain or tenant id containing this application.
- * @param {object} [options] Object representing optional parameters.
- * @param {string} [options.tokenAudience] The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
- * If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
- * @param {Environment} [options.environment] The azure environment to authenticate with.
- * @param {object} [options.tokenCache] The token cache. Default value is the MemoryCache object from adal.
- * @param {function} [optionalCallback] The optional callback.
- *
- * @returns {function | Promise} If a callback was passed as the last parameter then it returns the callback else returns a Promise.
- *
- * {function} optionalCallback(err, credentials)
- * {Error} [err] - The Error object if an error occurred, null otherwise.
- * {ApplicationTokenCertificateCredentials} [credentials] - The ApplicationTokenCertificateCredentials object.
- * {Array} [subscriptions] - List of associated subscriptions across all the applicable tenants.
- * {Promise} A promise is returned.
- * @resolve {ApplicationTokenCertificateCredentials} The ApplicationTokenCertificateCredentials object.
- * @reject {Error} - The error object.
- */
- export declare function withServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string): Promise<ApplicationTokenCertificateCredentials>;
- export declare function withServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, options: AzureTokenCredentialsOptions): Promise<ApplicationTokenCredentials>;
- export declare function withServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, options: AzureTokenCredentialsOptions, callback: {
- (err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: Array<LinkedSubscription>): void;
- }): void;
- export declare function withServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, callback: any): void;
- /**
- * Provides a UserTokenCredentials object and the list of subscriptions associated with that userId across all the applicable tenants.
- * This method is applicable only for organizational ids that are not 2FA enabled otherwise please use interactive login.
- *
- * @param {string} username The user name for the Organization Id account.
- * @param {string} password The password for the Organization Id account.
- * @param {object} [options] Object representing optional parameters.
- * @param {string} [options.clientId] The active directory application client id.
- * See {@link https://azure.microsoft.com/en-us/documentation/articles/active-directory-devquickstarts-dotnet/ Active Directory Quickstart for .Net}
- * for an example.
- * @param {string} [options.tokenAudience] The audience for which the token is requested. Valid values are 'graph', 'batch', or any other resource like 'https://vault.azure.net/'.
- * If tokenAudience is 'graph' then domain should also be provided and its value should not be the default 'common' tenant. It must be a string (preferrably in a guid format).
- * @param {string} [options.domain] The domain or tenant id containing this application. Default value "common".
- * @param {Environment} [options.environment] The azure environment to authenticate with.
- * @param {object} [options.tokenCache] The token cache. Default value is the MemoryCache object from adal.
- * @param {function} [optionalCallback] The optional callback.
- *
- * @returns {function | Promise} If a callback was passed as the last parameter then it returns the callback else returns a Promise.
- *
- * {function} optionalCallback(err, credentials)
- * {Error} [err] - The Error object if an error occurred, null otherwise.
- * {UserTokenCredentials} [credentials] - The UserTokenCredentials object.
- * {Array} [subscriptions] - List of associated subscriptions across all the applicable tenants.
- * {Promise} A promise is returned.
- * @resolve {UserTokenCredentials} The UserTokenCredentials object.
- * @reject {Error} - The error object.
- */
- export declare function withUsernamePassword(username: string, password: string): Promise<UserTokenCredentials>;
- export declare function withUsernamePassword(username: string, password: string, options: LoginWithUsernamePasswordOptions): Promise<UserTokenCredentials>;
- export declare function withUsernamePassword(username: string, password: string, callback: any): void;
- export declare function withUsernamePassword(username: string, password: string, options: LoginWithUsernamePasswordOptions, callback: {
- (err: Error, credentials: UserTokenCredentials, subscriptions: Array<LinkedSubscription>): void;
- }): void;
- /**
- * Before using this method please install az cli from https://github.com/Azure/azure-cli/releases.
- * If you have an Azure virtual machine provisioned with az cli and has MSI enabled,
- * you can then use this method to get auth tokens from the VM.
- *
- * To create a new VM, enable MSI, please execute this command:
- * az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name>
- * Note: the above command enables a service endpoint on the host, with a default port 50342
- *
- * To enable MSI on a already provisioned VM, execute the following command:
- * az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>
- *
- * To know more about this command, please execute:
- * az vm --assign-identity -h
- *
- * Authenticates using the identity service running on an Azure virtual machine.
- * This method makes a request to the authentication service hosted on the VM
- * and gets back an access token.
- *
- * @param {object} [options] - Optional parameters
- * @param {string} [options.port] - port on which the MSI service is running on the host VM. Default port is 50342
- * @param {string} [options.resource] - The resource uri or token audience for which the token is needed.
- * For e.g. it can be:
- * - resourcemanagement endpoint "https://management.azure.com/"(default)
- * - management endpoint "https://management.core.windows.net/"
- * @param {function} [optionalCallback] The optional callback.
- *
- * @returns {function | Promise} If a callback was passed as the last parameter then it returns the callback else returns a Promise.
- *
- * {function} optionalCallback(err, credentials)
- * {Error} [err] - The Error object if an error occurred, null otherwise.
- * {object} [tokenResponse] - The tokenResponse (tokenType and accessToken are the two important properties)
- * {Promise} A promise is returned.
- * @resolve {object} - tokenResponse.
- * @reject {Error} - error object.
- */
- export declare function loginWithVmMSI(): Promise<MSIVmTokenCredentials>;
- export declare function loginWithVmMSI(options: MSIVmOptions): Promise<MSIVmTokenCredentials>;
- export declare function loginWithVmMSI(options: MSIVmOptions, callback: Callback<MSIVmTokenCredentials>): void;
- export declare function loginWithVmMSI(callback: Callback<MSIVmTokenCredentials>): void;
- /**
- * Authenticate using the App Service MSI.
- * @param {object} [options] - Optional parameters
- * @param {string} [options.msiEndpoint] - The local URL from which your app can request tokens.
- * Either provide this parameter or set the environment variable `MSI_ENDPOINT`.
- * For example: `MSI_ENDPOINT="http://127.0.0.1:41741/MSI/token/"`
- * @param {string} [options.msiSecret] - The secret used in communication between your code and the local MSI agent.
- * Either provide this parameter or set the environment variable `MSI_SECRET`.
- * For example: `MSI_SECRET="69418689F1E342DD946CB82994CDA3CB"`
- * @param {string} [options.resource] - The resource uri or token audience for which the token is needed.
- * For example, it can be:
- * - resourcemanagement endpoint "https://management.azure.com/"(default)
- * - management endpoint "https://management.core.windows.net/"
- * @param {string} [options.msiApiVersion] - The api-version of the local MSI agent. Default value is "2017-09-01".
- * @param {function} [optionalCallback] - The optional callback.
- * @returns {function | Promise} If a callback was passed as the last parameter then it returns the callback else returns a Promise.
- *
- * {function} optionalCallback(err, credentials)
- * {Error} [err] - The Error object if an error occurred, null otherwise.
- * {object} [tokenResponse] - The tokenResponse (tokenType and accessToken are the two important properties)
- * {Promise} A promise is returned.
- * @resolve {object} - tokenResponse.
- * @reject {Error} - error object.
- */
- export declare function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>;
- export declare function loginWithAppServiceMSI(options: MSIAppServiceOptions): Promise<MSIAppServiceTokenCredentials>;
- export declare function loginWithAppServiceMSI(options: MSIAppServiceOptions, callback: Callback<MSIAppServiceTokenCredentials>): void;
- export declare function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>): void;
- /**
- * Executes the azure cli command and returns the result. It will be `undefined` if the command did
- * not return anything or a `JSON object` if the command did return something.
- * @param cmd The az cli command to execute.
- */
- export declare function execAz(cmd: string): Promise<any>;
- //# sourceMappingURL=login.d.ts.map
|