Get-OCIRegion

SYNOPSIS

Gets the region object.

SYNTAX

RegionId

Get-OCIRegion -RegionId <String> [-EnableInstanceMetadataService] [<CommonParameters>]

RegionCode

Get-OCIRegion -RegionCode <String> [-EnableInstanceMetadataService] [<CommonParameters>]

DESCRIPTION

Gets the region object corresponding to the region id or region code from the list of regions supported. If no matching region is found, this cmdlet will register a region from the regions config file, the OCI_REGION_METADATA environment variable, or the Instance Metadata Service (if enabled) and return that region.

PARAMETERS

-EnableInstanceMetadataService

Enabling the Instance Metadata Service allows region lookups through the OCI Instance's metadata.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RegionCode

The Region key representing the region. eg) phx

Type: String
Parameter Sets: RegionCode
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RegionId

Region Identifier of the new region. eg) us-phoenix-1

Type: String
Parameter Sets: RegionId
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

OUTPUTS

• Oci.Common.Region

RELATED LINKS

• OCIModulesDocs
• Examples