list-regions¶

Description¶

Lists the available regions, their display names, availability zones and default region for a given cloud credential. If environment-crn is provided, returns regions available within that environment instead.

Synopsis¶

  list-regions
[--credential <value>]
[--environment-crn <value>]
[--region <value>]
[--platform-variant <value>]
[--availability-zone <value>]
[--availability-zones-needed | --no-availability-zones-needed]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--credential (string)

The name or CRN of the credential. Either this or environment-crn must be provided.

--environment-crn (string)

The CRN of the environment. Either this or credential must be provided.

--region (string)

Filter results to a specific region.

--platform-variant (string)

The variant of the cloud platform.

--availability-zone (string)

The availability zone.

--availability-zones-needed | --no-availability-zones-needed (boolean)

Whether to include availability zone information in the response.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

names -> (array)

The list of available region codes.

item -> (string)

displayNames -> (map)

A mapping of region codes to their human-readable display names.

key -> (string)

value -> (string)

defaultRegion -> (string)

The default region.

availabilityZones -> (array)

The availability zones for each region.

item -> (object)

Availability zones for a specific region.

region -> (string)

The region code.

availabilityZones -> (array)

The list of availability zone names within this region.

item -> (string)

Form Factors¶

public, private