Share via


az neon postgres endpoint

Note

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

Manage Endpoint.

Commands

Name Description Type Status
az neon postgres endpoint list

List all endpoints in a Neon branch.

Extension GA

az neon postgres endpoint list

List all endpoints in a Neon branch.

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

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-name

Name 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