Share via

HierarchySettingsOperations interface

  • Reference
Package:
@azure/arm-managementgroups

Interface representing a HierarchySettingsOperations.

Methods

createOrUpdate(string, CreateOrUpdateSettingsRequest, HierarchySettingsCreateOrUpdateOptionalParams)

Creates or updates the hierarchy settings defined at the Management Group level.
delete(string, HierarchySettingsDeleteOptionalParams)

Deletes the hierarchy settings defined at the Management Group level.
get(string, HierarchySettingsGetOptionalParams)

Gets the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.
list(string, HierarchySettingsListOptionalParams)

Gets all the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.
update(string, CreateOrUpdateSettingsRequest, HierarchySettingsUpdateOptionalParams)

Updates the hierarchy settings defined at the Management Group level.

Method Details

createOrUpdate(string, CreateOrUpdateSettingsRequest, HierarchySettingsCreateOrUpdateOptionalParams)

Creates or updates the hierarchy settings defined at the Management Group level.

function createOrUpdate(groupId: string, createTenantSettingsRequest: CreateOrUpdateSettingsRequest, options?: HierarchySettingsCreateOrUpdateOptionalParams): Promise<HierarchySettings>

Parameters

groupId

string

Management Group ID.

createTenantSettingsRequest
CreateOrUpdateSettingsRequest

Tenant level settings request parameter.

options
HierarchySettingsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<HierarchySettings>

delete(string, HierarchySettingsDeleteOptionalParams)

Deletes the hierarchy settings defined at the Management Group level.

function delete(groupId: string, options?: HierarchySettingsDeleteOptionalParams): Promise<void>

Parameters

groupId

string

Management Group ID.

options
HierarchySettingsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, HierarchySettingsGetOptionalParams)

Gets the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.

function get(groupId: string, options?: HierarchySettingsGetOptionalParams): Promise<HierarchySettings>

Parameters

groupId

string

Management Group ID.

options
HierarchySettingsGetOptionalParams

The options parameters.

Returns

Promise<HierarchySettings>

list(string, HierarchySettingsListOptionalParams)

Gets all the hierarchy settings defined at the Management Group level. Settings can only be set on the root Management Group of the hierarchy.

function list(groupId: string, options?: HierarchySettingsListOptionalParams): Promise<HierarchySettingsList>

Parameters

groupId

string

Management Group ID.

options
HierarchySettingsListOptionalParams

The options parameters.

Returns

Promise<HierarchySettingsList>

update(string, CreateOrUpdateSettingsRequest, HierarchySettingsUpdateOptionalParams)

Updates the hierarchy settings defined at the Management Group level.

function update(groupId: string, createTenantSettingsRequest: CreateOrUpdateSettingsRequest, options?: HierarchySettingsUpdateOptionalParams): Promise<HierarchySettings>

Parameters

groupId

string

Management Group ID.

createTenantSettingsRequest
CreateOrUpdateSettingsRequest

Tenant level settings request parameter.

options
HierarchySettingsUpdateOptionalParams

The options parameters.

Returns

Promise<HierarchySettings>