az postgres flexible-server deploy

Enable and run GitHub Actions workflow for PostgreSQL server.

Commands

Name	Description	Type	Status
az postgres flexible-server deploy run	Run an existing workflow in your github repository.	Core	GA
az postgres flexible-server deploy setup	Create GitHub Actions workflow file for PostgreSQL server.	Core	GA

az postgres flexible-server deploy run

Run an existing workflow in your github repository.

az postgres flexible-server deploy run --action-name
                                       --branch

Examples

Run an existing workflow in your github repository

az postgres flexible-server deploy run --action-name testAction --branch userBranch

Required Parameters

--action-name

The name of the github action.

--branch

The name of the branch you want upload github action file. The default will be your current branch.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az postgres flexible-server deploy setup

Create GitHub Actions workflow file for PostgreSQL server.

az postgres flexible-server deploy setup --admin-password
                                         --admin-user
                                         --repo
                                         --sql-file
                                         [--action-name]
                                         [--allow-push {false, true}]
                                         [--branch]
                                         [--database-name]
                                         [--ids]
                                         [--resource-group]
                                         [--server-name]
                                         [--subscription]

Examples

Create GitHub Actions workflow file for PostgreSQL server.

az postgres flexible-server deploy setup -s testserver -g testGroup -u username -p password --sql-file test.sql --repo username/userRepo -d flexibleserverdb --action-name testAction

Create GitHub Actions workflow file for PostgreSQL server and push it to the remote repository

az postgres flexible-server deploy setup -s testserver -g testGroup -u username -p password --sql-file test.sql --repo username/userRepo -d flexibleserverdb --action-name testAction --branch userBranch --allow-push

Required Parameters

--admin-password -p

The password of the administrator. Minimum 8 characters and maximum 128 characters. Password must contain characters from three of the following categories: English uppercase letters, English lowercase letters, numbers, and non-alphanumeric characters.

--admin-user -u

Administrator username for the server. Once set, it cannot be changed.

--repo

The name of your github username and repository e.g., Azure/azure-cli.

--sql-file

The path of the sql file. The sql file should be already in the repository.

Optional Parameters

--action-name

The name of the github action.

--allow-push

Push the action yml file to the remote repository. The changes will be pushed to origin repository, speicified branch or current branch if not specified.

accepted values: false, true

default value: False

--branch

The name of the branch you want upload github action file. The default will be your current branch.

--database-name -d

The name of the database to be created when provisioning the database server.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--server-name -s

Name of the server. The name can contain only lowercase letters, numbers, and the hyphen (-) character. Minimum 3 characters and maximum 63 characters.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.