pulumi-azure-native-kotlin/com.pulumi.azurenative.documentdb.kotlin.outputs

Package-level declarations

Types

Link copied to clipboard
data class AccountKeyMetadataResponse(val generationTime: String)

The metadata related to an access key for a given database account.

Link copied to clipboard
data class AnalyticalStorageConfigurationResponse(val schemaType: String? = null)

Analytical storage specific properties.

Link copied to clipboard
data class ApiPropertiesResponse(val serverVersion: String? = null)
data class AuthenticationMethodLdapPropertiesResponse(val connectionTimeoutInMs: Int? = null, val searchBaseDistinguishedName: String? = null, val searchFilterTemplate: String? = null, val serverCertificates: List<CertificateResponse>? = null, val serverHostname: String? = null, val serverPort: Int? = null, val serviceUserDistinguishedName: String? = null, val serviceUserPassword: String? = null)

Ldap authentication method properties. This feature is in preview.

Link copied to clipboard
data class AutoscaleSettingsResponse(val maxThroughput: Int? = null)
Link copied to clipboard
data class BackupPolicyMigrationStateResponse(val startTime: String? = null, val status: String? = null, val targetType: String? = null)

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

Link copied to clipboard
data class CapabilityResponse(val name: String? = null)

Cosmos DB capability object

Link copied to clipboard
data class CapacityResponse(val totalThroughputLimit: Int? = null)

The object that represents all properties related to capacity enforcement on an account.

Link copied to clipboard
data class CassandraErrorResponse(val additionalErrorInfo: String? = null, val code: String? = null, val message: String? = null, val target: String? = null)
data class CassandraKeyspaceGetPropertiesResponseOptions(val autoscaleSettings: AutoscaleSettingsResponse? = null, val throughput: Int? = null)
data class CassandraKeyspaceGetPropertiesResponseResource(val etag: String, val id: String, val rid: String, val ts: Double)
Link copied to clipboard
data class CassandraPartitionKeyResponse(val name: String? = null)

Cosmos DB Cassandra table partition key

Link copied to clipboard
data class CassandraSchemaResponse(val clusterKeys: List<ClusterKeyResponse>? = null, val columns: List<ColumnResponse>? = null, val partitionKeys: List<CassandraPartitionKeyResponse>? = null)

Cosmos DB Cassandra table schema

data class CassandraTableGetPropertiesResponseOptions(val autoscaleSettings: AutoscaleSettingsResponse? = null, val throughput: Int? = null)
data class CassandraTableGetPropertiesResponseResource(val analyticalStorageTtl: Int? = null, val defaultTtl: Int? = null, val etag: String, val id: String, val rid: String, val schema: CassandraSchemaResponse? = null, val ts: Double)
data class CassandraViewGetPropertiesResponseOptions(val autoscaleSettings: AutoscaleSettingsResponse? = null, val throughput: Int? = null)
data class CassandraViewGetPropertiesResponseResource(val etag: String, val id: String, val rid: String, val ts: Double, val viewDefinition: String)
Link copied to clipboard
data class CertificateResponse(val pem: String? = null)
Link copied to clipboard
data class ClientEncryptionIncludedPathResponse(val clientEncryptionKeyId: String, val encryptionAlgorithm: String, val encryptionType: String, val path: String)

.

Link copied to clipboard
data class ClientEncryptionPolicyResponse(val includedPaths: List<ClientEncryptionIncludedPathResponse>, val policyFormatVersion: Int)

Cosmos DB client encryption policy.

Link copied to clipboard
data class ClusterKeyResponse(val name: String? = null, val orderBy: String? = null)

Cosmos DB Cassandra table cluster key

Link copied to clipboard
data class ClusterResourceResponseProperties(val authenticationMethod: String? = null, val cassandraAuditLoggingEnabled: Boolean? = null, val cassandraVersion: String? = null, val clientCertificates: List<CertificateResponse>? = null, val clusterNameOverride: String? = null, val deallocated: Boolean? = null, val delegatedManagementSubnetId: String? = null, val externalGossipCertificates: List<CertificateResponse>? = null, val externalSeedNodes: List<SeedNodeResponse>? = null, val gossipCertificates: List<CertificateResponse>, val hoursBetweenBackups: Int? = null, val prometheusEndpoint: SeedNodeResponse? = null, val provisionError: CassandraErrorResponse? = null, val provisioningState: String? = null, val repairEnabled: Boolean? = null, val seedNodes: List<SeedNodeResponse>)

Properties of a managed Cassandra cluster.

Link copied to clipboard
data class ColumnResponse(val name: String? = null, val type: String? = null)

Cosmos DB Cassandra table column

Link copied to clipboard
data class CompositePathResponse(val order: String? = null, val path: String? = null)
Link copied to clipboard
data class ConflictResolutionPolicyResponse(val conflictResolutionPath: String? = null, val conflictResolutionProcedure: String? = null, val mode: String? = null)

The conflict resolution policy for the container.

Link copied to clipboard
data class ConnectionStringResponse(val connectionString: String, val description: String)

Connection string for the mongo cluster

Link copied to clipboard
data class ConsistencyPolicyResponse(val defaultConsistencyLevel: String, val maxIntervalInSeconds: Int? = null, val maxStalenessPrefix: Double? = null)

The consistency policy for the Cosmos DB database account.

Link copied to clipboard
data class ContainerPartitionKeyResponse(val kind: String? = null, val paths: List<String>? = null, val systemKey: Boolean, val version: Int? = null)

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

Link copied to clipboard
data class ContinuousModeBackupPolicyResponse(val continuousModeProperties: ContinuousModePropertiesResponse? = null, val migrationState: BackupPolicyMigrationStateResponse? = null, val type: String)

The object representing continuous mode backup policy.

Link copied to clipboard
data class ContinuousModePropertiesResponse(val tier: String? = null)

Configuration values for periodic mode backup

Link copied to clipboard
data class CorsPolicyResponse(val allowedHeaders: String? = null, val allowedMethods: String? = null, val allowedOrigins: String, val exposedHeaders: String? = null, val maxAgeInSeconds: Double? = null)

The CORS policy for the Cosmos DB database account.

Link copied to clipboard
data class DatabaseAccountConnectionStringResponse(val connectionString: String, val description: String, val keyKind: String, val type: String)

Connection string for the Cosmos DB account

Link copied to clipboard
data class DatabaseAccountKeysMetadataResponse(val primaryMasterKey: AccountKeyMetadataResponse, val primaryReadonlyMasterKey: AccountKeyMetadataResponse, val secondaryMasterKey: AccountKeyMetadataResponse, val secondaryReadonlyMasterKey: AccountKeyMetadataResponse)

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

Link copied to clipboard
data class DatabaseRestoreResourceResponse(val collectionNames: List<String>? = null, val databaseName: String? = null)

Specific Databases to restore.

Link copied to clipboard
data class DataCenterResourceResponseProperties(val authenticationMethodLdapProperties: AuthenticationMethodLdapPropertiesResponse? = null, val availabilityZone: Boolean? = null, val backupStorageCustomerKeyUri: String? = null, val base64EncodedCassandraYamlFragment: String? = null, val dataCenterLocation: String? = null, val deallocated: Boolean? = null, val delegatedSubnetId: String? = null, val diskCapacity: Int? = null, val diskSku: String? = null, val managedDiskCustomerKeyUri: String? = null, val nodeCount: Int? = null, val provisionError: CassandraErrorResponse? = null, val provisioningState: String? = null, val seedNodes: List<SeedNodeResponse>, val sku: String? = null)

Properties of a managed Cassandra data center.

data class DataTransferRegionalServiceResourceResponse(val location: String, val name: String, val status: String)

Resource for a regional service location.

data class DataTransferServiceResourcePropertiesResponse(val creationTime: String, val instanceCount: Int? = null, val instanceSize: String? = null, val locations: List<DataTransferRegionalServiceResourceResponse>, val serviceType: String, val status: String)

Properties for DataTransferServiceResource.

Link copied to clipboard
data class ExcludedPathResponse(val path: String? = null)
Link copied to clipboard
data class FailoverPolicyResponse(val failoverPriority: Int? = null, val id: String, val locationName: String? = null)

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

Link copied to clipboard
data class FirewallRulePropertiesResponse(val endIpAddress: String, val provisioningState: String, val startIpAddress: String)

The properties of a mongo cluster firewall rule.

Link copied to clipboard
data class GetCassandraClusterResult(val id: String, val identity: ManagedCassandraManagedServiceIdentityResponse? = null, val location: String? = null, val name: String, val properties: ClusterResourceResponseProperties, val tags: Map<String, String>? = null, val type: String)

Representation of a managed Cassandra cluster.

Link copied to clipboard
data class GetCassandraDataCenterResult(val id: String, val name: String, val properties: DataCenterResourceResponseProperties, val type: String)

A managed Cassandra data center.

data class GetCassandraResourceCassandraKeyspaceResult(val id: String, val location: String? = null, val name: String, val options: CassandraKeyspaceGetPropertiesResponseOptions? = null, val resource: CassandraKeyspaceGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB Cassandra keyspace.

Link copied to clipboard
data class GetCassandraResourceCassandraTableResult(val id: String, val location: String? = null, val name: String, val options: CassandraTableGetPropertiesResponseOptions? = null, val resource: CassandraTableGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB Cassandra table.

Link copied to clipboard
data class GetCassandraResourceCassandraViewResult(val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String? = null, val name: String, val options: CassandraViewGetPropertiesResponseOptions? = null, val resource: CassandraViewGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB Cassandra view.

Link copied to clipboard
data class GetDatabaseAccountResult(val analyticalStorageConfiguration: AnalyticalStorageConfigurationResponse? = null, val apiProperties: ApiPropertiesResponse? = null, val backupPolicy: Either<ContinuousModeBackupPolicyResponse, PeriodicModeBackupPolicyResponse>? = null, val capabilities: List<CapabilityResponse>? = null, val capacity: CapacityResponse? = null, val connectorOffer: String? = null, val consistencyPolicy: ConsistencyPolicyResponse? = null, val cors: List<CorsPolicyResponse>? = null, val createMode: String? = null, val databaseAccountOfferType: String, val defaultIdentity: String? = null, val disableKeyBasedMetadataWriteAccess: Boolean? = null, val disableLocalAuth: Boolean? = null, val documentEndpoint: String, val enableAnalyticalStorage: Boolean? = null, val enableAutomaticFailover: Boolean? = null, val enableCassandraConnector: Boolean? = null, val enableFreeTier: Boolean? = null, val enableMultipleWriteLocations: Boolean? = null, val enablePartitionMerge: Boolean? = null, val failoverPolicies: List<FailoverPolicyResponse>, val id: String, val identity: ManagedServiceIdentityResponse? = null, val instanceId: String, val ipRules: List<IpAddressOrRangeResponse>? = null, val isVirtualNetworkFilterEnabled: Boolean? = null, val keyVaultKeyUri: String? = null, val keysMetadata: DatabaseAccountKeysMetadataResponse, val kind: String? = null, val location: String? = null, val locations: List<LocationResponse>, val minimalTlsVersion: String? = null, val name: String, val networkAclBypass: String? = null, val networkAclBypassResourceIds: List<String>? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>, val provisioningState: String, val publicNetworkAccess: String? = null, val readLocations: List<LocationResponse>, val restoreParameters: RestoreParametersResponse? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val virtualNetworkRules: List<VirtualNetworkRuleResponse>? = null, val writeLocations: List<LocationResponse>)

An Azure Cosmos DB database account.

Link copied to clipboard
data class GetFirewallRuleResult(val id: String, val name: String, val properties: FirewallRulePropertiesResponse, val systemData: SystemDataResponse, val type: String)

Represents a mongo cluster firewall rule.

Link copied to clipboard
data class GetGraphResourceGraphResult(val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String? = null, val name: String, val options: GraphResourceGetPropertiesResponseOptions? = null, val resource: GraphResourceGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB Graph resource.

Link copied to clipboard
data class GetGremlinResourceGremlinDatabaseResult(val id: String, val location: String? = null, val name: String, val options: GremlinDatabaseGetPropertiesResponseOptions? = null, val resource: GremlinDatabaseGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB Gremlin database.

Link copied to clipboard
data class GetGremlinResourceGremlinGraphResult(val id: String, val location: String? = null, val name: String, val options: GremlinGraphGetPropertiesResponseOptions? = null, val resource: GremlinGraphGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB Gremlin graph.

Link copied to clipboard
data class GetMongoClusterFirewallRuleResult(val endIpAddress: String, val id: String, val name: String, val provisioningState: String, val startIpAddress: String, val systemData: SystemDataResponse, val type: String)

Represents a mongo cluster firewall rule.

Link copied to clipboard
data class GetMongoClusterResult(val administratorLogin: String? = null, val clusterStatus: String, val connectionString: String, val earliestRestoreTime: String, val id: String, val location: String, val name: String, val nodeGroupSpecs: List<NodeGroupSpecResponse>? = null, val provisioningState: String, val serverVersion: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Represents a mongo cluster resource.

data class GetMongoDBResourceMongoDBCollectionResult(val id: String, val location: String? = null, val name: String, val options: MongoDBCollectionGetPropertiesResponseOptions? = null, val resource: MongoDBCollectionGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB MongoDB collection.

Link copied to clipboard
data class GetMongoDBResourceMongoDBDatabaseResult(val id: String, val location: String? = null, val name: String, val options: MongoDBDatabaseGetPropertiesResponseOptions? = null, val resource: MongoDBDatabaseGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB MongoDB database.

data class GetMongoDBResourceMongoRoleDefinitionResult(val databaseName: String? = null, val id: String, val name: String, val privileges: List<PrivilegeResponse>? = null, val roleName: String? = null, val roles: List<RoleResponse>? = null, val type: String)

An Azure Cosmos DB Mongo Role Definition.

data class GetMongoDBResourceMongoUserDefinitionResult(val customData: String? = null, val databaseName: String? = null, val id: String, val mechanisms: String? = null, val name: String, val password: String? = null, val roles: List<RoleResponse>? = null, val type: String, val userName: String? = null)

An Azure Cosmos DB User Definition

Link copied to clipboard
data class GetNotebookWorkspaceResult(val id: String, val name: String, val notebookServerEndpoint: String, val status: String, val type: String)

A notebook workspace resource

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val groupId: String? = null, val id: String, val name: String, val privateEndpoint: PrivateEndpointPropertyResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStatePropertyResponse? = null, val provisioningState: String? = null, val type: String)

A private endpoint connection

Link copied to clipboard
data class GetServiceResult(val id: String, val name: String, val properties: Any, val type: String)

Properties for the database account.

Link copied to clipboard
data class GetSqlResourceSqlContainerResult(val id: String, val location: String? = null, val name: String, val options: SqlContainerGetPropertiesResponseOptions? = null, val resource: SqlContainerGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB container.

Link copied to clipboard
data class GetSqlResourceSqlDatabaseResult(val id: String, val location: String? = null, val name: String, val options: SqlDatabaseGetPropertiesResponseOptions? = null, val resource: SqlDatabaseGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB SQL database.

Link copied to clipboard
data class GetSqlResourceSqlRoleAssignmentResult(val id: String, val name: String, val principalId: String? = null, val roleDefinitionId: String? = null, val scope: String? = null, val type: String)

An Azure Cosmos DB Role Assignment

Link copied to clipboard
data class GetSqlResourceSqlRoleDefinitionResult(val assignableScopes: List<String>? = null, val id: String, val name: String, val permissions: List<PermissionResponse>? = null, val roleName: String? = null, val type: String)

An Azure Cosmos DB SQL Role Definition.

Link copied to clipboard
data class GetSqlResourceSqlStoredProcedureResult(val id: String, val location: String? = null, val name: String, val resource: SqlStoredProcedureGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB storedProcedure.

Link copied to clipboard
data class GetSqlResourceSqlTriggerResult(val id: String, val location: String? = null, val name: String, val resource: SqlTriggerGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB trigger.

data class GetSqlResourceSqlUserDefinedFunctionResult(val id: String, val location: String? = null, val name: String, val resource: SqlUserDefinedFunctionGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB userDefinedFunction.

Link copied to clipboard
data class GetTableResourceTableResult(val id: String, val location: String? = null, val name: String, val options: TableGetPropertiesResponseOptions? = null, val resource: TableGetPropertiesResponseResource? = null, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB Table.

data class GetTableResourceTableRoleAssignmentResult(val id: String, val name: String, val principalId: String? = null, val provisioningState: String, val roleDefinitionId: String? = null, val scope: String? = null, val systemData: SystemDataResponse, val type: String)

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

data class GetTableResourceTableRoleDefinitionResult(val assignableScopes: List<String>? = null, val id: String, val name: String, val permissions: List<PermissionResponse>? = null, val roleName: String? = null, val systemData: SystemDataResponse, val type: String)

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

Link copied to clipboard
data class GetThroughputPoolAccountResult(val accountInstanceId: String, val accountLocation: String? = null, val accountResourceIdentifier: String? = null, val id: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

An Azure Cosmos DB Throughputpool Account

Link copied to clipboard
data class GetThroughputPoolResult(val id: String, val location: String, val maxThroughput: Int? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

An Azure Cosmos DB Throughputpool.

data class GraphAPIComputeRegionalServiceResourceResponse(val graphApiComputeEndpoint: String, val location: String, val name: String, val status: String)

Resource for a regional service location.

data class GraphAPIComputeServiceResourcePropertiesResponse(val creationTime: String, val graphApiComputeEndpoint: String? = null, val instanceCount: Int? = null, val instanceSize: String? = null, val locations: List<GraphAPIComputeRegionalServiceResourceResponse>, val serviceType: String, val status: String)

Properties for GraphAPIComputeServiceResource.

data class GraphResourceGetPropertiesResponseOptions(val autoscaleSettings: AutoscaleSettingsResponse? = null, val throughput: Int? = null)
data class GremlinDatabaseGetPropertiesResponseOptions(val autoscaleSettings: AutoscaleSettingsResponse? = null, val throughput: Int? = null)
data class GremlinDatabaseGetPropertiesResponseResource(val etag: String, val id: String, val rid: String, val ts: Double)
Link copied to clipboard
data class GremlinDatabaseRestoreResourceResponse(val databaseName: String? = null, val graphNames: List<String>? = null)

Specific Gremlin Databases to restore.

Link copied to clipboard
data class GremlinGraphGetPropertiesResponseOptions(val autoscaleSettings: AutoscaleSettingsResponse? = null, val throughput: Int? = null)
data class GremlinGraphGetPropertiesResponseResource(val analyticalStorageTtl: Double? = null, val conflictResolutionPolicy: ConflictResolutionPolicyResponse? = null, val defaultTtl: Int? = null, val etag: String, val id: String, val indexingPolicy: IndexingPolicyResponse? = null, val partitionKey: ContainerPartitionKeyResponse? = null, val rid: String, val ts: Double, val uniqueKeyPolicy: UniqueKeyPolicyResponse? = null)
Link copied to clipboard
data class IncludedPathResponse(val indexes: List<IndexesResponse>? = null, val path: String? = null)

The paths that are included in indexing

Link copied to clipboard
data class IndexesResponse(val dataType: String? = null, val kind: String? = null, val precision: Int? = null)

The indexes for the path.

Link copied to clipboard
data class IndexingPolicyResponse(val automatic: Boolean? = null, val compositeIndexes: List<List<CompositePathResponse>>? = null, val excludedPaths: List<ExcludedPathResponse>? = null, val includedPaths: List<IncludedPathResponse>? = null, val indexingMode: String? = null, val spatialIndexes: List<SpatialSpecResponse>? = null)

Cosmos DB indexing policy

Link copied to clipboard
data class IpAddressOrRangeResponse(val ipAddressOrRange: String? = null)

IpAddressOrRange object

data class ListDatabaseAccountConnectionStringsResult(val connectionStrings: List<DatabaseAccountConnectionStringResponse>? = null)

The connection strings for the given database account.

Link copied to clipboard
data class ListDatabaseAccountKeysResult(val primaryMasterKey: String, val primaryReadonlyMasterKey: String, val secondaryMasterKey: String, val secondaryReadonlyMasterKey: String)

The access keys for the given database account.

Link copied to clipboard
data class ListMongoClusterConnectionStringsResult(val connectionStrings: List<ConnectionStringResponse>)

The connection strings for the given mongo cluster.

data class ListNotebookWorkspaceConnectionInfoResult(val authToken: String, val notebookServerEndpoint: String)

The connection info for the given notebook workspace

Link copied to clipboard
data class LocationResponse(val documentEndpoint: String, val failoverPriority: Int? = null, val id: String, val isZoneRedundant: Boolean? = null, val locationName: String? = null, val provisioningState: String)

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

data class ManagedCassandraManagedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null)

Identity for the resource.

Link copied to clipboard
data class ManagedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, ManagedServiceIdentityResponseUserAssignedIdentities>? = null)

Identity for the resource.

data class ManagedServiceIdentityResponseUserAssignedIdentities(val clientId: String, val principalId: String)
data class MaterializedViewsBuilderRegionalServiceResourceResponse(val location: String, val name: String, val status: String)

Resource for a regional service location.

data class MaterializedViewsBuilderServiceResourcePropertiesResponse(val creationTime: String, val instanceCount: Int? = null, val instanceSize: String? = null, val locations: List<MaterializedViewsBuilderRegionalServiceResourceResponse>, val serviceType: String, val status: String)

Properties for MaterializedViewsBuilderServiceResource.

data class MongoDBCollectionGetPropertiesResponseOptions(val autoscaleSettings: AutoscaleSettingsResponse? = null, val throughput: Int? = null)
data class MongoDBCollectionGetPropertiesResponseResource(val analyticalStorageTtl: Int? = null, val etag: String, val id: String, val indexes: List<MongoIndexResponse>? = null, val rid: String, val shardKey: Map<String, String>? = null, val ts: Double)
data class MongoDBDatabaseGetPropertiesResponseOptions(val autoscaleSettings: AutoscaleSettingsResponse? = null, val throughput: Int? = null)
data class MongoDBDatabaseGetPropertiesResponseResource(val etag: String, val id: String, val rid: String, val ts: Double)
Link copied to clipboard
data class MongoIndexKeysResponse(val keys: List<String>? = null)

Cosmos DB MongoDB collection resource object

Link copied to clipboard
data class MongoIndexOptionsResponse(val expireAfterSeconds: Int? = null, val unique: Boolean? = null)

Cosmos DB MongoDB collection index options

Link copied to clipboard
data class MongoIndexResponse(val key: MongoIndexKeysResponse? = null, val options: MongoIndexOptionsResponse? = null)

Cosmos DB MongoDB collection index key

Link copied to clipboard
data class NodeGroupSpecResponse(val diskSizeGB: Double? = null, val enableHa: Boolean? = null, val kind: String? = null, val nodeCount: Int? = null, val sku: String? = null)

Specification for a node group.

Link copied to clipboard
data class PeriodicModeBackupPolicyResponse(val migrationState: BackupPolicyMigrationStateResponse? = null, val periodicModeProperties: PeriodicModePropertiesResponse? = null, val type: String)

The object representing periodic mode backup policy.

Link copied to clipboard
data class PeriodicModePropertiesResponse(val backupIntervalInMinutes: Int? = null, val backupRetentionIntervalInHours: Int? = null, val backupStorageRedundancy: String? = null)

Configuration values for periodic mode backup

Link copied to clipboard
data class PermissionResponse(val dataActions: List<String>? = null, val id: String? = null, val notDataActions: List<String>? = null)

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

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val groupId: String? = null, val id: String, val name: String, val privateEndpoint: PrivateEndpointPropertyResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStatePropertyResponse? = null, val provisioningState: String? = null, val type: String)

A private endpoint connection

Link copied to clipboard
data class PrivateEndpointPropertyResponse(val id: String? = null)

Private endpoint which the connection belongs to.

data class PrivateLinkServiceConnectionStatePropertyResponse(val actionsRequired: String, val description: String? = null, val status: String? = null)

Connection State of the Private Endpoint Connection.

Link copied to clipboard
data class PrivilegeResponse(val actions: List<String>? = null, val resource: PrivilegeResponseResource? = null)

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

Link copied to clipboard
data class PrivilegeResponseResource(val collection: String? = null, val db: String? = null)

An Azure Cosmos DB Mongo DB Resource.

Link copied to clipboard
data class RestoreParametersResponse(val databasesToRestore: List<DatabaseRestoreResourceResponse>? = null, val gremlinDatabasesToRestore: List<GremlinDatabaseRestoreResourceResponse>? = null, val restoreMode: String? = null, val restoreSource: String? = null, val restoreTimestampInUtc: String? = null, val tablesToRestore: List<String>? = null)

Parameters to indicate the information about the restore.

Link copied to clipboard
data class RoleResponse(val db: String? = null, val role: String? = null)

The set of roles permitted through this Role Definition.

Link copied to clipboard
data class SeedNodeResponse(val ipAddress: String? = null)
Link copied to clipboard
data class SpatialSpecResponse(val path: String? = null, val types: List<String>? = null)
Link copied to clipboard
data class SqlContainerGetPropertiesResponseOptions(val autoscaleSettings: AutoscaleSettingsResponse? = null, val throughput: Int? = null)
data class SqlContainerGetPropertiesResponseResource(val analyticalStorageTtl: Double? = null, val clientEncryptionPolicy: ClientEncryptionPolicyResponse? = null, val conflictResolutionPolicy: ConflictResolutionPolicyResponse? = null, val defaultTtl: Int? = null, val etag: String, val id: String, val indexingPolicy: IndexingPolicyResponse? = null, val partitionKey: ContainerPartitionKeyResponse? = null, val rid: String, val ts: Double, val uniqueKeyPolicy: UniqueKeyPolicyResponse? = null)
Link copied to clipboard
data class SqlDatabaseGetPropertiesResponseOptions(val autoscaleSettings: AutoscaleSettingsResponse? = null, val throughput: Int? = null)
Link copied to clipboard
data class SqlDatabaseGetPropertiesResponseResource(val colls: String? = null, val etag: String, val id: String, val rid: String, val ts: Double, val users: String? = null)
data class SqlDedicatedGatewayRegionalServiceResourceResponse(val location: String, val name: String, val sqlDedicatedGatewayEndpoint: String, val status: String)

Resource for a regional service location.

data class SqlDedicatedGatewayServiceResourcePropertiesResponse(val creationTime: String, val instanceCount: Int? = null, val instanceSize: String? = null, val locations: List<SqlDedicatedGatewayRegionalServiceResourceResponse>, val serviceType: String, val sqlDedicatedGatewayEndpoint: String? = null, val status: String)

Properties for SqlDedicatedGatewayServiceResource.

data class SqlStoredProcedureGetPropertiesResponseResource(val body: String? = null, val etag: String, val id: String, val rid: String, val ts: Double)
Link copied to clipboard
data class SqlTriggerGetPropertiesResponseResource(val body: String? = null, val etag: String, val id: String, val rid: String, val triggerOperation: String? = null, val triggerType: String? = null, val ts: Double)
data class SqlUserDefinedFunctionGetPropertiesResponseResource(val body: String? = null, val etag: String, val id: String, val rid: String, val ts: Double)
Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TableGetPropertiesResponseOptions(val autoscaleSettings: AutoscaleSettingsResponse? = null, val throughput: Int? = null)
Link copied to clipboard
data class TableGetPropertiesResponseResource(val etag: String, val id: String, val rid: String, val ts: Double)
Link copied to clipboard
data class UniqueKeyPolicyResponse(val uniqueKeys: List<UniqueKeyResponse>? = null)

The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

Link copied to clipboard
data class UniqueKeyResponse(val paths: List<String>? = null)

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

Link copied to clipboard
data class VirtualNetworkRuleResponse(val id: String? = null, val ignoreMissingVNetServiceEndpoint: Boolean? = null)

Virtual Network ACL Rule object