module Azure::Cosmosdb::Profiles::Latest::Mgmt::Models
Constants
- ARMProxyResource
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
- ARMResourceProperties
The core properties of ARM resources.
- ApiProperties
Model object.
- AutoUpgradePolicyResource
Cosmos DB resource auto-upgrade policy
- AutoscaleSettings
Model object.
- AutoscaleSettingsResource
Cosmos DB provisioned throughput settings object
- AzureEntityResource
The resource model definition for an
Azure
Resource
Manager resource with an etag.- BackupPolicy
The object representing the policy for taking backups on an account.
- BackupPolicyType
Defines values for
BackupPolicyType
- Capability
Cosmos DB capability object
- CassandraKeyspaceCreateUpdateParameters
Parameters to create and update Cosmos DB Cassandra keyspace.
- CassandraKeyspaceGetPropertiesOptions
Model object.
- CassandraKeyspaceGetPropertiesResource
Model object.
- CassandraKeyspaceGetResults
An
Azure
Cosmos DB Cassandra keyspace.- CassandraKeyspaceListResult
The List operation response, that contains the Cassandra keyspaces and their properties.
- CassandraKeyspaceResource
Cosmos DB Cassandra keyspace resource object
- CassandraPartitionKey
Cosmos DB Cassandra table partition key
- CassandraSchema
Cosmos DB Cassandra table schema
- CassandraTableCreateUpdateParameters
Parameters to create and update Cosmos DB Cassandra table.
- CassandraTableGetPropertiesOptions
Model object.
- CassandraTableGetPropertiesResource
Model object.
- CassandraTableGetResults
An
Azure
Cosmos DB Cassandra table.- CassandraTableListResult
The List operation response, that contains the Cassandra tables and their properties.
- CassandraTableResource
Cosmos DB Cassandra table resource object
- ClusterKey
Cosmos DB Cassandra table cluster key
- Column
Cosmos DB Cassandra table column
- CompositePath
Model object.
- CompositePathSortOrder
Defines values for
CompositePathSortOrder
- ConflictResolutionMode
Defines values for
ConflictResolutionMode
- ConflictResolutionPolicy
The conflict resolution policy for the container.
- ConnectorOffer
Defines values for
ConnectorOffer
- ConsistencyPolicy
The consistency policy for the Cosmos DB database account.
- ContainerPartitionKey
The configuration of the partition key to be used for partitioning data into multiple partitions
- ContinuousModeBackupPolicy
The object representing continuous mode backup policy.
- CorsPolicy
The CORS policy for the Cosmos DB database account.
- CreateUpdateOptions
CreateUpdateOptions
are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput”- DataType
Defines values for
DataType
- DatabaseAccountConnectionString
Connection string for the Cosmos DB account
- DatabaseAccountCreateUpdateParameters
Parameters to create and update Cosmos DB database accounts.
- DatabaseAccountGetResults
An
Azure
Cosmos DB database account.- DatabaseAccountKind
Defines values for
DatabaseAccountKind
- DatabaseAccountListConnectionStringsResult
The connection strings for the given database account.
- DatabaseAccountListKeysResult
The access keys for the given database account.
- DatabaseAccountListReadOnlyKeysResult
The read-only access keys for the given database account.
- DatabaseAccountOfferType
Defines values for
DatabaseAccountOfferType
- DatabaseAccountRegenerateKeyParameters
Parameters to regenerate the keys within the database account.
- DatabaseAccountUpdateParameters
Parameters for patching
Azure
Cosmos DB database account properties.- DatabaseAccountsListResult
The List operation response, that contains the database accounts and their properties.
- DefaultConsistencyLevel
Defines values for
DefaultConsistencyLevel
- ErrorResponse
Error Response.
- ErrorResponseUpdatedFormat
An error response from the service.
- ExcludedPath
Model object.
- ExtendedResourceProperties
The system generated resource properties associated with SQL databases, SQL containers, Gremlin databases and Gremlin graphs.
- FailoverPolicies
The list of new failover policies for the failover priority change.
- FailoverPolicy
The failover policy for a given region of a database account.
- GremlinDatabaseCreateUpdateParameters
Parameters to create and update Cosmos DB Gremlin database.
- GremlinDatabaseGetPropertiesOptions
Model object.
- GremlinDatabaseGetPropertiesResource
Model object.
- GremlinDatabaseGetResults
An
Azure
Cosmos DB Gremlin database.- GremlinDatabaseListResult
The List operation response, that contains the Gremlin databases and their properties.
- GremlinDatabaseResource
Cosmos DB Gremlin database resource object
- GremlinGraphCreateUpdateParameters
Parameters to create and update Cosmos DB Gremlin graph.
- GremlinGraphGetPropertiesOptions
Model object.
- GremlinGraphGetPropertiesResource
Model object.
- GremlinGraphGetResults
An
Azure
Cosmos DB Gremlin graph.- GremlinGraphListResult
The List operation response, that contains the graphs and their properties.
- GremlinGraphResource
Cosmos DB Gremlin graph resource object
- IncludedPath
The paths that are included in indexing
- IndexKind
Defines values for
IndexKind
- Indexes
The indexes for the path.
- IndexingMode
Defines values for
IndexingMode
- IndexingPolicy
Cosmos DB indexing policy
- IpAddressOrRange
IpAddressOrRange
object- KeyKind
Defines values for
KeyKind
- Location
A region in which the
Azure
Cosmos DB database account is deployed.- ManagedServiceIdentity
Identity for the resource.
- ManagedServiceIdentityUserAssignedIdentitiesValue
Model object.
- Metric
Metric
data- MetricAvailability
The availability of the metric.
- MetricDefinition
The definition of a metric.
- MetricDefinitionsListResult
The response to a list metric definitions request.
- MetricListResult
The response to a list metrics request.
- MetricName
A metric name.
- MetricValue
Represents metrics values.
- MongoDBCollectionCreateUpdateParameters
Parameters to create and update Cosmos DB MongoDB collection.
- MongoDBCollectionGetPropertiesOptions
Model object.
- MongoDBCollectionGetPropertiesResource
Model object.
- MongoDBCollectionGetResults
An
Azure
Cosmos DB MongoDB collection.- MongoDBCollectionListResult
The List operation response, that contains the MongoDB collections and their properties.
- MongoDBCollectionResource
Cosmos DB MongoDB collection resource object
- MongoDBDatabaseCreateUpdateParameters
Parameters to create and update Cosmos DB MongoDB database.
- MongoDBDatabaseGetPropertiesOptions
Model object.
- MongoDBDatabaseGetPropertiesResource
Model object.
- MongoDBDatabaseGetResults
An
Azure
Cosmos DB MongoDB database.- MongoDBDatabaseListResult
The List operation response, that contains the MongoDB databases and their properties.
- MongoDBDatabaseResource
Cosmos DB MongoDB database resource object
- MongoIndex
Cosmos DB MongoDB collection index key
- MongoIndexKeys
Cosmos DB MongoDB collection resource object
- MongoIndexOptions
Cosmos DB MongoDB collection index options
- NetworkAclBypass
Defines values for
NetworkAclBypass
- NotebookWorkspace
A notebook workspace resource
- NotebookWorkspaceConnectionInfoResult
The connection info for the given notebook workspace
- NotebookWorkspaceCreateUpdateParameters
Parameters to create a notebook workspace resource
- NotebookWorkspaceListResult
A list of notebook workspace resources
- Operation
REST API operation
- OperationDisplay
The object that represents the operation.
- OperationListResult
Result of the request to list
Resource
Provider operations. It contains a list of operations and a URL link to get the next set of results.- OptionsResource
Cosmos DB options resource object
- PartitionKind
Defines values for
PartitionKind
- PartitionMetric
The metric values for a single partition.
- PartitionMetricListResult
The response to a list partition metrics request.
- PartitionUsage
The partition level usage data for a usage request.
- PartitionUsagesResult
The response to a list partition level usage request.
- PercentileMetric
Percentile
Metric
data- PercentileMetricListResult
The response to a list percentile metrics request.
- PercentileMetricValue
Represents percentile metrics values.
- PeriodicModeBackupPolicy
The object representing periodic mode backup policy.
- PeriodicModeProperties
Configuration values for periodic mode backup
- PrimaryAggregationType
Defines values for
PrimaryAggregationType
- PrivateEndpointConnection
A private endpoint connection
- PrivateEndpointConnectionListResult
A list of private endpoint connections
- PrivateEndpointProperty
Private endpoint which the connection belongs to.
- PrivateLinkResource
A private link resource
- PrivateLinkResourceListResult
A list of private link resources
- PrivateLinkServiceConnectionStateProperty
Connection State of the Private Endpoint Connection.
- ProxyResource
The resource model definition for a
Azure
Resource
Manager proxy resource. It will not have tags and a location- PublicNetworkAccess
Defines values for
PublicNetworkAccess
- RegionForOnlineOffline
Cosmos DB region to online or offline.
- Resource
Common fields that are returned in the response for all
Azure
Resource
Manager resources- ResourceIdentityType
Defines values for
ResourceIdentityType
- ServerVersion
Defines values for
ServerVersion
- SpatialSpec
Model object.
- SpatialType
Defines values for
SpatialType
- SqlContainerCreateUpdateParameters
Parameters to create and update Cosmos DB container.
- SqlContainerGetPropertiesOptions
Model object.
- SqlContainerGetPropertiesResource
Model object.
- SqlContainerGetResults
An
Azure
Cosmos DB container.- SqlContainerListResult
The List operation response, that contains the containers and their properties.
- SqlContainerResource
Cosmos DB SQL container resource object
- SqlDatabaseCreateUpdateParameters
Parameters to create and update Cosmos DB SQL database.
- SqlDatabaseGetPropertiesOptions
Model object.
- SqlDatabaseGetPropertiesResource
Model object.
- SqlDatabaseGetResults
An
Azure
Cosmos DB SQL database.- SqlDatabaseListResult
The List operation response, that contains the SQL databases and their properties.
- SqlDatabaseResource
Cosmos DB SQL database resource object
- SqlStoredProcedureCreateUpdateParameters
Parameters to create and update Cosmos DB storedProcedure.
- SqlStoredProcedureGetPropertiesResource
Model object.
- SqlStoredProcedureGetResults
An
Azure
Cosmos DB storedProcedure.- SqlStoredProcedureListResult
The List operation response, that contains the storedProcedures and their properties.
- SqlStoredProcedureResource
Cosmos DB SQL storedProcedure resource object
- SqlTriggerCreateUpdateParameters
Parameters to create and update Cosmos DB trigger.
- SqlTriggerGetPropertiesResource
Model object.
- SqlTriggerGetResults
An
Azure
Cosmos DB trigger.- SqlTriggerListResult
The List operation response, that contains the triggers and their properties.
- SqlTriggerResource
Cosmos DB SQL trigger resource object
- SqlUserDefinedFunctionCreateUpdateParameters
Parameters to create and update Cosmos DB userDefinedFunction.
- SqlUserDefinedFunctionGetPropertiesResource
Model object.
- SqlUserDefinedFunctionGetResults
An
Azure
Cosmos DB userDefinedFunction.- SqlUserDefinedFunctionListResult
The List operation response, that contains the userDefinedFunctions and their properties.
- SqlUserDefinedFunctionResource
Cosmos DB SQL userDefinedFunction resource object
- TableCreateUpdateParameters
Parameters to create and update Cosmos DB Table.
- TableGetPropertiesOptions
Model object.
- TableGetPropertiesResource
Model object.
- TableGetResults
An
Azure
Cosmos DB Table.- TableListResult
The List operation response, that contains the Table and their properties.
- TableResource
Cosmos DB table resource object
- ThroughputPolicyResource
Cosmos DB resource throughput policy
- ThroughputSettingsGetPropertiesResource
Model object.
- ThroughputSettingsGetResults
An
Azure
Cosmos DB resource throughput.- ThroughputSettingsResource
Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.
- ThroughputSettingsUpdateParameters
Parameters to update Cosmos DB resource throughput.
- TrackedResource
The resource model definition for an
Azure
Resource
Manager tracked top level resource which has 'tags' and a 'location'- TriggerOperation
Defines values for
TriggerOperation
- TriggerType
Defines values for
TriggerType
- UniqueKey
The unique key on that enforces uniqueness constraint on documents in the collection in the
Azure
Cosmos DB service.- UniqueKeyPolicy
The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the
Azure
Cosmos DB service.- UnitType
Defines values for
UnitType
- Usage
The usage data for a usage request.
- UsagesResult
The response to a list usage request.
- VirtualNetworkRule
Virtual Network ACL Rule object