tenancies
Creates, updates, deletes, gets or lists a tenancies resource.
Overview​
| Name | tenancies |
| Type | Resource |
| Id | oci.identity.tenancies |
Fields​
The following fields are returned by SELECT queries:
- get
The tenancy was retrieved.
| Name | Datatype | Description |
|---|---|---|
id | string | The OCID of the tenancy. |
name | string | The name of the tenancy. |
definedTags | object | Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
description | string | The description of the tenancy. |
freeformTags | object | 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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
homeRegionKey | string | The region key for the tenancy's home region. For the full list of supported regions, see [Regions and Availability Domains](/Content/General/Concepts/regions.htm). Example: PHX |
upiIdcsCompatibilityLayerEndpoint | string | Url which refers to the UPI IDCS compatibility layer endpoint configured for this Tenant's home region. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | tenancyId, region | Get the specified tenancy's information. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
tenancyId | string | The OCID of the tenancy. |
SELECT examples​
- get
Get the specified tenancy's information.
SELECT
id,
name,
definedTags,
description,
freeformTags,
homeRegionKey,
upiIdcsCompatibilityLayerEndpoint
FROM oci.identity.tenancies
WHERE tenancyId = '{{ tenancyId }}' -- required
AND region = '{{ region }}' -- required
;