Create parameter groups in Azure HorizonDB (Preview)

When you create a parameter group, you must provide at least one parameter. The underlying operation in the backend merges your input with the system defaults for the specified pgVersion.

Steps to create parameter groups

Portal

Use the Azure portal:

1. Browse the Azure HorizonDB (Preview) parameter groups.

2. In the command bar, select Create.

   

3. In Create a parameter group, select the subscription and resource group where you want to create the parameter group.

   

4. Enter a name that's unique among all parameter groups in the resource group and subscription. Embed some form of encoded description in the name so that you can later identify the potential target clusters of that configuration.

   

5. Select a location for the parameter group. You can only connect parameter groups created in a location to clusters that also exist in that same location.

   

6. Although not required, provide a description explaining in more detail the purpose of the parameter group configuration. It can also describe the ideal target clusters for which it was conceived.

   

7. Select the version of PostgreSQL for which the parameter group is supported. Parameter groups created for a given version of PostgreSQL can't be applied to clusters of a different version of PostgreSQL.

   

8. Select Next to configure the values of the modifiable parameters whose defaults you want to change in this parameter group.

   

9. Search for the names of the parameters whose default values you want to override, and change their defaults. When finished, select Create.

   

10. A new deployment is initialized to create the parameter group.

    

11. Wait until the deployment completes.

    

12. When the deployment completes, select Go to resource to visit the newly created parameter group.

    

13. You can now inspect all details associated with the newly created parameter group.

    

CLI

To create a parameter group and apply changes immediately, use the az horizondb parameter-group create command.

az horizondb parameter-group create \
  --location <location>
  --resource-group <resource_group>
  --name <parameter_group>
  --version <version>
  --parameters <parameter_name_1=parameter_value_1 parameter_name_2=parameter_value_2... parameter_name_n=parameter_value_n>
  --apply-immediately true
  --description <description>

To create a parameter group and don't apply changes immediately, use the az horizondb parameter-group create command.

az horizondb parameter-group create \
  --location <location>
  --resource-group <resource_group>
  --name <parameter_group>
  --version <version>
  --parameters <parameter_name_1=parameter_value_1 parameter_name_2=parameter_value_2... parameter_name_n=parameter_value_n>
  --description <description>

Possible errors

Error code	Description
ParameterGroupNameConflictsWithDefault	When the name of the parameter group matches any of the names reserved for default parameter groups.
ParameterGroupAlreadyExists	When a parameter group with the same resource identifier already exists.
ParameterGroupPgVersionRequired	When pgVersion isn't included as one of the properties in the input.
ParameterNotRecognized	When one or more parameter names in the input aren't recognized among the ones supported for the version of PostgreSQL for which the parameter group is defined.
ParameterIsReadOnly	When one or more parameters in the input are read-only parameters.
ParameterValueInvalid	When the value assigned to one or more parameters in the input isn't valid according to the data type and allowed values of that parameter.
ParameterGroupParametersRequired	When the input doesn't include any parameter.

Related content

• Parameter groups in Azure HorizonDB (Preview)
• Update parameter groups
• Delete parameter groups
• List parameter groups
• Connect clusters to parameter groups
• List clusters connected to parameter groups
• Identity parameter group connected to a cluster