Share via

az neon postgres neon-role

Note

This reference is part of the neon extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az neon postgres neon-role command. Learn more about extensions.

Manage roles and permissions within Neon Postgres databases.

Commands

Name Description Type Status
az neon postgres neon-role create

Create a NeonRole.

 Extension GA
az neon postgres neon-role delete

Delete a NeonRole.

 Extension GA
az neon postgres neon-role list

List all roles and permissions associated with a specific branch in Neon Postgres.

 Extension GA

az neon postgres neon-role create

Create a NeonRole.

az neon postgres neon-role create --branch-name
                                  --name --neon-role-name
                                  --organization-name
                                  --project-name
                                  --resource-group
                                  [--attributes]
                                  [--branch-id]
                                  [--entity-name]
                                  [--is-super-user {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--permissions]
                                  [--project-id]
                                  [--role-name]

Required Parameters

--branch-name

The name of the Branch.

--name --neon-role-name -n

The name of the NeonRole.

--organization-name

Name of the Neon Organizations resource.

--project-name

The name of the Project.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--attributes

Additional attributes for the entity Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--branch-id

The ID of the branch this role belongs to.

--entity-name

Name of the resource.

Property Value
Parameter group: Properties Arguments
--is-super-user

Indicates whether the role has superuser privileges.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--permissions

Permissions assigned to the role Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--project-id

The ID of the project this role belongs to.

--role-name

Name of the role.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az neon postgres neon-role delete

Delete a NeonRole.

az neon postgres neon-role delete [--branch-name]
                                  [--ids]
                                  [--name --neon-role-name]
                                  [--organization-name]
                                  [--project-name]
                                  [--resource-group]
                                  [--subscription]
                                  [--yes]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--branch-name

The name of the Branch.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--name --neon-role-name -n

The name of the NeonRole.

Property Value
Parameter group: Resource Id Arguments
--organization-name

Name of the Neon Organizations resource.

Property Value
Parameter group: Resource Id Arguments
--project-name

The name of the Project.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az neon postgres neon-role list

List all roles and permissions associated with a specific branch in Neon Postgres.

az neon postgres neon-role list --branch-id
                                --organization-name
                                --project-id
                                --resource-group
                                [--max-items]
                                [--next-token]

Examples

List Neon Roles under a Branch

az neon postgres neon-role list --resource-group rgneon --organization-name org-test-cli --project-id old-frost-16758796 --branch-id br-spring-field-a8vje3tr

Required Parameters

--branch-id

Id of the Neon branch.

--organization-name

Name of the Neon organization. If value is blank it's asked from the tty.

--project-id

Id of the Neon project.

--resource-group -g

Name of the Azure resource group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False