Class Region

Class containing all of the known Regions that can be contacted.
Note, not all services may be available in all regions.

Inheritance

object

Region

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.Common

Assembly: OCI.DotNetSDK.Common.dll

Syntax

public class Region

Fields

AF_JOHANNESBURG_1

Declaration

public static readonly Region AF_JOHANNESBURG_1

Field Value

Type	Description
Region

AP_CHIYODA_1

Declaration

public static readonly Region AP_CHIYODA_1

Field Value

Type	Description
Region

AP_CHUNCHEON_1

Declaration

public static readonly Region AP_CHUNCHEON_1

Field Value

Type	Description
Region

AP_CHUNCHEON_2

Declaration

public static readonly Region AP_CHUNCHEON_2

Field Value

Type	Description
Region

AP_DCC_CANBERRA_1

Declaration

public static readonly Region AP_DCC_CANBERRA_1

Field Value

Type	Description
Region

AP_DCC_GAZIPUR_1

Declaration

public static readonly Region AP_DCC_GAZIPUR_1

Field Value

Type	Description
Region

AP_HYDERABAD_1

Declaration

public static readonly Region AP_HYDERABAD_1

Field Value

Type	Description
Region

AP_IBARAKI_1

Declaration

public static readonly Region AP_IBARAKI_1

Field Value

Type	Description
Region

AP_MELBOURNE_1

Declaration

public static readonly Region AP_MELBOURNE_1

Field Value

Type	Description
Region

AP_MUMBAI_1

Declaration

public static readonly Region AP_MUMBAI_1

Field Value

Type	Description
Region

AP_OSAKA_1

Declaration

public static readonly Region AP_OSAKA_1

Field Value

Type	Description
Region

AP_SEOUL_1

Declaration

public static readonly Region AP_SEOUL_1

Field Value

Type	Description
Region

AP_SEOUL_2

Declaration

public static readonly Region AP_SEOUL_2

Field Value

Type	Description
Region

AP_SINGAPORE_1

Declaration

public static readonly Region AP_SINGAPORE_1

Field Value

Type	Description
Region

AP_SINGAPORE_2

Declaration

public static readonly Region AP_SINGAPORE_2

Field Value

Type	Description
Region

AP_SUWON_1

Declaration

public static readonly Region AP_SUWON_1

Field Value

Type	Description
Region

AP_SYDNEY_1

Declaration

public static readonly Region AP_SYDNEY_1

Field Value

Type	Description
Region

AP_TOKYO_1

Declaration

public static readonly Region AP_TOKYO_1

Field Value

Type	Description
Region

CA_MONTREAL_1

Declaration

public static readonly Region CA_MONTREAL_1

Field Value

Type	Description
Region

CA_TORONTO_1

Declaration

public static readonly Region CA_TORONTO_1

Field Value

Type	Description
Region

DefaultRealmFromEnvironmentVariable

Declaration

public static volatile string DefaultRealmFromEnvironmentVariable

Field Value

Type	Description
string

EU_AMSTERDAM_1

Declaration

public static readonly Region EU_AMSTERDAM_1

Field Value

Type	Description
Region

EU_CRISSIER_1

Declaration

public static readonly Region EU_CRISSIER_1

Field Value

Type	Description
Region

EU_DCC_DUBLIN_1

Declaration

public static readonly Region EU_DCC_DUBLIN_1

Field Value

Type	Description
Region

EU_DCC_DUBLIN_2

Declaration

public static readonly Region EU_DCC_DUBLIN_2

Field Value

Type	Description
Region

EU_DCC_MILAN_1

Declaration

public static readonly Region EU_DCC_MILAN_1

Field Value

Type	Description
Region

EU_DCC_MILAN_2

Declaration

public static readonly Region EU_DCC_MILAN_2

Field Value

Type	Description
Region

EU_DCC_RATING_1

Declaration

public static readonly Region EU_DCC_RATING_1

Field Value

Type	Description
Region

EU_DCC_RATING_2

Declaration

public static readonly Region EU_DCC_RATING_2

Field Value

Type	Description
Region

EU_DCC_ZURICH_1

Declaration

public static readonly Region EU_DCC_ZURICH_1

Field Value

Type	Description
Region

EU_FRANKFURT_1

Declaration

public static readonly Region EU_FRANKFURT_1

Field Value

Type	Description
Region

EU_FRANKFURT_2

Declaration

public static readonly Region EU_FRANKFURT_2

Field Value

Type	Description
Region

EU_JOVANOVAC_1

Declaration

public static readonly Region EU_JOVANOVAC_1

Field Value

Type	Description
Region

EU_MADRID_1

Declaration

public static readonly Region EU_MADRID_1

Field Value

Type	Description
Region

EU_MADRID_2

Declaration

public static readonly Region EU_MADRID_2

Field Value

Type	Description
Region

EU_MARSEILLE_1

Declaration

public static readonly Region EU_MARSEILLE_1

Field Value

Type	Description
Region

EU_MILAN_1

Declaration

public static readonly Region EU_MILAN_1

Field Value

Type	Description
Region

EU_PARIS_1

Declaration

public static readonly Region EU_PARIS_1

Field Value

Type	Description
Region

EU_STOCKHOLM_1

Declaration

public static readonly Region EU_STOCKHOLM_1

Field Value

Type	Description
Region

EU_ZURICH_1

Declaration

public static readonly Region EU_ZURICH_1

Field Value

Type	Description
Region

IL_JERUSALEM_1

Declaration

public static readonly Region IL_JERUSALEM_1

Field Value

Type	Description
Region

ME_ABUDHABI_1

Declaration

public static readonly Region ME_ABUDHABI_1

Field Value

Type	Description
Region

ME_ABUDHABI_2

Declaration

public static readonly Region ME_ABUDHABI_2

Field Value

Type	Description
Region

ME_ABUDHABI_3

Declaration

public static readonly Region ME_ABUDHABI_3

Field Value

Type	Description
Region

ME_ABUDHABI_4

Declaration

public static readonly Region ME_ABUDHABI_4

Field Value

Type	Description
Region

ME_ALAIN_1

Declaration

public static readonly Region ME_ALAIN_1

Field Value

Type	Description
Region

ME_DCC_DOHA_1

Declaration

public static readonly Region ME_DCC_DOHA_1

Field Value

Type	Description
Region

ME_DCC_MUSCAT_1

Declaration

public static readonly Region ME_DCC_MUSCAT_1

Field Value

Type	Description
Region

ME_DUBAI_1

Declaration

public static readonly Region ME_DUBAI_1

Field Value

Type	Description
Region

ME_JEDDAH_1

Declaration

public static readonly Region ME_JEDDAH_1

Field Value

Type	Description
Region

ME_RIYADH_1

Declaration

public static readonly Region ME_RIYADH_1

Field Value

Type	Description
Region

MX_MONTERREY_1

Declaration

public static readonly Region MX_MONTERREY_1

Field Value

Type	Description
Region

MX_QUERETARO_1

Declaration

public static readonly Region MX_QUERETARO_1

Field Value

Type	Description
Region

SA_BOGOTA_1

Declaration

public static readonly Region SA_BOGOTA_1

Field Value

Type	Description
Region

SA_SANTIAGO_1

Declaration

public static readonly Region SA_SANTIAGO_1

Field Value

Type	Description
Region

SA_SAOPAULO_1

Declaration

public static readonly Region SA_SAOPAULO_1

Field Value

Type	Description
Region

SA_VALPARAISO_1

Declaration

public static readonly Region SA_VALPARAISO_1

Field Value

Type	Description
Region

SA_VINHEDO_1

Declaration

public static readonly Region SA_VINHEDO_1

Field Value

Type	Description
Region

UK_CARDIFF_1

Declaration

public static readonly Region UK_CARDIFF_1

Field Value

Type	Description
Region

UK_GOV_CARDIFF_1

Declaration

public static readonly Region UK_GOV_CARDIFF_1

Field Value

Type	Description
Region

UK_GOV_LONDON_1

Declaration

public static readonly Region UK_GOV_LONDON_1

Field Value

Type	Description
Region

UK_LONDON_1

Declaration

public static readonly Region UK_LONDON_1

Field Value

Type	Description
Region

US_ASHBURN_1

Declaration

public static readonly Region US_ASHBURN_1

Field Value

Type	Description
Region

US_CHICAGO_1

Declaration

public static readonly Region US_CHICAGO_1

Field Value

Type	Description
Region

US_GOV_ASHBURN_1

Declaration

public static readonly Region US_GOV_ASHBURN_1

Field Value

Type	Description
Region

US_GOV_CHICAGO_1

Declaration

public static readonly Region US_GOV_CHICAGO_1

Field Value

Type	Description
Region

US_GOV_PHOENIX_1

Declaration

public static readonly Region US_GOV_PHOENIX_1

Field Value

Type	Description
Region

US_LANGLEY_1

Declaration

public static readonly Region US_LANGLEY_1

Field Value

Type	Description
Region

US_LUKE_1

Declaration

public static readonly Region US_LUKE_1

Field Value

Type	Description
Region

US_PHOENIX_1

Declaration

public static readonly Region US_PHOENIX_1

Field Value

Type	Description
Region

US_SALTLAKE_2

Declaration

public static readonly Region US_SALTLAKE_2

Field Value

Type	Description
Region

US_SANJOSE_1

Declaration

public static readonly Region US_SANJOSE_1

Field Value

Type	Description
Region

US_SOMERSET_1

Declaration

public static readonly Region US_SOMERSET_1

Field Value

Type	Description
Region

US_THAMES_1

Declaration

public static readonly Region US_THAMES_1

Field Value

Type	Description
Region

logger

Declaration

protected static Logger logger

Field Value

Type	Description
Logger

Properties

Realm

The realm this region belongs to.

Declaration

public Realm Realm { get; }

Property Value

Type	Description
Realm

RegionCode

The region key as defined in https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm

Declaration

public string RegionCode { get; }

Property Value

Type	Description
string

RegionId

The region identifier as defined in https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm

Declaration

public string RegionId { get; }

Property Value

Type	Description
string

Methods

EnableInstanceMetadataService()

Enables contact to IMDS (Instance Metadata Service, only available on OCI instances) if user decides to opt-in

Declaration

public static void EnableInstanceMetadataService()

FormatDefaultRegionEndpoint(Service, Region)

Creates a default endpoint URL for the given service in the given region.
Note, the region is not validated against known regions, this just creates a URL that follows the default format.

Declaration

public static string FormatDefaultRegionEndpoint(Service service, Region region)

Parameters

Type	Name	Description
Service	service	The service.
Region	region	The region.

Returns

Type	Description
string	The endpoint constructed from the service and region.

FormatDefaultRegionEndpoint(Service, string)

Creates a default endpoint URL for the given service in the given region.
Note, the regionId is not validated against known regions, this just creates a URL that follows the default format.

Declaration

public static string FormatDefaultRegionEndpoint(Service service, string regionId)

Parameters

Type	Name	Description
Service	service	The service.
string	regionId	The region.

Returns

Type	Description
string	The endpoint constructed from the service and region.

FromRegionCodeOrId(string)

Returns the Region object from the canonical public region id or region code.

Declaration

public static Region FromRegionCodeOrId(string regionCodeOrId)

Parameters

Type	Name	Description
string	regionCodeOrId	The region id or region code.

Returns

Type	Description
Region	The region object.

FromRegionId(string)

Returns the Region object from the canonical public region id.

Declaration

public static Region FromRegionId(string regionId)

Parameters

Type	Name	Description
string	regionId	The region id.

Returns

Type	Description
Region	The region object.

GetEndpoint(Service)

Resolves a service name to its endpoint in the region, if available.

Declaration

public string GetEndpoint(Service service)

Parameters

Type	Name	Description
Service	service	The service.

Returns

Type	Description
string	The endpoint for the given service, or empty if the service endpoint is not known.

GetRegionSchemaFromInstanceMetaDataService()

Send request to IMDS (Instance Metadata Service, only available on OCI instances)

Declaration

public static RegionSchema GetRegionSchemaFromInstanceMetaDataService()

Returns

Type	Description
RegionSchema	RegionSchema extracted from the IMDS

Register(string, Realm, bool)

Declaration

public static Region Register(string regionId, Realm realm, bool isDeveloperToolConfigRegion = false)

Parameters

Type	Name	Description
string	regionId	The region id.
Realm	realm	The realm of the new region.
bool	isDeveloperToolConfigRegion	The bool value denoting if region to be registered is an DeveloperToolConfig Region or not. Set to false by default for OCI regions.

Returns

Type	Description
Region	The registered region (or existing one if found).

Register(string, Realm, string, bool)

Declaration

public static Region Register(string regionId, Realm realm, string regionCode, bool isDeveloperToolConfig = false)

Parameters

Type	Name	Description
string	regionId	The region id.
Realm	realm	The realm of the new region.
string	regionCode	The 3-letter region code.
bool	isDeveloperToolConfig	The bool value denoting if region to be registered is an DeveloperToolConfig Region or not. Set to false by default for OCI regions

Returns

Type	Description
Region	The registered region (or existing one if found).

RegisterRegionFromInstanceMetadataService()

Calls GetRegionSchemaFromInstanceMetaDataService , only available on OCI instances), registers region

Declaration

public static Region RegisterRegionFromInstanceMetadataService()

Returns

Type	Description
Region	Returns Region registered from InstanceMetadataServiceResponse

ResetConfigFileInUse()

Resets the HasUsedConfigFile check for reading Region Metadata from region config file

Declaration

public static void ResetConfigFileInUse()

ResetDeveloperToolConfig()

Resets the HasUsedDeveloperToolConfigFile check for reading DeveloperToolConfig from DeveloperToolConfigFile

Declaration

public static void ResetDeveloperToolConfig()

ResetEnvironmentVariableInUse()

Resets the HasUsedEnvVar check for Region Metadata

Declaration

public static void ResetEnvironmentVariableInUse()

SkipInstanceMetadataService()

Instructs the SDK to not contact the IMDS (Instance Metadata Service, only available on OCI instances).

Declaration

public static void SkipInstanceMetadataService()

Values()

Return all known Regions in this version of the SDK.

Declaration

public static Region[] Values()

Returns

Type	Description
Region[]	All known regions.