Class TenantSettingsClient

Contains methods to access the /tenants/settings endpoints.

public class TenantSettingsClient : BaseClient, ITenantSettingsClient

Inherited Members: BaseClient.Connection

BaseClient.BaseUri

BaseClient.DefaultHeaders

BaseClient.BuildUri(string, IDictionary<string, string>)

BaseClient.EncodePath(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Initializes a new instance of TenantSettingsClient.

public TenantSettingsClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)

connection IManagementConnection: IManagementConnection used to make all API calls.
baseUri Uri: Uri of the endpoint to use in making API calls.
defaultHeaders IDictionary<string, string>: Dictionary containing default headers included with every request this client makes.

Gets the settings for the tenant.

public Task<TenantSettings> GetAsync(string fields = null, bool includeFields = true, CancellationToken cancellationToken = default)

fields string: A comma-separated list of fields to include or exclude (depending on includeFields) from the result, empty to retrieve all fields.
includeFields bool: true if the fields specified are to be included in the result, false otherwise (defaults to true).
cancellationToken CancellationToken: The cancellation token to cancel operation.

Task<TenantSettings>: A TenantSettings containing the settings for the tenant.

Updates the settings for the tenant.

public Task<TenantSettings> UpdateAsync(TenantSettingsUpdateRequest request, CancellationToken cancellationToken = default)

request TenantSettingsUpdateRequest: TenantSettingsUpdateRequest containing the settings for the tenant which are to be updated.
cancellationToken CancellationToken: The cancellation token to cancel operation.

Task<TenantSettings>: A TenantSettings containing the updated settings for the tenant.