Skip to content

AzureCosmosNosqlContainer

An Azure Cosmos NoSQL container. Refers to the unit of scalability and the item namespace within a Cosmos NoSQL database. For more info, see https://learn.microsoft.com/en-us/azure/cosmos-nosql/resource-model.

Implements: PolarisHierarchyObject, HierarchyObject, PolarisHierarchySnappable, HierarchySnappable

Fields

Field Type Description
accountName String! Name of the Azure Cosmos NoSQL account that owns the container.
allOrgs [Org!]! Organizations to which this hierarchy object belongs.
allTags [AssignedRscTag!]! RSC tags to which this hierarchy object is assigned.
authorizedOperations [Operation!]! The authorized operations on the object.
autoscaleMaxRuPerSec Int! Ceiling for autoscale throughput, in request units per second. Zero when throughputMode is not autoscale.
backupSetupSourceObject PathNode The object from where the setup for performing backups of the Azure Cosmos NoSQL container is inherited.
cloudNativeId String! Azure resource ID of the Azure Cosmos NoSQL container.
configuredSlaDomain SlaDomain! SLA Domain configured for the hierarchy object.
conflictResolutionMode String! Conflict resolution mode of the container. Examples: LastWriterWins, Custom. Empty when the container reports no conflict resolution policy.
conflictResolutionPath String! Item path compared to resolve conflicts when conflictResolutionMode is LastWriterWins. Example: /_ts.
conflictResolutionProcedure String! Stored procedure that resolves conflicts when conflictResolutionMode is Custom.
containerName String! Name of the Azure Cosmos NoSQL container.
cosmosDbDatabaseId String! Rubrik ID of the Azure Cosmos NoSQL database that owns the container.
databaseName String! Name of the Azure Cosmos NoSQL database that owns the container.
defaultTtlSeconds Int! Time-to-live in seconds applied to items that do not set their own.
effectiveRetentionSlaDomain SlaDomain Effective retention of the SLA Domain of the hierarchy object.
effectiveSlaDomain SlaDomain! Effective SLA Domain of the hierarchy object.
effectiveSlaSourceObject PathNode Path node of the effective SLA Domain source.
excludedPathCount Int! Number of excluded paths in the indexing policy of the container.
id UUID! ID of the hierarchy object.
indexedPathCount Int! Number of included paths in the indexing policy of the container.
indexingMode String! Indexing mode of the container. Examples: consistent, lazy, none.
isIndexingAutomatic Boolean! Specifies whether the container indexes items automatically.
isRelic Boolean! Specifies whether the Azure Cosmos NoSQL container is a relic or not. A container is a relic when it is unprotected or deleted, but the previously taken snapshots of the container continue to exist within the Rubrik ecosystem.
logicalPath [PathNode!]! Sequential list of the logical ancestors of this object.
name String! Name of the hierarchy object.
newestIndexedSnapshot PolarisSnapshot The latest snapshot that is indexed and unexpired, and therefore restorable.
newestSnapshot PolarisSnapshot The most recent snapshot of this workload.
numWorkloadDescendants Int! Number of descendant workloads of this object.
objectBackupWindow ObjectBackupWindowStatus Object-level backup window status of the hierarchy object.
objectPauseStatus ObjectPauseStatus Pause status of the hierarchy object.
objectType HierarchyObjectTypeEnum! Type of this object.
oldestSnapshot PolarisSnapshot The oldest snapshot of this workload.
onDemandSnapshotCount Int! The number of on-demand snapshots.
partitionKeyPath String! Path of the partition key of the container. Example: /customerId.
physicalPath [PathNode!]! Sequential list of the physical ancestors of this object.
region AzureNativeRegion! Azure region where the Azure Cosmos NoSQL container is located.
rscNativeObjectPendingSla CompactSlaDomain SLA Domain assignment which is pending on the Rubrik Security Cloud native objects.
rscPendingObjectPauseAssignment PendingObjectPauseAssignmentStatus Object pause pending assignment details for RSC objects.
securityMetadata SecurityMetadata Security posture metadata.
slaAssignment SlaAssignmentTypeEnum! SLA Domain assignment type for this object.
slaPauseStatus Boolean! Pause status of the effective SLA Domain of the hierarchy object.
snapshotConnection PolarisSnapshotConnection The list of snapshots taken for this workload.
snapshotDistribution SnapshotDistribution! Distribution of the snapshots of the hierarchy object.
snapshotGroupByConnection PolarisSnapshotGroupByConnection Group-by connection for the snapshots of this workload.
snapshotGroupByNewConnection PolarisSnapshotGroupByNewConnection Group-by connection for the snapshots of this workload.
throughputMode AzureCosmosNosqlThroughputMode! How throughput is provisioned for the container.
throughputRuPerSec Int! Provisioned request units per second, at the level named by throughputScope.
throughputScope AzureCosmosNosqlThroughputScope! Level of the Cosmos NoSQL hierarchy that provisions the reported throughput. A container under a shared-throughput database reports the database as the scope.
uniqueKeyCount Int! Number of unique keys in the unique key policy of the container. Zero when the container enforces no uniqueness constraint.
uniqueKeyPaths String! Unique key policy of the container, encoded as a single value. A unique key is itself a list of paths, so the paths within one unique key are joined with a comma and the unique keys are joined with a semicolon. Example: /name/first,/name/last;/email.
workloadSnapshotConnection GenericSnapshotConnection The list of snapshots taken for this workload.

Field Arguments

Field Argument Type Description
newestSnapshot backupLocationId String Filter snapshots by backup location id.
numWorkloadDescendants first Int Returns the first n elements from the list.
numWorkloadDescendants after String Returns the elements in the list that occur after the specified cursor.
numWorkloadDescendants last Int Returns the last n elements from the list.
numWorkloadDescendants before String Returns the elements in the list that occur before the specified cursor.
numWorkloadDescendants objectTypes [ManagedObjectType!] Types of objects to limit the results. If absent, all object types are returned.
oldestSnapshot backupLocationId String Filter snapshots by backup location id.
onDemandSnapshotCount backupLocationId String Filter snapshots by backup location id.
snapshotConnection first Int Returns the first n elements from the list.
snapshotConnection after String Returns the elements in the list that occur after the specified cursor.
snapshotConnection last Int Returns the last n elements from the list.
snapshotConnection before String Returns the elements in the list that occur before the specified cursor.
snapshotConnection filter PolarisSnapshotFilterInput Filter the Rubrik Security Cloud snapshot connection.
snapshotConnection sortBy PolarisSnapshotSortByEnum Sort Rubrik Security Cloud snapshots by field.
snapshotConnection sortOrder SortOrder Sorts the order of results.
snapshotGroupByConnection first Int Returns the first n elements from the list.
snapshotGroupByConnection after String Returns the elements in the list that occur after the specified cursor.
snapshotGroupByConnection last Int Returns the last n elements from the list.
snapshotGroupByConnection before String Returns the elements in the list that occur before the specified cursor.
snapshotGroupByConnection timezoneOffset Float Offset based on the customer timezone.
snapshotGroupByConnection filter PolarisSnapshotFilterInput Filter the Rubrik Security Cloud snapshot connection.
snapshotGroupByConnection groupBy (required) PolarisSnapshotGroupByEnum! Group Rubrik Security Cloud snapshots by field.
snapshotGroupByConnection timezone Timezone Time zone identifier string. For example, 'America/Los_Angeles' is used for the U.S. Pacific Time zone.
snapshotGroupByNewConnection first Int Returns the first n elements from the list.
snapshotGroupByNewConnection after String Returns the elements in the list that occur after the specified cursor.
snapshotGroupByNewConnection last Int Returns the last n elements from the list.
snapshotGroupByNewConnection before String Returns the elements in the list that occur before the specified cursor.
snapshotGroupByNewConnection timezoneOffset Float Offset based on the customer timezone.
snapshotGroupByNewConnection snapshotFilter (required) [PolarisSnapshotFilterNewInput!]! Filter the Rubrik Security Cloud snapshot connection.
snapshotGroupByNewConnection snapshotGroupBy (required) SnapshotGroupByTime! Group Rubrik Security Cloud snapshots by field.
workloadSnapshotConnection first Int Returns the first n elements from the list.
workloadSnapshotConnection after String Returns the elements in the list that occur after the specified cursor.
workloadSnapshotConnection last Int Returns the last n elements from the list.
workloadSnapshotConnection before String Returns the elements in the list that occur before the specified cursor.
workloadSnapshotConnection workloadId (required) String! The FID of the workload.
workloadSnapshotConnection snapshotFilter [SnapshotQueryFilterInput!] Filters for snapshot connection.
workloadSnapshotConnection sortOrder SortOrder Sorts the order of results.
workloadSnapshotConnection sortBy SnapshotQuerySortByField Sorts snapshots by field.
workloadSnapshotConnection timeRange TimeRangeInput Time range input.
workloadSnapshotConnection ignoreActiveWorkloadCheck Boolean Specifies whether to ignore the active workload check.