REST Resource: projects.locations.entitlements

Resource: Entitlement

Details of the Entitlement resource.

JSON representation
{
  "name": string,
  "cloudAccountDetails": {
    object (CloudAccountDetails)
  },
  "entitlementId": string,
  "state": enum (State)
}
Fields
name

string

Identifier. The name of the Entitlement resource with the format: projects/{project}/locations/{region}/entitlements/{entitlement}

cloudAccountDetails

object (CloudAccountDetails)

Details of the OCI Cloud Account.

entitlementId

string

Output only. Google Cloud Marketplace order ID (aka entitlement ID)

state

enum (State)

Output only. Entitlement State.

CloudAccountDetails

Details of the OCI Cloud Account.

JSON representation
{
  "cloudAccount": string,
  "cloudAccountHomeRegion": string,
  "linkExistingAccountUri": string,
  "accountCreationUri": string
}
Fields
cloudAccount

string

Output only. OCI account name.

cloudAccountHomeRegion

string

Output only. OCI account home region.

accountCreationUri

string

Output only. URL to create a new account and link.

State

The various lifecycle states of the subscription.

Enums
STATE_UNSPECIFIED Default unspecified value.
ACCOUNT_NOT_LINKED Account not linked.
ACCOUNT_NOT_ACTIVE Account is linked but not active.
ACTIVE Entitlement and Account are active.

Methods

list

Lists the entitlements in a given project.