ParameterGroupsOperations interface

Package:

@azure/arm-horizondb

Interface representing a ParameterGroups operations.

Properties

beginCreateOrReplace
beginCreateOrReplaceAndWait
beginDelete
beginDeleteAndWait
beginUpdate
beginUpdateAndWait
createOrReplace	Creates a new HorizonDB parameter group or replaces an existing parameter group.
delete	Deletes a HorizonDB parameter group. Deletion fails with a conflict when the parameter group is associated with one or more pools.
get	Gets information about a HorizonDB parameter group.
listByResourceGroup	Lists all HorizonDB parameter groups in a resource group.
listBySubscription	Lists all HorizonDB parameter groups in a subscription.
listConnections	Gets all connections to a parameter group.
update	Updates an existing HorizonDB parameter group. Each connected pool's applyMethod setting controls whether dynamic parameter changes become effective immediately or remain pending until a customer-initiated pool Restart. Static parameter changes always remain pending until a customer-initiated pool Restart. Stop followed by Start and scheduled maintenance do not apply pending changes. The operation fails with a conflict while a previous update to this parameter group is still being processed.

Property Details

beginCreateOrReplace

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplace: (resourceGroupName: string, parameterGroupName: string, resource: ParameterGroupCreateOrUpdate, options?: ParameterGroupsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<ParameterGroup>, ParameterGroup>>

Property Value

(resourceGroupName: string, parameterGroupName: string, resource: ParameterGroupCreateOrUpdate, options?: ParameterGroupsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<ParameterGroup>, ParameterGroup>>

beginCreateOrReplaceAndWait

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplaceAndWait: (resourceGroupName: string, parameterGroupName: string, resource: ParameterGroupCreateOrUpdate, options?: ParameterGroupsCreateOrReplaceOptionalParams) => Promise<ParameterGroup>

Property Value

(resourceGroupName: string, parameterGroupName: string, resource: ParameterGroupCreateOrUpdate, options?: ParameterGroupsCreateOrReplaceOptionalParams) => Promise<ParameterGroup>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, parameterGroupName: string, options?: ParameterGroupsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, parameterGroupName: string, options?: ParameterGroupsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, parameterGroupName: string, options?: ParameterGroupsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, parameterGroupName: string, options?: ParameterGroupsDeleteOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, parameterGroupName: string, properties: ParameterGroupForPatchUpdateUpdate, options?: ParameterGroupsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ParameterGroup>, ParameterGroup>>

Property Value

(resourceGroupName: string, parameterGroupName: string, properties: ParameterGroupForPatchUpdateUpdate, options?: ParameterGroupsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ParameterGroup>, ParameterGroup>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, parameterGroupName: string, properties: ParameterGroupForPatchUpdateUpdate, options?: ParameterGroupsUpdateOptionalParams) => Promise<ParameterGroup>

Property Value

(resourceGroupName: string, parameterGroupName: string, properties: ParameterGroupForPatchUpdateUpdate, options?: ParameterGroupsUpdateOptionalParams) => Promise<ParameterGroup>

createOrReplace

Creates a new HorizonDB parameter group or replaces an existing parameter group.

createOrReplace: (resourceGroupName: string, parameterGroupName: string, resource: ParameterGroupCreateOrUpdate, options?: ParameterGroupsCreateOrReplaceOptionalParams) => PollerLike<OperationState<ParameterGroup>, ParameterGroup>

Property Value

(resourceGroupName: string, parameterGroupName: string, resource: ParameterGroupCreateOrUpdate, options?: ParameterGroupsCreateOrReplaceOptionalParams) => PollerLike<OperationState<ParameterGroup>, ParameterGroup>

delete

Deletes a HorizonDB parameter group. Deletion fails with a conflict when the parameter group is associated with one or more pools.

delete: (resourceGroupName: string, parameterGroupName: string, options?: ParameterGroupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, parameterGroupName: string, options?: ParameterGroupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets information about a HorizonDB parameter group.

get: (resourceGroupName: string, parameterGroupName: string, options?: ParameterGroupsGetOptionalParams) => Promise<ParameterGroup>

Property Value

(resourceGroupName: string, parameterGroupName: string, options?: ParameterGroupsGetOptionalParams) => Promise<ParameterGroup>

listByResourceGroup

Lists all HorizonDB parameter groups in a resource group.

listByResourceGroup: (resourceGroupName: string, options?: ParameterGroupsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ParameterGroup, ParameterGroup[], PageSettings>

Property Value

(resourceGroupName: string, options?: ParameterGroupsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ParameterGroup, ParameterGroup[], PageSettings>

listBySubscription

Lists all HorizonDB parameter groups in a subscription.

listBySubscription: (options?: ParameterGroupsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ParameterGroup, ParameterGroup[], PageSettings>

Property Value

(options?: ParameterGroupsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ParameterGroup, ParameterGroup[], PageSettings>

listConnections

Gets all connections to a parameter group.

listConnections: (resourceGroupName: string, parameterGroupName: string, options?: ParameterGroupsListConnectionsOptionalParams) => PagedAsyncIterableIterator<ParameterGroupConnectionProperties, ParameterGroupConnectionProperties[], PageSettings>

Property Value

(resourceGroupName: string, parameterGroupName: string, options?: ParameterGroupsListConnectionsOptionalParams) => PagedAsyncIterableIterator<ParameterGroupConnectionProperties, ParameterGroupConnectionProperties[], PageSettings>

update

Updates an existing HorizonDB parameter group. Each connected pool's applyMethod setting controls whether dynamic parameter changes become effective immediately or remain pending until a customer-initiated pool Restart. Static parameter changes always remain pending until a customer-initiated pool Restart. Stop followed by Start and scheduled maintenance do not apply pending changes. The operation fails with a conflict while a previous update to this parameter group is still being processed.

update: (resourceGroupName: string, parameterGroupName: string, properties: ParameterGroupForPatchUpdateUpdate, options?: ParameterGroupsUpdateOptionalParams) => PollerLike<OperationState<ParameterGroup>, ParameterGroup>

Property Value

(resourceGroupName: string, parameterGroupName: string, properties: ParameterGroupForPatchUpdateUpdate, options?: ParameterGroupsUpdateOptionalParams) => PollerLike<OperationState<ParameterGroup>, ParameterGroup>