Share via

TenantConfigurations interface

  • Reference
Package:
@azure/arm-portal

Interface representing a TenantConfigurations.

Methods

create(string, Configuration, TenantConfigurationsCreateOptionalParams)

Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation.
delete(string, TenantConfigurationsDeleteOptionalParams)

Delete the tenant configuration. User has to be a Tenant Admin for this operation.
get(string, TenantConfigurationsGetOptionalParams)

Gets the tenant configuration.
list(TenantConfigurationsListOptionalParams)

Gets list of the tenant configurations.

Method Details

create(string, Configuration, TenantConfigurationsCreateOptionalParams)

Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation.

function create(configurationName: string, tenantConfiguration: Configuration, options?: TenantConfigurationsCreateOptionalParams): Promise<Configuration>

Parameters

configurationName

string

The configuration name. Value must be 'default'

tenantConfiguration
Configuration

The parameters required to create or update tenant configuration.

options
TenantConfigurationsCreateOptionalParams

The options parameters.

Returns

Promise<Configuration>

delete(string, TenantConfigurationsDeleteOptionalParams)

Delete the tenant configuration. User has to be a Tenant Admin for this operation.

function delete(configurationName: string, options?: TenantConfigurationsDeleteOptionalParams): Promise<void>

Parameters

configurationName

string

The configuration name. Value must be 'default'

options
TenantConfigurationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, TenantConfigurationsGetOptionalParams)

Gets the tenant configuration.

function get(configurationName: string, options?: TenantConfigurationsGetOptionalParams): Promise<Configuration>

Parameters

configurationName

string

The configuration name. Value must be 'default'

options
TenantConfigurationsGetOptionalParams

The options parameters.

Returns

Promise<Configuration>

list(TenantConfigurationsListOptionalParams)

Gets list of the tenant configurations.

function list(options?: TenantConfigurationsListOptionalParams): PagedAsyncIterableIterator<Configuration, Configuration[], PageSettings>

Parameters

options
TenantConfigurationsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Configuration, Configuration[], PageSettings>