Fork me on GitHub

Global

Members

createARMHDInsightJobManagementClient

Creates a new HDInsightJobManagementClient object
The HDInsightJobManagementClient object is used to submit jobs on the Microsoft Azure HDInsight Service.

Source:

createARMHDInsightManagementClient

Creates a new HDInsightManagementClient object
The HDInsightManagementClient object is used to perform cluster CRUD operations on the Microsoft Azure HDInsight Service.

Source:

createASMTrafficManagerManagementClient

Creates a new TrafficManagerManagementClient object.

NOTE: These APIs are still in development and should not be used.

Source:

createKeyVaultClient

Creates a new KeyVaultClient object.

Source:

interactiveLogin

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.

Source:

KEYVAULT_RESOURCE_ID

Identifier of the resource on which Key Vault users and service principals must authenticate.

Source:

loginWithServicePrincipalSecret

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.

Source:

loginWithUsernamePassword

Provides an ApplicationTokenCredentials object and the list of subscriptions associated with that servicePrinicpalId/clientId across all the applicable tenants.

Source:

sdkconfig

Configuration

Source:

Methods

createAdvisorManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the AdvisorManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The Azure subscription ID.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

The version of the API to be used with the client request.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createAnalysisServicesManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the AnalysisServicesManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

A unique identifier of a Microsoft Azure subscription. The subscription id forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client API Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createApiManagementClient(credentials, subscriptionId, optionsopt)

Create a ApiManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createAppInsightsManagementClient(credentials, subscriptionId, optionsopt)

Create a AppInsightsManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The Azure subscription Id.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createARMGalleryClient(credentials, baseUriopt, filtersopt) → {GalleryClient}

Creates a new GalleryClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials object (typically, a TokenCloudCredentials instance)

baseUri string <optional>

The base uri

filters Array <optional>

Extra filters to attach to the client

Source:
Returns:

A new GalleryClient object.

Type
GalleryClient

createASMComputeManagementClient(credentials, baseUriopt) → {ComputeManagementClient}

Creates a new ComputeManagementClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials object (typically, a CertificateCloudCredentials instance)

Properties
Name Type Attributes Description
subscriptionId string

The subscription identifier.

cert string <optional>

The cert value.

key string <optional>

The key value.

pem string <optional>

The PEM file data.

baseUri string <optional>

The base uri.

Source:
Returns:

A new ComputeManagementClient object.

Type
ComputeManagementClient

createASMNetworkManagementClient(credentials, baseUriopt) → {NetworkManagementClient}

Creates a new NetworkManagementClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials object (typically, a CertificateCloudCredentials instance)

Properties
Name Type Attributes Description
subscriptionId string

The subscription identifier.

cert string <optional>

The cert value.

key string <optional>

The key value.

pem string <optional>

The PEM file data.

baseUri string <optional>

The base uri.

Source:
Returns:

A new NetworkManagementClient object.

Type
NetworkManagementClient

createASMSchedulerManagementClient(credentials, baseUriopt) → {SchedulerManagementClient}

Creates a new SchedulerManagementClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials object (typically, a CertificateCloudCredentials instance)

Properties
Name Type Attributes Description
subscriptionId string

The subscription identifier.

cert string <optional>

The cert value.

key string <optional>

The key value.

pem string <optional>

The PEM file data.

baseUri string <optional>

The base uri.

Source:
Returns:

A new SchedulerManagementClient object.

Type
SchedulerManagementClient

createASMScmService(authentication, hostOptionsopt) → {ScmService}

Creates a new ScmService object.

Parameters:
Name Type Attributes Description
authentication object

The authentication object for the client.
You must use a auth/pass for basic authentication.

Properties
Name Type Attributes Description
user string <optional>

The basic authentication username.

pass string <optional>

The basic authentication password.

hostOptions object <optional>

The host options to override defaults.

Properties
Name Type Attributes Description
host string <optional>

The SCM repository endpoint.

Source:
Returns:

A new WebsitemanagementService object.

Type
ScmService

createASMSqlManagementClient(baseUriopt) → {SqlClient}

Creates a new SqlClient object.

Parameters:
Name Type Attributes Description
credentials.subscriptionId string <optional>

The subscription identifier.

credentials.cert string <optional>

The cert value.

credentials.key string <optional>

The key value.

baseUri string <optional>

The base uri.

Source:
Returns:

A new SqlClient object.

Type
SqlClient

createASMSqlManagementService(subscriptionId, authentication, hostOptionsopt) → {SqlManagementService}

Creates a new SqlManagementService object.

Parameters:
Name Type Attributes Description
subscriptionId string

The subscription ID for the account.

authentication object

The authentication object for the client.
You must use either keyfile/certfile or keyvalue/certvalue
to provide a management certificate to authenticate
service requests.

Properties
Name Type Attributes Description
keyfile string <optional>

The path to a file that contains the PEM encoded key

certfile string <optional>

The path to a file that contains the PEM encoded certificate

keyvalue string <optional>

A string that contains the PEM encoded key

certvalue string <optional>

A string that contains the PEM encoded certificate

hostOptions object <optional>

The host options to override defaults.

Properties
Name Type Attributes Default Description
host string <optional>
'management.core.windows.net'

The management endpoint.

apiversion string <optional>
'2012-03-01'

The API vesion to be used.

Source:
Returns:

A new SqlManagementService object.

Type
SqlManagementService

createASMStorageManagementClient(credentials, baseUriopt) → {StorageManagementClient}

Creates a new StorageManagementClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials object (typically, a CertificateCloudCredentials instance)

Properties
Name Type Attributes Description
subscriptionId string

The subscription identifier.

cert string <optional>

The cert value.

key string <optional>

The key value.

pem string <optional>

The PEM file data.

baseUri string <optional>

The base uri.

Source:
Returns:

A new StorageManagementClient object.

Type
StorageManagementClient

createASMStoreManagementClient(credentials, baseUriopt) → {StoreManagementClient}

Creates a new StoreManagementClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials object (typically, a CertificateCloudCredentials instance)

Properties
Name Type Attributes Description
subscriptionId string

The subscription identifier.

cert string <optional>

The cert value.

key string <optional>

The key value.

pem string <optional>

The PEM file data.

baseUri string <optional>

The base uri.

Source:
Returns:

A new StoreManagementClient object.

Type
StoreManagementClient

createASMSubscriptionClient(credentials, baseUriopt) → {SubscriptionClient}

Creates a new SubscriptionClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials object (typically, a TokenCloudCredentials instance)

baseUri string <optional>

The base uri.

Source:
Returns:

A new SubscriptionClient object.

Type
SubscriptionClient

createASMWebSiteExtensionsClient(siteName, baseUriopt) → {WebSiteManagementClient}

Creates a new WebSiteExtensionsClient object.

Parameters:
Name Type Attributes Description
siteName string

The site name.

credentials.username string

The username.

credentials.password string

The password.

baseUri string <optional>

The base uri.

Source:
Returns:

A new WebSiteManagementClient object.

Type
WebSiteManagementClient

createASMWebSiteManagementClient(credentials, baseUriopt) → {WebSiteManagementClient}

Creates a new WebSiteManagementClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials object (typically, a CertificateCloudCredentials instance)

Properties
Name Type Attributes Description
subscriptionId string

The subscription identifier.

cert string <optional>

The cert value.

key string <optional>

The key value.

pem string <optional>

The PEM file data.

baseUri string <optional>

The base uri.

Source:
Returns:

A new WebSiteManagementClient object.

Type
WebSiteManagementClient

createASMWebsiteManagementService(subscriptionId, authentication, hostOptionsopt) → {WebsiteManagementService}

Creates a new WebsiteManagementService object.

Parameters:
Name Type Attributes Description
subscriptionId string

The subscription ID for the account.

authentication object

The authentication object for the client.
You must use either keyfile/certfile or keyvalue/certvalue
to provide a management certificate to authenticate
service requests.

Properties
Name Type Attributes Description
keyfile string <optional>

The path to a file that contains the PEM encoded key

certfile string <optional>

The path to a file that contains the PEM encoded certificate

keyvalue string <optional>

A string that contains the PEM encoded key

certvalue string <optional>

A string that contains the PEM encoded certificate

hostOptions object <optional>

The host options to override defaults.

Properties
Name Type Attributes Default Description
host string <optional>
'management.core.windows.net'

The management endpoint.

apiversion string <optional>
'2012-03-01'

The API vesion to be used.

Deprecated:
  • Use createWebSiteManagementClient instead.
Source:
Returns:

A new WebsitemanagementService object.

Type
WebsiteManagementService

createAuthorizationManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ARM AuthorizationManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createAutomationManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the AutomationManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createAutoScaleClient(credentials, baseUriopt) → {AutoScaleClient}

Creates a new AutoScaleClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials object (typically, a CertificateCloudCredentials instance)

Properties
Name Type Attributes Description
subscriptionId string

The subscription identifier.

cert string <optional>

The cert value.

key string <optional>

The key value.

pem string <optional>

The PEM file data.

baseUri string <optional>

The base uri.

Source:
Returns:

A new AutoScaleClient object.

Type
AutoScaleClient

createBasicAuthenticationCloudCredentials() → {BasicAuthenticationCloudCredentials}

Creates a new BasicAuthenticationCloudCredentials object.
Either a pair of cert / key values need to be pass or a pem file location.

Parameters:
Name Type Description
credentials.username string

The username.

credentials.password string

The password.

Source:
Returns:
Type
BasicAuthenticationCloudCredentials

createBatchManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ARM BatchManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createBatchServiceClient(credentials, baseUriopt, optionsopt)

Creates a new instance of the BatchServiceClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

baseUri string <optional>

The base URI of the service.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createBillingManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the BillingManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Azure Subscription ID.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Version of the API to be used with the client request. The current version is 2017-02-27-preview.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createBlobService(storageAccountOrConnectionStringopt, storageAccessKeyopt, hostopt, authenticationProvideropt) → {BlobService}

Creates a new BlobService object.
If no storageaccount or storageaccesskey are provided, the AZURE_STORAGE_ACCOUNT and AZURE_STORAGE_ACCESS_KEY environment variables will be used.

Parameters:
Name Type Attributes Description
storageAccountOrConnectionString string <optional>

The storage account or the connection string.

storageAccessKey string <optional>

The storage access key.

host string <optional>

The host address.

authenticationProvider object <optional>

The authentication provider.

Source:
Returns:

A new BlobService object.

Type
BlobService

createCdnManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ARM CdnManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createCertificateCloudCredentials() → {CertificateCloudCredentials}

Creates a new CertificateCloudCredentials object.
Either a pair of cert / key values need to be pass or a pem file location.

Parameters:
Name Type Attributes Description
credentials.subscription string

The subscription identifier.

credentials.cert string <optional>

The certificate.

credentials.key string <optional>

The certificate key.

credentials.pem string <optional>

The PEM file content.

Source:
Returns:
Type
CertificateCloudCredentials

createCognitiveServicesManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the CognitiveServicesManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Azure Subscription ID.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Version of the API to be used with the client request. Current version is 2016-02-01-preview

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createComputeManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ARM ComputeManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createConsumptionManagementClient(credentials, subscriptionId, optionsopt)

Create a ConsumptionManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Azure Subscription ID.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createContainerRegistryManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the ContainerRegistryManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The Microsoft Azure subscription ID.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

The client API version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createCosmosDBManagementClient(credentials, subscriptionId, optionsopt)

Creates a CosmosDBManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Azure subscription ID.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Version of the API to be used with the client request. The current version is 2015-04-08.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createCustomerInsightsManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the CustomerInsightsManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createDataFactoryManagementClient(credentials, subscriptionId, optionsopt)

Create a DataFactoryManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription identifier.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createDataLakeAnalyticsAccountManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the DataLakeAnalyticsAccountManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createDataLakeAnalyticsCatalogManagementClient(credentials, optionsopt)

Creates a new instance of the DataLakeAnalyticsCatalogManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
adlaCatalogDnsSuffix string <optional>

Gets the DNS suffix used as the base for all Azure Data Lake Analytics Catalog service requests. Default value: 'azuredatalakeanalytics.net'

filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createDataLakeAnalyticsJobManagementClient(credentials, optionsopt)

Creates a new instance of the DataLakeAnalyticsJobManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
adlaJobDnsSuffix string <optional>

Gets the DNS suffix used as the base for all Azure Data Lake Analytics Job service requests. Default value: 'azuredatalakeanalytics.net'

filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createDataLakeStoreAccountManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the DataLakeStoreAccountManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createDataLakeStoreFileSystemManagementClient(credentials, optionsopt)

Creates a new instance of the DataLakeStoreFileSystemManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
adlsFileSystemDnsSuffix string <optional>

Gets the URI used as the base for all cloud service requests. Default value: 'azuredatalakestore.net'

filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createDevTestLabsClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the IotHubManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createDnsManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the DnsManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createDocumentdbManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the DocumentdbManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Azure subscription ID.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Version of the API to be used with the client request. The current version is 2015-04-08.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createDomainServicesManagementClient(credentials, subscriptionId, optionsopt)

Create a DomainServicesManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createEventGridManagementClient(credentials, subscriptionId, optionsopt)

Create a EventGridManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription identifier.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createEventHubManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the EventHubManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client API Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createEventsClient(credentials, baseUriopt, filtersopt) → {EventsClient}

Creates a new EventsClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials, typically a TokenCloudCredential

baseUri string <optional>

The base uri.

filters array <optional>

Extra request filters to add

Source:
Returns:

A new EventsClient object.

Type
EventsClient

createFeatureManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ARM FeatureManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createGraphManagementClient(credentials, tenantID, optionsopt)

Creates a new instance of the ARM GraphRbacManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

tenantID string

Gets or sets the tenant Id.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createHDInsightService(subscriptionId, authentication, hostOptionsopt) → {HDInsightService}

Creates a new HDInsightService object.

Parameters:
Name Type Attributes Description
subscriptionId string

The subscription ID for the account.

authentication object

The authentication object for the client.
You must use either keyfile/certfile or keyvalue/certvalue
to provide a management certificate to authenticate
service requests.

Properties
Name Type Attributes Description
keyfile string <optional>

The path to a file that contains the PEM encoded key

certfile string <optional>

The path to a file that contains the PEM encoded certificate

keyvalue string <optional>

A string that contains the PEM encoded key

certvalue string <optional>

A string that contains the PEM encoded certificate

hostOptions object <optional>

The host options to override defaults.

Properties
Name Type Attributes Default Description
host string <optional>
'management.core.windows.net'

The management endpoint.

apiversion string <optional>
'2012-03-01'

The API vesion to be used.

Source:
Returns:

A new HDInsightService object.

Type
HDInsightService

createIotHubManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the IotHubManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createKeyVaultManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the KeyVaultManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createLogicManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the LogicManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription id.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

The API version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createMachineLearningCommitmentPlansManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the MachineLearningCommitmentPlansManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Azure Subscription ID.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

The version of the Microsoft.MachineLearning resource provider API to use.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createMachineLearningComputeManagementClient(credentials, subscriptionId, optionsopt)

Create a MachineLearningComputeManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription identifier.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createMachineLearningWebServicesManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the MachineLearningWebServicesManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The Azure subscription ID.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

The version of the Microsoft.MachineLearning resource provider API to use.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createManagementClient(credentials, baseUriopt) → {ManagementClient}

Creates a new ManagementClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials object (typically, a CertificateCloudCredentials instance)

Properties
Name Type Attributes Description
subscriptionId string

The subscription identifier.

cert string <optional>

The cert value.

key string <optional>

The key value.

pem string <optional>

The PEM file data.

baseUri string <optional>

The base uri.

Source:
Returns:

A new ManagementClient object.

Type
ManagementClient

createMarketplaceOrderingAgreementsClient(credentials, subscriptionId, optionsopt)

Create a MarketplaceOrderingAgreementsClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription identifier.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createMarketplaceOrderingAgreementsClient(credentials, subscriptionId, optionsopt)

Create a MarketplaceOrderingAgreementsClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription identifier.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createMediaServicesManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the MediaServicesManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The unique identifier for a Microsoft Azure subscription.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Version of the API to be used with the client request. Current version is 2015-10-01

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createMetricsClient(credentials, baseUriopt) → {MetricsClient}

Creates a new MetricsClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials object (typically, a CertificateCloudCredentials instance)

Properties
Name Type Attributes Description
subscriptionId string

The subscription identifier.

cert string <optional>

The cert value.

key string <optional>

The key value.

pem string <optional>

The PEM file data.

baseUri string <optional>

The base uri.

Source:
Returns:

A new MetricsClient object.

Type
MetricsClient

createMobileEngagementClient(credentials, subscriptionId, optionsopt)

Create a MobileEngagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription identifier.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createMonitorClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the MonitorClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The Azure subscription Id.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createMonitorManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the MonitorManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The Azure subscription Id.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createMySQLManagementClient(credentials, subscriptionId, baseUriopt, optionsopt)

Initializes a new instance of the MySQLManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription ID that identifies an Azure subscription.

baseUri string <optional>

The base URI of the service.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

The API version to use for the request.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createNetworkManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ARM NetworkManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createNotificationHubService(hubName, endpointOrConnectionStringopt, sharedAccessKeyNameopt, sharedAccessKeyValueopt) → {NotificationHubService}

Creates a new NotificationHubService object.

Parameters:
Name Type Attributes Description
hubName string

The notification hub name.

endpointOrConnectionString string <optional>

The service bus endpoint or connection string.

sharedAccessKeyName string <optional>

The notification hub shared access key name.

sharedAccessKeyValue string <optional>

The notification hub shared access key value.

Source:
Returns:

A new NotificationHubService object.

Type
NotificationHubService

createNotificationHubsManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the NotificationHubsManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createPostgreSQLManagementClient(credentials, subscriptionId, baseUriopt, optionsopt)

Initializes a new instance of the PostgreSQLManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription ID that identifies an Azure subscription.

baseUri string <optional>

The base URI of the service.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

The API version to use for the request.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createPowerBIEmbeddedManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the PowerBIEmbeddedManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createQueueService(storageAccountOrConnectionStringopt, storageAccessKeyopt, hostopt, authenticationProvideropt) → {QueueService}

Creates a new QueueService object.
If no storageAccount or storageAccessKey are provided, the AZURE_STORAGE_ACCOUNT and AZURE_STORAGE_ACCESS_KEY
environment variables will be used.

Parameters:
Name Type Attributes Description
storageAccountOrConnectionString string <optional>

The storage account or the connection string.

storageAccessKey string <optional>

The storage access key.

host string <optional>

The host address.

authenticationProvider object <optional>

The authentication provider.

Source:
Returns:

A new QueueService object.

Type
QueueService

createRecoveryServicesBackupManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the RecoveryServicesBackupClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription ID.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createRecoveryServicesManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the RecoveryServicesManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription ID.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createRedisCacheManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ARM RedisCacheManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createRelayManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the RelayManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createResourceHealthClient(credentials, subscriptionId, optionsopt)

Create a MicrosoftResourceHealth.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createResourceManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ARM ResourceManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createResourceManagementGroupsClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ARM Resource ManagementGroupsClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createResourceManagementLinkClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ARM Resource ManagementLinkClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createResourceManagementLockClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ARM Resource ManagementLockClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createResourcePolicyClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the PolicyClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createSchedulerClient(credentials, baseUriopt) → {SchedulerClient}

Creates a new SchedulerClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials object (typically, a CertificateCloudCredentials instance)

Properties
Name Type Attributes Description
subscriptionId string

The subscription identifier.

cert string <optional>

The cert value.

key string <optional>

The key value.

pem string <optional>

The PEM file data.

baseUri string <optional>

The base uri.

Source:
Returns:

A new SchedulerClient object.

Type
SchedulerClient

createSchedulerManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the SchedulerManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription id.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

The API version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createSearchIndexClient(credentials, baseUriopt, optionsopt)

Initializes a new instance of the SearchIndexClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

baseUri string <optional>

The base URI of the service.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createSearchManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the SearchManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

The API version to use for each request. The current version is 2015-08-19.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createSearchServiceClient(credentials, baseUriopt, optionsopt)

Initializes a new instance of the SearchServiceClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

baseUri string <optional>

The base URI of the service.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createServerManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ServerManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createServiceBusManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the ServiceBusManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client API version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createServiceBusManagementClient(credentials, baseUriopt) → {ServiceBusManagementClient}

Creates a new ServiceBusManagementClient object.

Parameters:
Name Type Attributes Description
credentials object

The credentials object (typically, a CertificateCloudCredentials instance)

Properties
Name Type Attributes Description
subscriptionId string

The subscription identifier.

cert string <optional>

The cert value.

key string <optional>

The key value.

pem string <optional>

The PEM file data.

baseUri string <optional>

The base uri.

Source:
Returns:

A new ServiceBusManagementClient object.

Type
ServiceBusManagementClient

createServiceBusService(configOrNamespaceOrConnectionStringopt, accessKeyopt, issueropt, acsNamespaceopt, hostopt, authenticationProvideropt) → {ServiceBusService}

Creates a new ServiceBusService object.

Parameters:
Name Type Attributes Description
configOrNamespaceOrConnectionString string <optional>

The service bus namespace or other config information.

accessKey string <optional>

The password.

issuer string <optional>

The issuer.

acsNamespace string <optional>

The acs namespace. Usually the same as the sb namespace with "-sb" suffix.

host string <optional>

The host address.

authenticationProvider object <optional>

The authentication provider.

Source:
Returns:

A new ServiceBusService object.

Type
ServiceBusService

createServiceFabricClient(apiVersion, baseUriopt, optionsopt)

Initializes a new instance of the ServiceFabricClient.

Parameters:
Name Type Attributes Description
apiVersion string

The version of the api

baseUri string <optional>

The base URI of the service.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

timeout number <optional>

The timeout in seconds

Source:

createServiceFabricManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the ServiceFabricClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription identifier

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

The version of the api

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createServicemapManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the ServicemapManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

Azure subscription identifier.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

API version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createSiteRecoveryManagementClient(credentials, subscriptionId, optionsopt)

Create a SiteRecoveryManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription Id.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createSqlManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the SqlManagementClient class.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription ID that identifies an Azure subscription.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createSqlService(serverName, administratorLogin, administratorLoginPassword, hostopt, acsHostopt, authenticationProvideropt)

Creates a new SqlService object

The SqlService object allows you to perform management operations against databases
created using Microsoft Azure SQL Database.

Parameters:
Name Type Attributes Description
serverName string

The SQL server name.

administratorLogin string

The SQL Server administrator login.

administratorLoginPassword string

The SQL Server administrator login password.

host string <optional>

The host for the service.

acsHost string <optional>

The acs host.

authenticationProvider object <optional>

The authentication provider.

Source:

createStorageImportExportManagementClient(credentials, subscriptionId, optionsopt)

Initializes a new instance of the StorageImportExportManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription ID for the Azure user.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createStorageManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ARM StorageManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createStorSimple8000SeriesManagementClient(credentials, subscriptionId, optionsopt)

Create a StorSimple8000SeriesManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The subscription id

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createStreamAnalyticsManagementClient(credentials, subscriptionId, optionsopt)

Create a StreamAnalyticsManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

GUID which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createSubscriptionManagementClient(credentials, optionsopt)

Creates a new instance of the ARM SubscriptionManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createTableService(storageAccountOrConnectionStringopt, storageAccessKeyopt, hostopt, authenticationProvideropt) → {TableService}

Creates a new TableService object.
If no storageaccount or storageaccesskey are provided, the AZURE_STORAGE_ACCOUNT and AZURE_STORAGE_ACCESS_KEY environment variables will be used.

Parameters:
Name Type Attributes Description
storageAccountOrConnectionString string <optional>

The storage account or the connection string.

storageAccessKey string <optional>

The storage access key.

host string <optional>

The host address.

authenticationProvider object <optional>

The authentication provider.

Source:
Tutorials:
  • Tutorial: getting-started
Returns:

A new TableService object.

Type
TableService

createTrafficManagerManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the TrafficManagerManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createVisualStudioManagementClient(credentials, subscriptionId, optionsopt)

Create a VisualStudioResourceProviderClient.

Parameters:
Name Type Attributes Description
credentials credentials

Credentials needed for the client to connect to Azure.

subscriptionId string

The Azure subscription identifier.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createWebsiteManagementClient(credentials, subscriptionId, optionsopt)

Creates a new instance of the ARM WebsiteManagementClient.

Parameters:
Name Type Attributes Description
credentials credentials

Gets Azure subscription credentials.

subscriptionId string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options object <optional>

The parameter options

Properties
Name Type Attributes Description
filters Array <optional>

Filters to be added to the request pipeline

requestOptions object <optional>

Options for the underlying request object
Options doc

noRetryPolicy boolean <optional>

If set to true, turn off default retry policy

apiVersion string <optional>

Client Api Version.

acceptLanguage string <optional>

Gets or sets the preferred language for the response.

longRunningOperationRetryTimeout number <optional>

Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30.

generateClientRequestId boolean <optional>

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Source:

createWrapService(acsHost, issueropt, accessKeyopt)

Creates a new WrapService object.

Parameters:
Name Type Attributes Description
acsHost string

The access control host.

issuer string <optional>

The service bus issuer.

accessKey string <optional>

The service bus issuer password.

Source:

isEmulated()

Check if the application is running in the Microsoft Azure Emulator.

Properties:
Name Type Description
isEmulated boolean

true if the application is running in the emulator; otherwise, false.

Source:

Type Definitions

AzureChinaCloudEnvironment

Type:
  • object
Properties:
Name Type Description
name: string

'AzureChina',

portalUrl: string

'http://go.microsoft.com/fwlink/?LinkId=301902',

publishingProfileUrl: string

'http://go.microsoft.com/fwlink/?LinkID=301774',

managementEndpointUrl: string

'https://management.core.chinacloudapi.cn',

resourceManagerEndpointUrl: string

'https://management.chinacloudapi.cn',

sqlManagementEndpointUrl: string

'https://management.core.chinacloudapi.cn:8443/',

sqlServerHostnameSuffix: string

'.database.chinacloudapi.cn',

galleryEndpointUrl: string

'https://gallery.chinacloudapi.cn/',

activeDirectoryEndpointUrl: string

'https://login.chinacloudapi.cn/',

activeDirectoryResourceId: string

'https://management.core.chinacloudapi.cn/',

activeDirectoryGraphResourceId: string

'https://graph.chinacloudapi.cn/',

activeDirectoryGraphApiVersion: string

'2013-04-05',

storageEndpointSuffix: string

'.core.chinacloudapi.cn',

keyVaultDnsSuffix: string

'.vault.azure.cn',

azureDataLakeStoreFileSystemEndpointSuffix: string

'N/A',

azureDataLakeAnalyticsCatalogAndJobEndpointSuffix: string

'N/A'

Source:

AzureGermanCloudEnvironment

Type:
  • object
Properties:
Name Type Description
name: string

'AzureGermanCloud',

portalUrl: string

'http://portal.microsoftazure.de/',

publishingProfileUrl: string

'https://manage.microsoftazure.de/publishsettings/index',

managementEndpointUrl: string

'https://management.core.cloudapi.de',

resourceManagerEndpointUrl: string

'https://management.microsoftazure.de',

sqlManagementEndpointUrl: string

'https://management.core.cloudapi.de:8443/',

sqlServerHostnameSuffix: string

'.database.cloudapi.de',

galleryEndpointUrl: string

'https://gallery.cloudapi.de/',

activeDirectoryEndpointUrl: string

'https://login.microsoftonline.de/',

activeDirectoryResourceId: string

'https://management.core.cloudapi.de/',

activeDirectoryGraphResourceId: string

'https://graph.cloudapi.de/',

activeDirectoryGraphApiVersion: string

'2013-04-05',

storageEndpointSuffix: string

'.core.cloudapi.de',

keyVaultDnsSuffix: string

'.vault.microsoftazure.de',

azureDataLakeStoreFileSystemEndpointSuffix: string

'N/A',

azureDataLakeAnalyticsCatalogAndJobEndpointSuffix: string

'N/A'

Source:

AzurePublicCloudEnvironment

Type:
  • object
Properties:
Name Type Description
name string

'Azure',

portalUrl string

'http://go.microsoft.com/fwlink/?LinkId=254433',

publishingProfileUrl string

'http://go.microsoft.com/fwlink/?LinkId=254432',

managementEndpointUrl string

'https://management.core.windows.net',

resourceManagerEndpointUrl string

'https://management.azure.com/',

sqlManagementEndpointUrl string

'https://management.core.windows.net:8443/',

sqlServerHostnameSuffix string

'.database.windows.net',

galleryEndpointUrl string

'https://gallery.azure.com/',

activeDirectoryEndpointUrl string

'https://login.microsoftonline.com/',

activeDirectoryResourceId string

'https://management.core.windows.net/',

activeDirectoryGraphResourceId string

'https://graph.windows.net/',

activeDirectoryGraphApiVersion string

'2013-04-05',

storageEndpointSuffix string

'.core.windows.net',

keyVaultDnsSuffix string

'.vault.azure.net',

azureDataLakeStoreFileSystemEndpointSuffix string

'azuredatalakestore.net',

azureDataLakeAnalyticsCatalogAndJobEndpointSuffix string

'azuredatalakeanalytics.net'

Source:

AzureUSGovernmentCloudEnvironment

Type:
  • object
Properties:
Name Type Description
name: string

'AzureUSGovernment',

portalUrl: string

'https://manage.windowsazure.us',

publishingProfileUrl: string

'https://manage.windowsazure.us/publishsettings/index',

managementEndpointUrl: string

'https://management.core.usgovcloudapi.net',

resourceManagerEndpointUrl: string

'https://management.usgovcloudapi.net',

sqlManagementEndpointUrl: string

'https://management.core.usgovcloudapi.net:8443/',

sqlServerHostnameSuffix: string

'.database.usgovcloudapi.net',

galleryEndpointUrl: string

'https://gallery.usgovcloudapi.net/',

activeDirectoryEndpointUrl: string

'https://login.microsoftonline.com/',

activeDirectoryResourceId: string

'https://management.core.usgovcloudapi.net/',

activeDirectoryGraphResourceId: string

'https://graph.windows.net/',

activeDirectoryGraphApiVersion: string

'2013-04-05',

storageEndpointSuffix: string

'.core.usgovcloudapi.net',

keyVaultDnsSuffix: string

'.vault.usgovcloudapi.net',

azureDataLakeStoreFileSystemEndpointSuffix: string

'N/A',

azureDataLakeAnalyticsCatalogAndJobEndpointSuffix: string

'N/A'

Source: