Skip to content

managementdashboard.oracle.com/v1beta1

Back to API Reference

APIVersion: managementdashboard.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes managementdashboard.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
ManagementDashboard Namespaced Sample -
ManagementSavedSearch Namespaced Sample -

ManagementDashboard

ManagementDashboard is the Schema for the managementdashboards API.

  • Plural: managementdashboards
  • Scope: Namespaced
  • APIVersion: managementdashboard.oracle.com/v1beta1
  • Sample: Sample (config/samples/managementdashboard_v1beta1_managementdashboard.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ManagementDashboardSpec defines the desired state of ManagementDashboard.

Field Description Type Required Default Enum
compartmentId OCID of the compartment in which the dashboard resides. string Yes - -
dashboardId ID of the dashboard, which must only be provided for Out-of-the-Box (OOB) dashboards. string No - -
dataConfig Array of JSON that contain data source options. list[object (preserves unknown fields)] Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Description of the dashboard. string Yes - -
displayName Display name of the dashboard. string Yes - -
drilldownConfig Drill-down configuration to define the destination of a drill-down action. list[object (preserves unknown fields)] No - -
featuresConfig Contains configuration for enabling features. Unknown nested fields are preserved. object (preserves unknown fields) No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
isFavorite Determines whether the dashboard is set as favorite. boolean Yes - -
isOobDashboard Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified. boolean Yes - -
isShowDescription Determines whether the description of the dashboard is displayed. boolean Yes - -
isShowInHome Determines whether the dashboard will be displayed in Dashboard Home. boolean Yes - -
metadataVersion The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. string Yes - -
nls JSON that contains internationalization options. Unknown nested fields are preserved. object (preserves unknown fields) Yes - -
parametersConfig Defines parameters for the dashboard. list[object (preserves unknown fields)] No - -
providerId ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID. string Yes - -
providerName The user friendly name of the service (for example, Logging Analytics) that owns the dashboard. string Yes - -
providerVersion The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0. string Yes - -
screenImage Screen image of the dashboard. string Yes - -
tiles Array of dashboard tiles. list[object] Yes - -
type Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set. string Yes - -
uiConfig JSON that contains user interface options. Unknown nested fields are preserved. object (preserves unknown fields) Yes - -

Spec.tiles[]

Back to ManagementDashboard spec

ManagementDashboardTile defines nested fields for ManagementDashboard.Tile.

Field Description Type Required Default Enum
column Tile's column number. integer Yes - -
dataConfig It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources. list[object (preserves unknown fields)] Yes - -
description Description of the tile. string No - -
displayName Display name of the saved search. string Yes - -
drilldownConfig Drill-down configuration to define the destination of a drill-down action. Unknown nested fields are preserved. object (preserves unknown fields) Yes - -
height The number of rows the tile occupies. integer Yes - -
nls JSON that contains internationalization options. Unknown nested fields are preserved. object (preserves unknown fields) Yes - -
parametersMap Specifies the saved search parameters values Unknown nested fields are preserved. object (preserves unknown fields) No - -
row Tile's row number. integer Yes - -
savedSearchId ID of the saved search. string Yes - -
state Current state of the saved search. string Yes - -
uiConfig It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization. Unknown nested fields are preserved. object (preserves unknown fields) Yes - -
width The number of columns the tile occupies. integer Yes - -

Status

ManagementDashboardStatus defines the observed state of ManagementDashboard.

Field Description Type Required Default Enum
compartmentId OCID of the compartment in which the dashboard resides. string No - -
createdBy User who created the dashboard. string No - -
dashboardId ID of the dashboard. Same as id. string No - -
dataConfig Array of JSON that contain data source options. list[object (preserves unknown fields)] No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Description of the dashboard. string No - -
displayName Display name of the dashboard. string No - -
drilldownConfig Drill-down configuration to define the destination of a drill-down action. list[object (preserves unknown fields)] No - -
featuresConfig Contains configuration for enabling features. Unknown nested fields are preserved. object (preserves unknown fields) No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id ID of the dashboard. Same as dashboardId. string No - -
isFavorite Determines whether the dashboard is set as favorite. boolean No - -
isOobDashboard Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified. boolean No - -
isShowDescription Determines whether the description of the dashboard is displayed. boolean No - -
isShowInHome Determines whether the dashboard will be displayed in Dashboard Home. boolean No - -
lifecycleState State of dashboard. string No - -
metadataVersion The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. string No - -
nls JSON that contains internationalization options. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parametersConfig Defines parameters for the dashboard. list[object (preserves unknown fields)] No - -
providerId ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID. string No - -
providerName Name of the service (for example, Logging Analytics) that owns the dashboard. string No - -
providerVersion Version of the service that owns the dashboard. string No - -
savedSearches Array of saved searches in the dashboard. list[object] No - -
screenImage Screen image of the dashboard. string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
tiles Array of dashboard tiles. list[object] No - -
timeCreated Date and time the dashboard was created. string No - -
timeUpdated Date and time the dashboard was updated. string No - -
type Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set. string No - -
uiConfig JSON that contains user interface options. Unknown nested fields are preserved. object (preserves unknown fields) No - -
updatedBy User who updated the dashboard. string No - -

Status.savedSearches[]

Back to ManagementDashboard status

ManagementDashboardSavedSearch defines nested fields for ManagementDashboard.SavedSearch.

Field Description Type Required Default Enum
compartmentId OCID of the compartment in which the saved search resides. string No - -
createdBy The principle id of the user that created this saved search. This is automatically managed by the system. In OCI the value is ignored. In EM it can skipped or otherwise it is ignored in both create and update API and system automatically sets its value. string No - -
dataConfig It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources. list[object (preserves unknown fields)] No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Description of the saved search. string No - -
displayName Display name of the saved search. string No - -
drilldownConfig Drill-down configuration to define the destination of a drill-down action. list[object (preserves unknown fields)] No - -
featuresConfig Contains configuration for enabling features. Unknown nested fields are preserved. object (preserves unknown fields) No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id ID of the saved search. string No - -
isOobSavedSearch Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified. boolean No - -
lifecycleState OCI lifecycle status. This is automatically managed by the system. string No - -
metadataVersion The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. string No - -
nls JSON that contains internationalization options. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parametersConfig Defines parameters for the saved search. list[object (preserves unknown fields)] No - -
providerId ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID. string No - -
providerName Name of the service (for example, Logging Analytics) that owns the saved search. string No - -
providerVersion Version of the service that owns this saved search. string No - -
screenImage Screen image of the saved search. string No - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated Date and time the saved search was created. string No - -
timeUpdated Date and time the saved search was updated. string No - -
type Determines how the saved search is displayed in a dashboard. string No - -
uiConfig It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization. Unknown nested fields are preserved. object (preserves unknown fields) No - -
updatedBy The principle id of the user that updated this saved search. string No - -
widgetTemplate The UI template that the saved search uses to render itself. string No - -
widgetVM The View Model that the saved search uses to render itself. string No - -

Status.status

Back to ManagementDashboard status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to ManagementDashboard status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to ManagementDashboard status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to ManagementDashboard status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Status.tiles[]

Back to ManagementDashboard status

ManagementDashboardTile defines nested fields for ManagementDashboard.Tile.

Field Description Type Required Default Enum
column Tile's column number. integer Yes - -
dataConfig It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources. list[object (preserves unknown fields)] Yes - -
description Description of the tile. string No - -
displayName Display name of the saved search. string Yes - -
drilldownConfig Drill-down configuration to define the destination of a drill-down action. Unknown nested fields are preserved. object (preserves unknown fields) Yes - -
height The number of rows the tile occupies. integer Yes - -
nls JSON that contains internationalization options. Unknown nested fields are preserved. object (preserves unknown fields) Yes - -
parametersMap Specifies the saved search parameters values Unknown nested fields are preserved. object (preserves unknown fields) No - -
row Tile's row number. integer Yes - -
savedSearchId ID of the saved search. string Yes - -
state Current state of the saved search. string Yes - -
uiConfig It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization. Unknown nested fields are preserved. object (preserves unknown fields) Yes - -
width The number of columns the tile occupies. integer Yes - -

ManagementSavedSearch

ManagementSavedSearch is the Schema for the managementsavedsearches API.

  • Plural: managementsavedsearches
  • Scope: Namespaced
  • APIVersion: managementdashboard.oracle.com/v1beta1
  • Sample: Sample (config/samples/managementdashboard_v1beta1_managementsavedsearch.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ManagementSavedSearchSpec defines the desired state of ManagementSavedSearch.

Field Description Type Required Default Enum
compartmentId OCID of the compartment in which the saved search resides. string Yes - -
dataConfig It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources. list[object (preserves unknown fields)] Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Description of the saved search. string Yes - -
displayName Display name of the saved search. string Yes - -
drilldownConfig Drill-down configuration to define the destination of a drill-down action. list[object (preserves unknown fields)] No - -
featuresConfig Contains configuration for enabling features. Unknown nested fields are preserved. object (preserves unknown fields) No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id ID of the saved search, which must only be provided for Out-of-the-Box (OOB) saved search. string No - -
isOobSavedSearch Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified. boolean Yes - -
metadataVersion The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. string Yes - -
nls JSON that contains internationalization options. Unknown nested fields are preserved. object (preserves unknown fields) Yes - -
parametersConfig Defines parameters for the saved search. list[object (preserves unknown fields)] No - -
providerId ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID. string Yes - -
providerName The user friendly name of the service (for example, Logging Analytics) that owns the saved search. string Yes - -
providerVersion The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0. string Yes - -
screenImage Screen image of the saved search. string Yes - -
type Determines how the saved search is displayed in a dashboard. string Yes - -
uiConfig It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization. Unknown nested fields are preserved. object (preserves unknown fields) Yes - -
widgetTemplate The UI template that the saved search uses to render itself. string Yes - -
widgetVM The View Model that the saved search uses to render itself. string Yes - -

Status

ManagementSavedSearchStatus defines the observed state of ManagementSavedSearch.

Field Description Type Required Default Enum
compartmentId OCID of the compartment in which the saved search resides. string No - -
createdBy The principle id of the user that created this saved search. This is automatically managed by the system. In OCI the value is ignored. In EM it can skipped or otherwise it is ignored in both create and update API and system automatically sets its value. string No - -
dataConfig It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources. list[object (preserves unknown fields)] No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description Description of the saved search. string No - -
displayName Display name of the saved search. string No - -
drilldownConfig Drill-down configuration to define the destination of a drill-down action. list[object (preserves unknown fields)] No - -
featuresConfig Contains configuration for enabling features. Unknown nested fields are preserved. object (preserves unknown fields) No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id ID of the saved search. string No - -
isOobSavedSearch Determines whether the saved search is an Out-of-the-Box (OOB) saved search. Note that OOB saved searches are only provided by Oracle and cannot be modified. boolean No - -
lifecycleState OCI lifecycle status. This is automatically managed by the system. string No - -
metadataVersion The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0. string No - -
nls JSON that contains internationalization options. Unknown nested fields are preserved. object (preserves unknown fields) No - -
parametersConfig Defines parameters for the saved search. list[object (preserves unknown fields)] No - -
providerId ID of the service (for example log-analytics) that owns the saved search. Each service has a unique ID. string No - -
providerName Name of the service (for example, Logging Analytics) that owns the saved search. string No - -
providerVersion Version of the service that owns this saved search. string No - -
screenImage Screen image of the saved search. string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated Date and time the saved search was created. string No - -
timeUpdated Date and time the saved search was updated. string No - -
type Determines how the saved search is displayed in a dashboard. string No - -
uiConfig It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization. Unknown nested fields are preserved. object (preserves unknown fields) No - -
updatedBy The principle id of the user that updated this saved search. string No - -
widgetTemplate The UI template that the saved search uses to render itself. string No - -
widgetVM The View Model that the saved search uses to render itself. string No - -

Status.status

Back to ManagementSavedSearch status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to ManagementSavedSearch status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to ManagementSavedSearch status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to ManagementSavedSearch status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -