Aracılığıyla paylaş


Azure.ResourceManager.CosmosDB.Models Namespace

Classes

AccessRule

Access rule in a network security perimeter configuration profile.

AccessRuleProperties

Properties of Access Rule.

ArmCosmosDBModelFactory

Model factory for models.

AuthenticationMethodLdapProperties

Ldap authentication method properties. This feature is in preview.

AutoscaleSettingsResourceInfo

Cosmos DB provisioned throughput settings object.

AzureBlobDataTransferDataSourceSink

An Azure Blob Storage data source/sink.

BackupPolicyMigrationState

The object representing the state of the migration between the backup policies.

BaseCosmosDataTransferDataSourceSink

A base CosmosDB data source/sink Please note BaseCosmosDataTransferDataSourceSink is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include CosmosCassandraDataTransferDataSourceSink, CosmosMongoDataTransferDataSourceSink and CosmosSqlDataTransferDataSourceSink.

CapacityModeChangeTransitionState

The transition state information related capacity mode change with update request.

CassandraCertificate

The CassandraCertificate.

CassandraClusterBackupResourceInfo

A restorable backup of a Cassandra cluster.

CassandraClusterBackupSchedule

The CassandraClusterBackupSchedule.

CassandraClusterCommand

resource representing a command.

CassandraClusterDataCenterNodeItem

The CassandraClusterDataCenterNodeItem.

CassandraClusterKey

Cosmos DB Cassandra table cluster key.

CassandraClusterProperties

Properties of a managed Cassandra cluster.

CassandraClusterPublicStatus

Properties of a managed Cassandra cluster public status.

CassandraClusterPublicStatusDataCentersItem

The CassandraClusterPublicStatusDataCentersItem.

CassandraColumn

Cosmos DB Cassandra table column.

CassandraCommandOutput

Response of /command api.

CassandraCommandPostBody

Specification of which command to run where.

CassandraConnectionError

The CassandraConnectionError.

CassandraDataCenterProperties

Properties of a managed Cassandra data center.

CassandraDataCenterSeedNode

The CassandraDataCenterSeedNode.

CassandraError

The CassandraError.

CassandraKeyspaceCreateOrUpdateContent

Parameters to create and update Cosmos DB Cassandra keyspace.

CassandraKeyspacePropertiesConfig

The CassandraKeyspacePropertiesConfig.

CassandraKeyspaceResourceInfo

Cosmos DB Cassandra keyspace resource object.

CassandraPartitionKey

Cosmos DB Cassandra table partition key.

CassandraReaperStatus

The CassandraReaperStatus.

CassandraSchema

Cosmos DB Cassandra table schema.

CassandraTableCreateOrUpdateContent

Parameters to create and update Cosmos DB Cassandra table.

CassandraTablePropertiesConfig

The CassandraTablePropertiesConfig.

CassandraTableResourceInfo

Cosmos DB Cassandra table resource object.

CassandraViewGetPropertiesOptions

The CassandraViewGetPropertiesOptions.

CassandraViewGetPropertiesResource

The CassandraViewGetPropertiesResource.

CassandraViewGetResultCreateOrUpdateContent

Parameters to create and update Cosmos DB Cassandra view.

CassandraViewResource

Cosmos DB Cassandra view resource object.

ComputedProperty

The definition of a computed property.

ConflictResolutionPolicy

The conflict resolution policy for the container.

ConsistencyPolicy

The consistency policy for the Cosmos DB database account.

ContinuousBackupRestoreLocation

Properties of the regional restorable account.

ContinuousModeBackupPolicy

The object representing continuous mode backup policy.

CosmosCassandraDataTransferDataSourceSink

A CosmosDB Cassandra API data source/sink.

CosmosDBAccountBackupPolicy

The object representing the policy for taking backups on an account. Please note CosmosDBAccountBackupPolicy is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ContinuousModeBackupPolicy and PeriodicModeBackupPolicy.

CosmosDBAccountCapability

Cosmos DB capability object.

CosmosDBAccountConnectionString

Connection string for the Cosmos DB account.

CosmosDBAccountCorsPolicy

The CORS policy for the Cosmos DB database account.

CosmosDBAccountCreateOrUpdateContent

Parameters to create and update Cosmos DB database accounts.

CosmosDBAccountKeyList

The access keys for the given database account.

CosmosDBAccountLocation

A region in which the Azure Cosmos DB database account is deployed.

CosmosDBAccountPatch

Parameters for patching Azure Cosmos DB database account properties.

CosmosDBAccountReadOnlyKeyList

The read-only access keys for the given database account.

CosmosDBAccountRegenerateKeyContent

Parameters to regenerate the keys within the database account.

CosmosDBAccountRestoreParameters

Parameters to indicate the information about the restore.

CosmosDBBackupInformation

Backup information of a resource.

CosmosDBBaseConfig

Cosmos DB options resource object.

CosmosDBBaseMetric

Metric data.

CosmosDBBaseUsage

The usage data for a usage request.

CosmosDBClientEncryptionIncludedPath

.

CosmosDBClientEncryptionPolicy

Cosmos DB client encryption policy.

CosmosDBCompositePath

The CosmosDBCompositePath.

CosmosDBContainerPartitionKey

The configuration of the partition key to be used for partitioning data into multiple partitions.

CosmosDBCreateUpdateConfig

CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are "If-Match", "If-None-Match", "Session-Token" and "Throughput".

CosmosDBErrorResult

Error Response.

CosmosDBExcludedPath

The CosmosDBExcludedPath.

CosmosDBFailoverPolicies

The list of new failover policies for the failover priority change.

CosmosDBFailoverPolicy

The failover policy for a given region of a database account.

CosmosDBIncludedPath

The paths that are included in indexing.

CosmosDBIndexingPolicy

Cosmos DB indexing policy.

CosmosDBIPAddressOrRange

IpAddressOrRange object.

CosmosDBKeyWrapMetadata

Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key.

CosmosDBLocationProperties

Cosmos DB location metadata.

CosmosDBMetricAvailability

The availability of the metric.

CosmosDBMetricDefinition

The definition of a metric.

CosmosDBMetricName

A metric name.

CosmosDBMetricValue

Represents metrics values.

CosmosDBPathIndexes

The indexes for the path.

CosmosDBPercentileMetric

Percentile Metric data.

CosmosDBPrivateLinkServiceConnectionStateProperty

Connection State of the Private Endpoint Connection.

CosmosDBRegionalService

Resource for a regional service location.

CosmosDBServiceCreateOrUpdateContent

Parameters for Create or Update request for ServiceResource.

CosmosDBServiceProperties

Services response resource. Please note CosmosDBServiceProperties is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include DataTransferServiceProperties, GraphApiComputeServiceProperties, MaterializedViewsBuilderServiceProperties and SqlDedicatedGatewayServiceProperties.

CosmosDBSqlClientEncryptionKeyCreateOrUpdateContent

Parameters to create and update ClientEncryptionKey.

CosmosDBSqlClientEncryptionKeyProperties

The CosmosDBSqlClientEncryptionKeyProperties.

CosmosDBSqlClientEncryptionKeyResourceInfo

Cosmos DB client encryption key resource object.

CosmosDBSqlContainerCreateOrUpdateContent

Parameters to create and update Cosmos DB container.

CosmosDBSqlContainerPropertiesConfig

The CosmosDBSqlContainerPropertiesConfig.

CosmosDBSqlContainerResourceInfo

Cosmos DB SQL container resource object.

CosmosDBSqlDatabaseCreateOrUpdateContent

Parameters to create and update Cosmos DB SQL database.

CosmosDBSqlDatabasePropertiesConfig

The CosmosDBSqlDatabasePropertiesConfig.

CosmosDBSqlDatabaseResourceInfo

Cosmos DB SQL database resource object.

CosmosDBSqlRoleAssignmentCreateOrUpdateContent

Parameters to create and update an Azure Cosmos DB SQL Role Assignment.

CosmosDBSqlRoleDefinitionCreateOrUpdateContent

Parameters to create and update an Azure Cosmos DB SQL Role Definition.

CosmosDBSqlRolePermission

The set of data plane operations permitted through this Role Definition.

CosmosDBSqlStoredProcedureCreateOrUpdateContent

Parameters to create and update Cosmos DB storedProcedure.

CosmosDBSqlStoredProcedureResourceInfo

Cosmos DB SQL storedProcedure resource object.

CosmosDBSqlTriggerCreateOrUpdateContent

Parameters to create and update Cosmos DB trigger.

CosmosDBSqlTriggerResourceInfo

Cosmos DB SQL trigger resource object.

CosmosDBSqlUserDefinedFunctionCreateOrUpdateContent

Parameters to create and update Cosmos DB userDefinedFunction.

CosmosDBSqlUserDefinedFunctionResourceInfo

Cosmos DB SQL userDefinedFunction resource object.

CosmosDBTableCreateOrUpdateContent

Parameters to create and update Cosmos DB Table.

CosmosDBTablePropertiesOptions

The CosmosDBTablePropertiesOptions.

CosmosDBTablePropertiesResource

The CosmosDBTablePropertiesResource.

CosmosDBTableResourceInfo

Cosmos DB table resource object.

CosmosDBThroughputPoolPatch

Represents a throughput pool resource for updates.

CosmosDBUniqueKey

The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

CosmosDBVirtualNetworkRule

Virtual Network ACL Rule object.

CosmosMongoDataTransferDataSourceSink

A CosmosDB Mongo API data source/sink.

CosmosMongoVCoreDataTransferDataSourceSink

A CosmosDB Mongo vCore API data source/sink.

CosmosSqlDataTransferDataSourceSink

A CosmosDB No Sql API data source/sink.

DatabaseAccountKeysMetadata

The metadata related to each access key for the given Cosmos DB database account.

DatabaseRestoreResourceInfo

Specific Databases to restore.

DataTransferDataSourceSink

Base class for all DataTransfer source/sink Please note DataTransferDataSourceSink is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureBlobDataTransferDataSourceSink, BaseCosmosDataTransferDataSourceSink, CosmosCassandraDataTransferDataSourceSink, CosmosMongoDataTransferDataSourceSink, CosmosMongoVCoreDataTransferDataSourceSink and CosmosSqlDataTransferDataSourceSink.

DataTransferJobGetResultCreateOrUpdateContent

Parameters to create Data Transfer Job.

DataTransferJobProperties

The properties of a DataTransfer Job.

DataTransferRegionalService

Resource for a regional service location.

DataTransferServiceProperties

Properties for DataTransferServiceResource.

DataTransferServiceResourceCreateUpdateProperties

Properties for Create or Update request for DataTransferServiceResource.

ExtendedCassandraKeyspaceResourceInfo

The ExtendedCassandraKeyspaceResourceInfo.

ExtendedCassandraTableResourceInfo

The ExtendedCassandraTableResourceInfo.

ExtendedCosmosDBSqlContainerResourceInfo

The ExtendedCosmosDBSqlContainerResourceInfo.

ExtendedCosmosDBSqlDatabaseResourceInfo

The ExtendedCosmosDBSqlDatabaseResourceInfo.

ExtendedCosmosDBSqlStoredProcedureResourceInfo

The ExtendedCosmosDBSqlStoredProcedureResourceInfo.

ExtendedCosmosDBSqlTriggerResourceInfo

The ExtendedCosmosDBSqlTriggerResourceInfo.

ExtendedCosmosDBSqlUserDefinedFunctionResourceInfo

The ExtendedCosmosDBSqlUserDefinedFunctionResourceInfo.

ExtendedGremlinDatabaseResourceInfo

The ExtendedGremlinDatabaseResourceInfo.

ExtendedGremlinGraphResourceInfo

The ExtendedGremlinGraphResourceInfo.

ExtendedMongoDBCollectionResourceInfo

The ExtendedMongoDBCollectionResourceInfo.

ExtendedMongoDBDatabaseResourceInfo

The ExtendedMongoDBDatabaseResourceInfo.

ExtendedRestorableGremlinDatabaseResourceInfo

The resource of an Azure Cosmos DB Gremlin database event.

ExtendedRestorableGremlinGraphResourceInfo

The resource of an Azure Cosmos DB Gremlin graph event.

ExtendedRestorableMongoDBCollectionResourceInfo

The resource of an Azure Cosmos DB MongoDB collection event.

ExtendedRestorableMongoDBDatabaseResourceInfo

The resource of an Azure Cosmos DB MongoDB database event.

ExtendedRestorableSqlContainerResourceInfo

The resource of an Azure Cosmos DB SQL container event.

ExtendedRestorableSqlDatabaseResourceInfo

The resource of an Azure Cosmos DB SQL database event.

ExtendedRestorableTableResourceInfo

The resource of an Azure Cosmos DB Table event.

ExtendedThroughputSettingsResourceInfo

The ExtendedThroughputSettingsResourceInfo.

GraphApiComputeRegionalService

Resource for a regional service location.

GraphApiComputeServiceProperties

Properties for GraphAPIComputeServiceResource.

GraphApiComputeServiceResourceCreateUpdateProperties

Properties for Create or Update request for GraphAPIComputeServiceResource.

GraphResourceGetPropertiesOptions

The GraphResourceGetPropertiesOptions.

GraphResourceGetResultCreateOrUpdateContent

Parameters to create and update Cosmos DB Graph resource.

GremlinDatabaseCreateOrUpdateContent

Parameters to create and update Cosmos DB Gremlin database.

GremlinDatabasePropertiesConfig

The GremlinDatabasePropertiesConfig.

GremlinDatabaseResourceInfo

Cosmos DB Gremlin database resource object.

GremlinDatabaseRestoreResourceInfo

Specific Gremlin Databases to restore.

GremlinGraphCreateOrUpdateContent

Parameters to create and update Cosmos DB Gremlin graph.

GremlinGraphPropertiesConfig

The GremlinGraphPropertiesConfig.

GremlinGraphResourceInfo

Cosmos DB Gremlin graph resource object.

MaterializedViewDefinition

Materialized View definition for the container.

MaterializedViewsBuilderRegionalService

Resource for a regional service location.

MaterializedViewsBuilderServiceProperties

Properties for MaterializedViewsBuilderServiceResource.

MaterializedViewsBuilderServiceResourceCreateUpdateProperties

Properties for Create or Update request for MaterializedViewsBuilderServiceResource.

MergeParameters

The properties of an Azure Cosmos DB merge operations.

MongoDBCollectionCreateOrUpdateContent

Parameters to create and update Cosmos DB MongoDB collection.

MongoDBCollectionPropertiesConfig

The MongoDBCollectionPropertiesConfig.

MongoDBCollectionResourceInfo

Cosmos DB MongoDB collection resource object.

MongoDBDatabaseCreateOrUpdateContent

Parameters to create and update Cosmos DB MongoDB database.

MongoDBDatabasePropertiesConfig

The MongoDBDatabasePropertiesConfig.

MongoDBDatabaseResourceInfo

Cosmos DB MongoDB database resource object.

MongoDBIndex

Cosmos DB MongoDB collection index key.

MongoDBIndexConfig

Cosmos DB MongoDB collection index options.

MongoDBPrivilege

The set of data plane operations permitted through this Role Definition.

MongoDBPrivilegeResourceInfo

An Azure Cosmos DB Mongo DB Resource.

MongoDBRole

The set of roles permitted through this Role Definition.

MongoDBRoleDefinitionCreateOrUpdateContent

Parameters to create and update an Azure Cosmos DB Mongo Role Definition.

MongoDBUserDefinitionCreateOrUpdateContent

Parameters to create and update an Azure Cosmos DB Mongo User Definition.

NetworkSecurityPerimeter

Information about a network security perimeter (NSP).

NetworkSecurityPerimeterConfigurationProperties

Network security configuration properties.

NetworkSecurityProfile

Network security perimeter configuration profile.

PartitionMetric

The metric values for a single partition.

PartitionUsage

The partition level usage data for a usage request.

PercentileMetricValue

Represents percentile metrics values.

PeriodicModeBackupPolicy

The object representing periodic mode backup policy.

PeriodicModeProperties

Configuration values for periodic mode backup.

PhysicalPartitionStorageInfo

The storage of a physical partition.

PhysicalPartitionStorageInfoCollection

List of physical partitions and their properties returned by a merge operation.

PhysicalPartitionThroughputInfoResource

PhysicalPartitionThroughputInfo object.

PhysicalPartitionThroughputInfoResult

An Azure Cosmos DB PhysicalPartitionThroughputInfoResult object.

ProvisioningIssue

Describes a provisioning issue for a network security perimeter configuration.

ProvisioningIssueProperties

Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules.

RedistributeThroughputParameters

Cosmos DB redistribute throughput parameters object.

RedistributeThroughputPropertiesResource

Resource to redistribute throughput for Azure Cosmos DB resource.

RegionForOnlineOffline

Cosmos DB region to online or offline.

ResourceAssociation

Information about resource association.

ResourceRestoreParameters

Parameters to indicate the information about the restore.

RestorableGremlinDatabase

An Azure Cosmos DB Gremlin database event.

RestorableGremlinGraph

An Azure Cosmos DB Gremlin graph event.

RestorableGremlinResourceData

Specific Databases to restore.

RestorableLocationResourceInfo

Properties of the regional restorable account.

RestorableMongoDBCollection

An Azure Cosmos DB MongoDB collection event.

RestorableMongoDBDatabase

An Azure Cosmos DB MongoDB database event.

RestorableMongoDBResourceData

Specific Databases to restore.

RestorableSqlContainer

An Azure Cosmos DB SQL container event.

RestorableSqlContainerPropertiesResourceContainer

Cosmos DB SQL container resource object.

RestorableSqlDatabase

An Azure Cosmos DB SQL database event.

RestorableSqlDatabasePropertiesResourceDatabase

Cosmos DB SQL database resource object.

RestorableSqlResourceData

Specific Databases to restore.

RestorableTable

An Azure Cosmos DB Table event.

RestorableTableResourceData

Specific Databases to restore.

RestoreParametersBase

Parameters to indicate the information about the restore.

RetrieveThroughputParameters

Cosmos DB retrieve throughput parameters object.

RetrieveThroughputPropertiesResource

Resource to retrieve throughput information for Cosmos DB resource.

ServiceResourceCreateUpdateProperties

Properties in ServiceResourceCreateUpdateParameters. Please note ServiceResourceCreateUpdateProperties is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include DataTransferServiceResourceCreateUpdateProperties, GraphApiComputeServiceResourceCreateUpdateProperties, MaterializedViewsBuilderServiceResourceCreateUpdateProperties and SqlDedicatedGatewayServiceResourceCreateUpdateProperties.

SpatialSpec

The SpatialSpec.

SqlDedicatedGatewayRegionalService

Resource for a regional service location.

SqlDedicatedGatewayServiceProperties

Properties for SqlDedicatedGatewayServiceResource.

SqlDedicatedGatewayServiceResourceCreateUpdateProperties

Properties for Create or Update request for SqlDedicatedGatewayServiceResource.

ThroughputPolicyResourceInfo

Cosmos DB resource throughput policy.

ThroughputSettingsResourceInfo

Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.

ThroughputSettingsUpdateData

Parameters to update Cosmos DB resource throughput.

Structs

AccessRuleDirection

Direction of Access Rule.

AnalyticalStorageSchemaType

Describes the types of schema for analytical storage.

BackupPolicyMigrationStatus

Describes the status of migration between backup policy types.

BackupPolicyType

Describes the mode of backups.

CapacityMode

Indicates the capacity mode of the account.

CapacityModeTransitionStatus

The transition status of capacity mode.

CassandraAuthenticationMethod

Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'.

CassandraAutoReplicateForm

The form of AutoReplicate that is being used by this cluster.

CassandraClusterBackupState

The current state of the backup.

CassandraClusterCommandStatus

Status of the command.

CassandraClusterType

Type of the cluster. If set to Production, some operations might not be permitted on cluster.

CassandraConnectionState

The kind of connection error that occurred.

CassandraNodeState

The state of the node in Cassandra ring.

CassandraProvisioningState

The status of the resource at the time the operation was called.

CompositePathSortOrder

Sort order for composite paths.

ConflictResolutionMode

Indicates the conflict resolution mode.

ConnectorOffer

The cassandra connector offer type for the Cosmos DB C* database account.

ContinuousTier

Enum to indicate type of Continuous backup tier.

CosmosDBAccountCreateMode

Enum to indicate the mode of account creation.

CosmosDBAccountKeyKind

The access key to regenerate.

CosmosDBAccountKind

Indicates the type of database account. This can only be set at database account creation.

CosmosDBAccountOfferType

The offer type for the Cosmos DB database account.

CosmosDBAccountRestoreMode

Describes the mode of the restore.

CosmosDBApiType

Enum to indicate the API type of the restorable database account.

CosmosDBBackupStorageRedundancy

Enum to indicate type of backup storage redundancy.

CosmosDBDataType

The datatype for which the indexing behavior is applied to.

CosmosDBIndexingMode

Indicates the indexing mode.

CosmosDBIndexKind

Indicates the type of index.

CosmosDBKind

Kind of the connection string key.

CosmosDBMetricPrimaryAggregationType

The primary aggregation type of the metric.

CosmosDBMetricUnitType

The unit of the metric.

CosmosDBMinimalTlsVersion

Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2.

CosmosDBOperationType

Enum to indicate the operation type of the event.

CosmosDBPartitionKind

Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create.

CosmosDBPublicNetworkAccess

Whether requests from Public Network are allowed.

CosmosDBServerVersion

Describes the ServerVersion of an a MongoDB account.

CosmosDBServiceSize

Instance type for the service.

CosmosDBServiceStatus

Describes the status of a service.

CosmosDBServiceType

ServiceType for the service.

CosmosDBSpatialType

Indicates the spatial type of index.

CosmosDBSqlTriggerOperation

The operation the trigger is associated with.

CosmosDBSqlTriggerType

Type of the Trigger.

CosmosDBStatus

Enum to indicate current buildout status of the region.

CosmosDBType

Type of the connection string.

DataTransferJobMode

Mode of job execution.

DedicatedGatewayType

DedicatedGatewayType for the service.

DefaultPriorityLevel

Enum to indicate default priorityLevel of requests.

IssueType

Type of issue.

NetworkSecurityPerimeterConfigurationProvisioningState

Provisioning state of a network security perimeter configuration that is being created or updated.

ResourceAssociationAccessMode

Access mode of the resource association.

ScheduledEventStrategy

How the nodes in the cluster react to scheduled events.

ServiceConnectionType

How to connect to the azure services needed for running the cluster.

Severity

Severity of the issue.

ThroughputPolicyType

ThroughputPolicy to apply for throughput redistribution.

Enums

CosmosDBChaosFaultSupportedAction

Indicates whether what action to take for the Chaos Fault.

CosmosDBSqlRoleDefinitionType

Indicates whether the Role Definition was built-in or user created.

DefaultConsistencyLevel

The default consistency level and configuration settings of the Cosmos DB account.

EnableFullTextQuery

Describe the level of detail with which queries are to be logged.

MongoDBRoleDefinitionType

Indicates whether the Role Definition was built-in or user created.

NetworkAclBypass

Indicates what services are allowed to bypass firewall checks.