Tenancy

class oci.identity.models.Tenancy(**kwargs)

Bases: object

The root compartment that contains all of your organization’s compartments and other Oracle Cloud Infrastructure cloud resources. When you sign up for Oracle Cloud Infrastructure, Oracle creates a tenancy for your company, which is a secure and isolated partition where you can create, organize, and administer your cloud resources.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Get Started with Policies.

Methods:

__init__(**kwargs)

Initializes a new Tenancy object with values from keyword arguments.

Attributes:

defined_tags

Gets the defined_tags of this Tenancy.

description

Gets the description of this Tenancy.

freeform_tags

Gets the freeform_tags of this Tenancy.

home_region_key

Gets the home_region_key of this Tenancy.

id

Gets the id of this Tenancy.

name

Gets the name of this Tenancy.

upi_idcs_compatibility_layer_endpoint

Gets the upi_idcs_compatibility_layer_endpoint of this Tenancy.

__init__(**kwargs)

Initializes a new Tenancy object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this Tenancy.

  • name (str) – The value to assign to the name property of this Tenancy.

  • description (str) – The value to assign to the description property of this Tenancy.

  • home_region_key (str) – The value to assign to the home_region_key property of this Tenancy.

  • upi_idcs_compatibility_layer_endpoint (str) – The value to assign to the upi_idcs_compatibility_layer_endpoint property of this Tenancy.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Tenancy.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Tenancy.

property defined_tags

Gets the defined_tags of this Tenancy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this Tenancy.

Return type

dict(str, dict(str, object))

property description

Gets the description of this Tenancy. The description of the tenancy.

Returns

The description of this Tenancy.

Return type

str

property freeform_tags

Gets the freeform_tags of this Tenancy. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns

The freeform_tags of this Tenancy.

Return type

dict(str, str)

property home_region_key

Gets the home_region_key of this Tenancy. The region key for the tenancy’s home region. For the full list of supported regions, see Regions and Availability Domains.

Example: PHX

Returns

The home_region_key of this Tenancy.

Return type

str

property id

Gets the id of this Tenancy. The OCID of the tenancy.

Returns

The id of this Tenancy.

Return type

str

property name

Gets the name of this Tenancy. The name of the tenancy.

Returns

The name of this Tenancy.

Return type

str

property upi_idcs_compatibility_layer_endpoint

Gets the upi_idcs_compatibility_layer_endpoint of this Tenancy. Url which refers to the UPI IDCS compatibility layer endpoint configured for this Tenant’s home region.

Returns

The upi_idcs_compatibility_layer_endpoint of this Tenancy.

Return type

str