Interface TenantConfigurations

Package version

Interface representing a TenantConfigurations.

Hierarchy

TenantConfigurations

Implemented by

TenantConfigurationsImpl

Index

Methods

Methods

create

create(configurationName: ConfigurationName, tenantConfiguration: Configuration, options?: TenantConfigurationsCreateOptionalParams): Promise<TenantConfigurationsCreateResponse>

- Defined in operationsInterfaces/tenantConfigurations.ts:47
Create the tenant configuration. If configuration already exists - update it. User has to be a Tenant Admin for this operation.

Parameters
- configurationName: ConfigurationName
  
  The configuration name. Value must be 'default'
- tenantConfiguration: Configuration
  
  The parameters required to create or update tenant configuration.
- Optional options: TenantConfigurationsCreateOptionalParams
  
  The options parameters.
Returns Promise<TenantConfigurationsCreateResponse>

delete

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

- Defined in operationsInterfaces/tenantConfigurations.ts:57
Delete the tenant configuration. User has to be a Tenant Admin for this operation.

Parameters
- configurationName: ConfigurationName
  
  The configuration name. Value must be 'default'
- Optional options: TenantConfigurationsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(configurationName: ConfigurationName, options?: TenantConfigurationsGetOptionalParams): Promise<TenantConfigurationsGetResponse>

- Defined in operationsInterfaces/tenantConfigurations.ts:36
Gets the tenant configuration.

Parameters
- configurationName: ConfigurationName
  
  The configuration name. Value must be 'default'
- Optional options: TenantConfigurationsGetOptionalParams
  
  The options parameters.
Returns Promise<TenantConfigurationsGetResponse>

list

list(options?: TenantConfigurationsListOptionalParams): PagedAsyncIterableIterator<Configuration>

- Defined in operationsInterfaces/tenantConfigurations.ts:28
Gets list of the tenant configurations.

Parameters
- Optional options: TenantConfigurationsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Configuration>

Generated using TypeDoc