models Package
Classes
ARMProxyResource |
The resource model definition for a ARM proxy resource. It will have everything other than required location and tags. Variables are only populated by the server, and will be ignored when sending a request. |
ARMResourceProperties |
The core properties of ARM resources. Variables are only populated by the server, and will be ignored when sending a request. |
AccountKeyMetadata |
The metadata related to an access key for a given database account. Variables are only populated by the server, and will be ignored when sending a request. |
AnalyticalStorageConfiguration |
Analytical storage specific properties. |
ApiProperties |
ApiProperties. |
AuthenticationMethodLdapProperties |
Ldap authentication method properties. This feature is in preview. |
AutoUpgradePolicyResource |
Cosmos DB resource auto-upgrade policy. |
AutoscaleSettings |
AutoscaleSettings. |
AutoscaleSettingsResource |
Cosmos DB provisioned throughput settings object. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
BackupInformation |
Backup information of a resource. Variables are only populated by the server, and will be ignored when sending a request. |
BackupPolicy |
The object representing the policy for taking backups on an account. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ContinuousModeBackupPolicy, PeriodicModeBackupPolicy All required parameters must be populated in order to send to Azure. |
BackupPolicyMigrationState |
The object representing the state of the migration between the backup policies. |
Capability |
Cosmos DB capability object. |
Capacity |
The object that represents all properties related to capacity enforcement on an account. |
CassandraClusterDataCenterNodeItem |
CassandraClusterDataCenterNodeItem. |
CassandraClusterPublicStatus |
Properties of a managed Cassandra cluster public status. |
CassandraClusterPublicStatusDataCentersItem |
CassandraClusterPublicStatusDataCentersItem. |
CassandraError |
CassandraError. |
CassandraKeyspaceCreateUpdateParameters |
Parameters to create and update Cosmos DB Cassandra keyspace. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
CassandraKeyspaceGetPropertiesOptions |
CassandraKeyspaceGetPropertiesOptions. |
CassandraKeyspaceGetPropertiesResource |
CassandraKeyspaceGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
CassandraKeyspaceGetResults |
An Azure Cosmos DB Cassandra keyspace. Variables are only populated by the server, and will be ignored when sending a request. |
CassandraKeyspaceListResult |
The List operation response, that contains the Cassandra keyspaces and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
CassandraKeyspaceResource |
Cosmos DB Cassandra keyspace resource object. All required parameters must be populated in order to send to Azure. |
CassandraPartitionKey |
Cosmos DB Cassandra table partition key. |
CassandraSchema |
Cosmos DB Cassandra table schema. |
CassandraTableCreateUpdateParameters |
Parameters to create and update Cosmos DB Cassandra table. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
CassandraTableGetPropertiesOptions |
CassandraTableGetPropertiesOptions. |
CassandraTableGetPropertiesResource |
CassandraTableGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
CassandraTableGetResults |
An Azure Cosmos DB Cassandra table. Variables are only populated by the server, and will be ignored when sending a request. |
CassandraTableListResult |
The List operation response, that contains the Cassandra tables and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
CassandraTableResource |
Cosmos DB Cassandra table resource object. All required parameters must be populated in order to send to Azure. |
Certificate |
Certificate. |
ClientEncryptionIncludedPath |
. All required parameters must be populated in order to send to Azure. |
ClientEncryptionKeyCreateUpdateParameters |
Parameters to create and update ClientEncryptionKey. All required parameters must be populated in order to send to Azure. |
ClientEncryptionKeyGetPropertiesResource |
ClientEncryptionKeyGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. |
ClientEncryptionKeyGetResults |
Client Encryption Key. Variables are only populated by the server, and will be ignored when sending a request. |
ClientEncryptionKeyResource |
Cosmos DB client encryption key resource object. |
ClientEncryptionKeysListResult |
The List operation response, that contains the client encryption keys and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
ClientEncryptionPolicy |
Cosmos DB client encryption policy. All required parameters must be populated in order to send to Azure. |
ClusterKey |
Cosmos DB Cassandra table cluster key. |
ClusterResource |
Representation of a managed Cassandra cluster. Variables are only populated by the server, and will be ignored when sending a request. |
ClusterResourceProperties |
Properties of a managed Cassandra cluster. Variables are only populated by the server, and will be ignored when sending a request. |
Column |
Cosmos DB Cassandra table column. |
CommandOutput |
Response of /command api. |
CommandPostBody |
Specification of which command to run where. All required parameters must be populated in order to send to Azure. |
CompositePath |
CompositePath. |
ComputedProperty |
The definition of a computed property. |
ConflictResolutionPolicy |
The conflict resolution policy for the container. |
ConnectionError |
ConnectionError. |
ConsistencyPolicy |
The consistency policy for the Cosmos DB database account. All required parameters must be populated in order to send to Azure. |
ContainerPartitionKey |
The configuration of the partition key to be used for partitioning data into multiple partitions. Variables are only populated by the server, and will be ignored when sending a request. |
ContinuousBackupInformation |
Information about the status of continuous backups. |
ContinuousBackupRestoreLocation |
Properties of the regional restorable account. |
ContinuousModeBackupPolicy |
The object representing continuous mode backup policy. All required parameters must be populated in order to send to Azure. |
ContinuousModeProperties |
Configuration values for periodic mode backup. |
CorsPolicy |
The CORS policy for the Cosmos DB database account. All required parameters must be populated in order to send to Azure. |
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". |
DataCenterResource |
A managed Cassandra data center. Variables are only populated by the server, and will be ignored when sending a request. |
DataCenterResourceProperties |
Properties of a managed Cassandra data center. Variables are only populated by the server, and will be ignored when sending a request. |
DataTransferRegionalServiceResource |
Resource for a regional service location. Variables are only populated by the server, and will be ignored when sending a request. |
DataTransferServiceResource |
Describes the service response property. |
DataTransferServiceResourceProperties |
Properties for DataTransferServiceResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
DatabaseAccountConnectionString |
Connection string for the Cosmos DB account. Variables are only populated by the server, and will be ignored when sending a request. |
DatabaseAccountCreateUpdateParameters |
Parameters to create and update Cosmos DB database accounts. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
DatabaseAccountGetResults |
An Azure Cosmos DB database account. Variables are only populated by the server, and will be ignored when sending a request. |
DatabaseAccountKeysMetadata |
The metadata related to each access key for the given Cosmos DB database account. Variables are only populated by the server, and will be ignored when sending a request. |
DatabaseAccountListConnectionStringsResult |
The connection strings for the given database account. |
DatabaseAccountListKeysResult |
The access keys for the given database account. Variables are only populated by the server, and will be ignored when sending a request. |
DatabaseAccountListReadOnlyKeysResult |
The read-only access keys for the given database account. Variables are only populated by the server, and will be ignored when sending a request. |
DatabaseAccountRegenerateKeyParameters |
Parameters to regenerate the keys within the database account. All required parameters must be populated in order to send to Azure. |
DatabaseAccountUpdateParameters |
Parameters for patching Azure Cosmos DB database account properties. Variables are only populated by the server, and will be ignored when sending a request. |
DatabaseAccountsListResult |
The List operation response, that contains the database accounts and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
DatabaseRestoreResource |
Specific Databases to restore. |
ErrorResponse |
Error Response. |
ExcludedPath |
ExcludedPath. |
ExtendedResourceProperties |
The system generated resource properties associated with SQL databases, SQL containers, Gremlin databases and Gremlin graphs. Variables are only populated by the server, and will be ignored when sending a request. |
FailoverPolicies |
The list of new failover policies for the failover priority change. All required parameters must be populated in order to send to Azure. |
FailoverPolicy |
The failover policy for a given region of a database account. Variables are only populated by the server, and will be ignored when sending a request. |
GraphAPIComputeRegionalServiceResource |
Resource for a regional service location. Variables are only populated by the server, and will be ignored when sending a request. |
GraphAPIComputeServiceResource |
Describes the service response property for GraphAPICompute. |
GraphAPIComputeServiceResourceProperties |
Properties for GraphAPIComputeServiceResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
GremlinDatabaseCreateUpdateParameters |
Parameters to create and update Cosmos DB Gremlin database. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
GremlinDatabaseGetPropertiesOptions |
GremlinDatabaseGetPropertiesOptions. |
GremlinDatabaseGetPropertiesResource |
GremlinDatabaseGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
GremlinDatabaseGetResults |
An Azure Cosmos DB Gremlin database. Variables are only populated by the server, and will be ignored when sending a request. |
GremlinDatabaseListResult |
The List operation response, that contains the Gremlin databases and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
GremlinDatabaseResource |
Cosmos DB Gremlin database resource object. All required parameters must be populated in order to send to Azure. |
GremlinDatabaseRestoreResource |
Specific Gremlin Databases to restore. |
GremlinGraphCreateUpdateParameters |
Parameters to create and update Cosmos DB Gremlin graph. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
GremlinGraphGetPropertiesOptions |
GremlinGraphGetPropertiesOptions. |
GremlinGraphGetPropertiesResource |
GremlinGraphGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
GremlinGraphGetResults |
An Azure Cosmos DB Gremlin graph. Variables are only populated by the server, and will be ignored when sending a request. |
GremlinGraphListResult |
The List operation response, that contains the graphs and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
GremlinGraphResource |
Cosmos DB Gremlin graph resource object. All required parameters must be populated in order to send to Azure. |
IncludedPath |
The paths that are included in indexing. |
Indexes |
The indexes for the path. |
IndexingPolicy |
Cosmos DB indexing policy. |
IpAddressOrRange |
IpAddressOrRange object. |
KeyWrapMetadata |
Represents key wrap metadata that a key wrapping provider can use to wrap/unwrap a client encryption key. |
ListClusters |
List of managed Cassandra clusters. |
ListDataCenters |
List of managed Cassandra data centers and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
Location |
A region in which the Azure Cosmos DB database account is deployed. Variables are only populated by the server, and will be ignored when sending a request. |
LocationGetResult |
Cosmos DB location get result. Variables are only populated by the server, and will be ignored when sending a request. |
LocationListResult |
The List operation response, that contains Cosmos DB locations and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
LocationProperties |
Cosmos DB location metadata. Variables are only populated by the server, and will be ignored when sending a request. |
ManagedCassandraARMResourceProperties |
The core properties of ARM resources. Variables are only populated by the server, and will be ignored when sending a request. |
ManagedCassandraManagedServiceIdentity |
Identity for the resource. Variables are only populated by the server, and will be ignored when sending a request. |
ManagedCassandraReaperStatus |
ManagedCassandraReaperStatus. |
ManagedServiceIdentity |
Identity for the resource. Variables are only populated by the server, and will be ignored when sending a request. |
ManagedServiceIdentityUserAssignedIdentity |
ManagedServiceIdentityUserAssignedIdentity. Variables are only populated by the server, and will be ignored when sending a request. |
MaterializedViewsBuilderRegionalServiceResource |
Resource for a regional service location. Variables are only populated by the server, and will be ignored when sending a request. |
MaterializedViewsBuilderServiceResource |
Describes the service response property for MaterializedViewsBuilder. |
MaterializedViewsBuilderServiceResourceProperties |
Properties for MaterializedViewsBuilderServiceResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
Metric |
Metric data. Variables are only populated by the server, and will be ignored when sending a request. |
MetricAvailability |
The availability of the metric. Variables are only populated by the server, and will be ignored when sending a request. |
MetricDefinition |
The definition of a metric. Variables are only populated by the server, and will be ignored when sending a request. |
MetricDefinitionsListResult |
The response to a list metric definitions request. Variables are only populated by the server, and will be ignored when sending a request. |
MetricListResult |
The response to a list metrics request. Variables are only populated by the server, and will be ignored when sending a request. |
MetricName |
A metric name. Variables are only populated by the server, and will be ignored when sending a request. |
MetricValue |
Represents metrics values. Variables are only populated by the server, and will be ignored when sending a request. |
MongoDBCollectionCreateUpdateParameters |
Parameters to create and update Cosmos DB MongoDB collection. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
MongoDBCollectionGetPropertiesOptions |
MongoDBCollectionGetPropertiesOptions. |
MongoDBCollectionGetPropertiesResource |
MongoDBCollectionGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
MongoDBCollectionGetResults |
An Azure Cosmos DB MongoDB collection. Variables are only populated by the server, and will be ignored when sending a request. |
MongoDBCollectionListResult |
The List operation response, that contains the MongoDB collections and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
MongoDBCollectionResource |
Cosmos DB MongoDB collection resource object. All required parameters must be populated in order to send to Azure. |
MongoDBDatabaseCreateUpdateParameters |
Parameters to create and update Cosmos DB MongoDB database. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
MongoDBDatabaseGetPropertiesOptions |
MongoDBDatabaseGetPropertiesOptions. |
MongoDBDatabaseGetPropertiesResource |
MongoDBDatabaseGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
MongoDBDatabaseGetResults |
An Azure Cosmos DB MongoDB database. Variables are only populated by the server, and will be ignored when sending a request. |
MongoDBDatabaseListResult |
The List operation response, that contains the MongoDB databases and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
MongoDBDatabaseResource |
Cosmos DB MongoDB database resource object. All required parameters must be populated in order to send to Azure. |
MongoIndex |
Cosmos DB MongoDB collection index key. |
MongoIndexKeys |
Cosmos DB MongoDB collection resource object. |
MongoIndexOptions |
Cosmos DB MongoDB collection index options. |
MongoRoleDefinitionCreateUpdateParameters |
Parameters to create and update an Azure Cosmos DB Mongo Role Definition. |
MongoRoleDefinitionGetResults |
An Azure Cosmos DB Mongo Role Definition. Variables are only populated by the server, and will be ignored when sending a request. |
MongoRoleDefinitionListResult |
The relevant Mongo Role Definitions. Variables are only populated by the server, and will be ignored when sending a request. |
MongoUserDefinitionCreateUpdateParameters |
Parameters to create and update an Azure Cosmos DB Mongo User Definition. |
MongoUserDefinitionGetResults |
An Azure Cosmos DB User Definition. Variables are only populated by the server, and will be ignored when sending a request. |
MongoUserDefinitionListResult |
The relevant User Definition. Variables are only populated by the server, and will be ignored when sending a request. |
NotebookWorkspace |
A notebook workspace resource. Variables are only populated by the server, and will be ignored when sending a request. |
NotebookWorkspaceConnectionInfoResult |
The connection info for the given notebook workspace. Variables are only populated by the server, and will be ignored when sending a request. |
NotebookWorkspaceCreateUpdateParameters |
Parameters to create a notebook workspace resource. Variables are only populated by the server, and will be ignored when sending a request. |
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. |
PartitionMetric |
The metric values for a single partition. Variables are only populated by the server, and will be ignored when sending a request. |
PartitionMetricListResult |
The response to a list partition metrics request. Variables are only populated by the server, and will be ignored when sending a request. |
PartitionUsage |
The partition level usage data for a usage request. Variables are only populated by the server, and will be ignored when sending a request. |
PartitionUsagesResult |
The response to a list partition level usage request. Variables are only populated by the server, and will be ignored when sending a request. |
PercentileMetric |
Percentile Metric data. Variables are only populated by the server, and will be ignored when sending a request. |
PercentileMetricListResult |
The response to a list percentile metrics request. Variables are only populated by the server, and will be ignored when sending a request. |
PercentileMetricValue |
Represents percentile metrics values. Variables are only populated by the server, and will be ignored when sending a request. |
PeriodicModeBackupPolicy |
The object representing periodic mode backup policy. All required parameters must be populated in order to send to Azure. |
PeriodicModeProperties |
Configuration values for periodic mode backup. |
Permission |
The set of data plane operations permitted through this Role Definition. |
PrivateEndpointConnection |
A private endpoint connection. Variables are only populated by the server, and will be ignored when sending a request. |
PrivateEndpointConnectionListResult |
A list of private endpoint connections. |
PrivateEndpointProperty |
Private endpoint which the connection belongs to. |
PrivateLinkResource |
A private link resource. Variables are only populated by the server, and will be ignored when sending a request. |
PrivateLinkResourceListResult |
A list of private link resources. |
PrivateLinkServiceConnectionStateProperty |
Connection State of the Private Endpoint Connection. Variables are only populated by the server, and will be ignored when sending a request. |
Privilege |
The set of data plane operations permitted through this Role Definition. |
PrivilegeResource |
An Azure Cosmos DB Mongo DB Resource. |
ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location. Variables are only populated by the server, and will be ignored when sending a request. |
RegionForOnlineOffline |
Cosmos DB region to online or offline. All required parameters must be populated in order to send to Azure. |
RegionalServiceResource |
Resource for a regional service location. Variables are only populated by the server, and will be ignored when sending a request. |
Resource |
Common fields that are returned in the response for all Azure Resource Manager resources. Variables are only populated by the server, and will be ignored when sending a request. |
ResourceRestoreParameters |
Parameters to indicate the information about the restore. |
RestorableDatabaseAccountGetResult |
A Azure Cosmos DB restorable database account. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableDatabaseAccountsListResult |
The List operation response, that contains the restorable database accounts and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableGremlinDatabaseGetResult |
An Azure Cosmos DB Gremlin database event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableGremlinDatabasePropertiesResource |
The resource of an Azure Cosmos DB Gremlin database event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableGremlinDatabasesListResult |
The List operation response, that contains the Gremlin database events and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableGremlinGraphGetResult |
An Azure Cosmos DB Gremlin graph event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableGremlinGraphPropertiesResource |
The resource of an Azure Cosmos DB Gremlin graph event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableGremlinGraphsListResult |
The List operation response, that contains the Gremlin graph events and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableGremlinResourcesGetResult |
Specific Databases to restore. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableGremlinResourcesListResult |
The List operation response, that contains the restorable Gremlin resources. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableLocationResource |
Properties of the regional restorable account. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableMongodbCollectionGetResult |
An Azure Cosmos DB MongoDB collection event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableMongodbCollectionPropertiesResource |
The resource of an Azure Cosmos DB MongoDB collection event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableMongodbCollectionsListResult |
The List operation response, that contains the MongoDB collection events and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableMongodbDatabaseGetResult |
An Azure Cosmos DB MongoDB database event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableMongodbDatabasePropertiesResource |
The resource of an Azure Cosmos DB MongoDB database event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableMongodbDatabasesListResult |
The List operation response, that contains the MongoDB database events and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableMongodbResourcesGetResult |
Specific Databases to restore. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableMongodbResourcesListResult |
The List operation response, that contains the restorable MongoDB resources. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableSqlContainerGetResult |
An Azure Cosmos DB SQL container event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableSqlContainerPropertiesResource |
The resource of an Azure Cosmos DB SQL container event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableSqlContainerPropertiesResourceContainer |
Cosmos DB SQL container resource object. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
RestorableSqlContainersListResult |
The List operation response, that contains the SQL container events and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableSqlDatabaseGetResult |
An Azure Cosmos DB SQL database event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableSqlDatabasePropertiesResource |
The resource of an Azure Cosmos DB SQL database event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableSqlDatabasePropertiesResourceDatabase |
Cosmos DB SQL database resource object. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
RestorableSqlDatabasesListResult |
The List operation response, that contains the SQL database events and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableSqlResourcesGetResult |
Specific Databases to restore. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableSqlResourcesListResult |
The List operation response, that contains the restorable SQL resources. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableTableGetResult |
An Azure Cosmos DB Table event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableTablePropertiesResource |
The resource of an Azure Cosmos DB Table event. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableTableResourcesGetResult |
Specific Databases to restore. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableTableResourcesListResult |
List of restorable table names. Variables are only populated by the server, and will be ignored when sending a request. |
RestorableTablesListResult |
The List operation response, that contains the Table events and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
RestoreParameters |
Parameters to indicate the information about the restore. |
RestoreParametersBase |
Parameters to indicate the information about the restore. |
Role |
The set of roles permitted through this Role Definition. |
SeedNode |
SeedNode. |
ServiceResource |
Properties for the database account. Variables are only populated by the server, and will be ignored when sending a request. |
ServiceResourceCreateUpdateParameters |
Parameters for Create or Update Request for ServiceResource. |
ServiceResourceListResult |
The List operation response, that contains the Service Resource and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
ServiceResourceProperties |
Services response resource. You probably want to use the sub-classes and not this class directly. Known sub-classes are: DataTransferServiceResourceProperties, GraphAPIComputeServiceResourceProperties, MaterializedViewsBuilderServiceResourceProperties, SqlDedicatedGatewayServiceResourceProperties Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
SpatialSpec |
SpatialSpec. |
SqlContainerCreateUpdateParameters |
Parameters to create and update Cosmos DB container. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
SqlContainerGetPropertiesOptions |
SqlContainerGetPropertiesOptions. |
SqlContainerGetPropertiesResource |
SqlContainerGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
SqlContainerGetResults |
An Azure Cosmos DB container. Variables are only populated by the server, and will be ignored when sending a request. |
SqlContainerListResult |
The List operation response, that contains the containers and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
SqlContainerResource |
Cosmos DB SQL container resource object. All required parameters must be populated in order to send to Azure. |
SqlDatabaseCreateUpdateParameters |
Parameters to create and update Cosmos DB SQL database. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
SqlDatabaseGetPropertiesOptions |
SqlDatabaseGetPropertiesOptions. |
SqlDatabaseGetPropertiesResource |
SqlDatabaseGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
SqlDatabaseGetResults |
An Azure Cosmos DB SQL database. Variables are only populated by the server, and will be ignored when sending a request. |
SqlDatabaseListResult |
The List operation response, that contains the SQL databases and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
SqlDatabaseResource |
Cosmos DB SQL database resource object. All required parameters must be populated in order to send to Azure. |
SqlDedicatedGatewayRegionalServiceResource |
Resource for a regional service location. Variables are only populated by the server, and will be ignored when sending a request. |
SqlDedicatedGatewayServiceResource |
Describes the service response property for SqlDedicatedGateway. |
SqlDedicatedGatewayServiceResourceProperties |
Properties for SqlDedicatedGatewayServiceResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
SqlRoleAssignmentCreateUpdateParameters |
Parameters to create and update an Azure Cosmos DB SQL Role Assignment. |
SqlRoleAssignmentGetResults |
An Azure Cosmos DB Role Assignment. Variables are only populated by the server, and will be ignored when sending a request. |
SqlRoleAssignmentListResult |
The relevant Role Assignments. Variables are only populated by the server, and will be ignored when sending a request. |
SqlRoleDefinitionCreateUpdateParameters |
Parameters to create and update an Azure Cosmos DB SQL Role Definition. |
SqlRoleDefinitionGetResults |
An Azure Cosmos DB SQL Role Definition. Variables are only populated by the server, and will be ignored when sending a request. |
SqlRoleDefinitionListResult |
The relevant Role Definitions. Variables are only populated by the server, and will be ignored when sending a request. |
SqlStoredProcedureCreateUpdateParameters |
Parameters to create and update Cosmos DB storedProcedure. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
SqlStoredProcedureGetPropertiesResource |
SqlStoredProcedureGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
SqlStoredProcedureGetResults |
An Azure Cosmos DB storedProcedure. Variables are only populated by the server, and will be ignored when sending a request. |
SqlStoredProcedureListResult |
The List operation response, that contains the storedProcedures and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
SqlStoredProcedureResource |
Cosmos DB SQL storedProcedure resource object. All required parameters must be populated in order to send to Azure. |
SqlTriggerCreateUpdateParameters |
Parameters to create and update Cosmos DB trigger. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
SqlTriggerGetPropertiesResource |
SqlTriggerGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
SqlTriggerGetResults |
An Azure Cosmos DB trigger. Variables are only populated by the server, and will be ignored when sending a request. |
SqlTriggerListResult |
The List operation response, that contains the triggers and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
SqlTriggerResource |
Cosmos DB SQL trigger resource object. All required parameters must be populated in order to send to Azure. |
SqlUserDefinedFunctionCreateUpdateParameters |
Parameters to create and update Cosmos DB userDefinedFunction. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
SqlUserDefinedFunctionGetPropertiesResource |
SqlUserDefinedFunctionGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
SqlUserDefinedFunctionGetResults |
An Azure Cosmos DB userDefinedFunction. Variables are only populated by the server, and will be ignored when sending a request. |
SqlUserDefinedFunctionListResult |
The List operation response, that contains the userDefinedFunctions and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
SqlUserDefinedFunctionResource |
Cosmos DB SQL userDefinedFunction resource object. All required parameters must be populated in order to send to Azure. |
SystemData |
Metadata pertaining to creation and last modification of the resource. |
TableCreateUpdateParameters |
Parameters to create and update Cosmos DB Table. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
TableGetPropertiesOptions |
TableGetPropertiesOptions. |
TableGetPropertiesResource |
TableGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
TableGetResults |
An Azure Cosmos DB Table. Variables are only populated by the server, and will be ignored when sending a request. |
TableListResult |
The List operation response, that contains the Table and their properties. Variables are only populated by the server, and will be ignored when sending a request. |
TableResource |
Cosmos DB table resource object. All required parameters must be populated in order to send to Azure. |
ThroughputPolicyResource |
Cosmos DB resource throughput policy. |
ThroughputSettingsGetPropertiesResource |
ThroughputSettingsGetPropertiesResource. Variables are only populated by the server, and will be ignored when sending a request. |
ThroughputSettingsGetResults |
An Azure Cosmos DB resource throughput. Variables are only populated by the server, and will be ignored when sending a request. |
ThroughputSettingsResource |
Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. Variables are only populated by the server, and will be ignored when sending a request. |
ThroughputSettingsUpdateParameters |
Parameters to update Cosmos DB resource throughput. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
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. |
Usage |
The usage data for a usage request. Variables are only populated by the server, and will be ignored when sending a request. |
UsagesResult |
The response to a list usage request. Variables are only populated by the server, and will be ignored when sending a request. |
VirtualNetworkRule |
Virtual Network ACL Rule object. |
Enums
AnalyticalStorageSchemaType |
Describes the types of schema for analytical storage. |
ApiType |
Enum to indicate the API type of the restorable database account. |
AuthenticationMethod |
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'. |
BackupPolicyMigrationStatus |
Describes the status of migration between backup policy types. |
BackupPolicyType |
Describes the mode of backups. |
BackupStorageRedundancy |
Enum to indicate type of backup storage redundancy. |
CompositePathSortOrder |
Sort order for composite paths. |
ConflictResolutionMode |
Indicates the conflict resolution mode. |
ConnectionState |
The kind of connection error that occurred. |
ConnectorOffer |
The cassandra connector offer type for the Cosmos DB C* database account. |
ContinuousTier |
Enum to indicate type of Continuous backup tier. |
CreateMode |
Enum to indicate the mode of account creation. |
CreatedByType |
The type of identity that created the resource. |
DataType |
The datatype for which the indexing behavior is applied to. |
DatabaseAccountKind |
Indicates the type of database account. This can only be set at database account creation. |
DefaultConsistencyLevel |
The default consistency level and configuration settings of the Cosmos DB account. |
IndexKind |
Indicates the type of index. |
IndexingMode |
Indicates the indexing mode. |
KeyKind |
The access key to regenerate. |
Kind |
Kind of the connection string key. |
ManagedCassandraProvisioningState |
The status of the resource at the time the operation was called. |
ManagedCassandraResourceIdentityType |
The type of the resource. |
MinimalTlsVersion |
Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2. |
MongoRoleDefinitionType |
Indicates whether the Role Definition was built-in or user created. |
NetworkAclBypass |
Indicates what services are allowed to bypass firewall checks. |
NodeState |
The state of the node in Cassandra ring. |
NodeStatus |
Indicates whether the node is functioning or not. |
NotebookWorkspaceName |
NotebookWorkspaceName. |
OperationType |
Enum to indicate the operation type of the event. |
PartitionKind |
Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create. |
PrimaryAggregationType |
The primary aggregation type of the metric. |
PublicNetworkAccess |
Whether requests from Public Network are allowed. |
ResourceIdentityType |
The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. |
RestoreMode |
Describes the mode of the restore. |
RoleDefinitionType |
Indicates whether the Role Definition was built-in or user created. |
ServerVersion |
Describes the ServerVersion of an a MongoDB account. |
ServiceSize |
Instance type for the service. |
ServiceStatus |
Describes the status of a service. |
ServiceType |
ServiceType for the service. |
SpatialType |
Indicates the spatial type of index. |
Status |
Enum to indicate current buildout status of the region. |
TriggerOperation |
The operation the trigger is associated with. |
TriggerType |
Type of the Trigger. |
Type |
Type of the connection string. |
UnitType |
The unit of the metric. |
Azure SDK for Python
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for