@kengachu-pulumi/azure-native-documentdb
Version:
Pulumi Azure Native package for documentdb
1,616 lines • 53.4 kB
TypeScript
/**
* The metadata related to an access key for a given database account.
*/
export interface AccountKeyMetadataResponse {
/**
* Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18.
*/
generationTime: string;
}
/**
* Analytical storage specific properties.
*/
export interface AnalyticalStorageConfigurationResponse {
/**
* Describes the types of schema for analytical storage.
*/
schemaType?: string;
}
export interface ApiPropertiesResponse {
/**
* Describes the ServerVersion of an a MongoDB account.
*/
serverVersion?: string;
}
/**
* Ldap authentication method properties. This feature is in preview.
*/
export interface AuthenticationMethodLdapPropertiesResponse {
/**
* Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
*/
connectionTimeoutInMs?: number;
/**
* Distinguished name of the object to start the recursive search of users from.
*/
searchBaseDistinguishedName?: string;
/**
* Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
*/
searchFilterTemplate?: string;
serverCertificates?: CertificateResponse[];
/**
* Hostname of the LDAP server.
*/
serverHostname?: string;
/**
* Port of the LDAP server.
*/
serverPort?: number;
/**
* Distinguished name of the look up user account, who can look up user details on authentication.
*/
serviceUserDistinguishedName?: string;
/**
* Password of the look up user.
*/
serviceUserPassword?: string;
}
export interface AutoscaleSettingsResponse {
/**
* Represents maximum throughput, the resource can scale up to.
*/
maxThroughput?: number;
}
/**
* The object representing the state of the migration between the backup policies.
*/
export interface BackupPolicyMigrationStateResponse {
/**
* Time at which the backup policy migration started (ISO-8601 format).
*/
startTime?: string;
/**
* Describes the status of migration between backup policy types.
*/
status?: string;
/**
* Describes the target backup policy type of the backup policy migration.
*/
targetType?: string;
}
/**
* Cosmos DB capability object
*/
export interface CapabilityResponse {
/**
* Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin".
*/
name?: string;
}
/**
* The object that represents all properties related to capacity enforcement on an account.
*/
export interface CapacityResponse {
/**
* The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.
*/
totalThroughputLimit?: number;
}
export interface CassandraErrorResponse {
/**
* Additional information about the error.
*/
additionalErrorInfo?: string;
/**
* The code of error that occurred.
*/
code?: string;
/**
* The message of the error.
*/
message?: string;
/**
* The target resource of the error.
*/
target?: string;
}
export interface CassandraKeyspaceGetPropertiesResponseOptions {
/**
* Specifies the Autoscale settings.
*/
autoscaleSettings?: AutoscaleSettingsResponse;
/**
* Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
*/
throughput?: number;
}
export interface CassandraKeyspaceGetPropertiesResponseResource {
/**
* A system generated property representing the resource etag required for optimistic concurrency control.
*/
etag: string;
/**
* Name of the Cosmos DB Cassandra keyspace
*/
id: string;
/**
* A system generated property. A unique identifier.
*/
rid: string;
/**
* A system generated property that denotes the last updated timestamp of the resource.
*/
ts: number;
}
/**
* Cosmos DB Cassandra table partition key
*/
export interface CassandraPartitionKeyResponse {
/**
* Name of the Cosmos DB Cassandra table partition key
*/
name?: string;
}
/**
* Cosmos DB Cassandra table schema
*/
export interface CassandraSchemaResponse {
/**
* List of cluster key.
*/
clusterKeys?: ClusterKeyResponse[];
/**
* List of Cassandra table columns.
*/
columns?: ColumnResponse[];
/**
* List of partition key.
*/
partitionKeys?: CassandraPartitionKeyResponse[];
}
export interface CassandraTableGetPropertiesResponseOptions {
/**
* Specifies the Autoscale settings.
*/
autoscaleSettings?: AutoscaleSettingsResponse;
/**
* Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
*/
throughput?: number;
}
export interface CassandraTableGetPropertiesResponseResource {
/**
* Analytical TTL.
*/
analyticalStorageTtl?: number;
/**
* Time to live of the Cosmos DB Cassandra table
*/
defaultTtl?: number;
/**
* A system generated property representing the resource etag required for optimistic concurrency control.
*/
etag: string;
/**
* Name of the Cosmos DB Cassandra table
*/
id: string;
/**
* A system generated property. A unique identifier.
*/
rid: string;
/**
* Schema of the Cosmos DB Cassandra table
*/
schema?: CassandraSchemaResponse;
/**
* A system generated property that denotes the last updated timestamp of the resource.
*/
ts: number;
}
export interface CassandraViewGetPropertiesResponseOptions {
/**
* Specifies the Autoscale settings.
*/
autoscaleSettings?: AutoscaleSettingsResponse;
/**
* Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
*/
throughput?: number;
}
export interface CassandraViewGetPropertiesResponseResource {
/**
* A system generated property representing the resource etag required for optimistic concurrency control.
*/
etag: string;
/**
* Name of the Cosmos DB Cassandra view
*/
id: string;
/**
* A system generated property. A unique identifier.
*/
rid: string;
/**
* A system generated property that denotes the last updated timestamp of the resource.
*/
ts: number;
/**
* View Definition of the Cosmos DB Cassandra view
*/
viewDefinition: string;
}
export interface CertificateResponse {
/**
* PEM formatted public key.
*/
pem?: string;
}
/**
* .
*/
export interface ClientEncryptionIncludedPathResponse {
/**
* The identifier of the Client Encryption Key to be used to encrypt the path.
*/
clientEncryptionKeyId: string;
/**
* The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256.
*/
encryptionAlgorithm: string;
/**
* The type of encryption to be performed. Eg - Deterministic, Randomized.
*/
encryptionType: string;
/**
* Path that needs to be encrypted.
*/
path: string;
}
/**
* Cosmos DB client encryption policy.
*/
export interface ClientEncryptionPolicyResponse {
/**
* Paths of the item that need encryption along with path-specific settings.
*/
includedPaths: ClientEncryptionIncludedPathResponse[];
/**
* Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption.
*/
policyFormatVersion: number;
}
/**
* Cosmos DB Cassandra table cluster key
*/
export interface ClusterKeyResponse {
/**
* Name of the Cosmos DB Cassandra table cluster key
*/
name?: string;
/**
* Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc"
*/
orderBy?: string;
}
/**
* Properties of a managed Cassandra cluster.
*/
export interface ClusterResourceResponseProperties {
/**
* 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'.
*/
authenticationMethod?: string;
/**
* Whether Cassandra audit logging is enabled
*/
cassandraAuditLoggingEnabled?: boolean;
/**
* Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
*/
cassandraVersion?: string;
/**
* List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
*/
clientCertificates?: CertificateResponse[];
/**
* If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
*/
clusterNameOverride?: string;
/**
* Whether the cluster and associated data centers has been deallocated.
*/
deallocated?: boolean;
/**
* Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'
*/
delegatedManagementSubnetId?: string;
/**
* List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
*/
externalGossipCertificates?: CertificateResponse[];
/**
* List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
*/
externalSeedNodes?: SeedNodeResponse[];
/**
* List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property.
*/
gossipCertificates: CertificateResponse[];
/**
* (Deprecated) Number of hours to wait between taking a backup of the cluster.
*/
hoursBetweenBackups?: number;
/**
* Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
*/
prometheusEndpoint?: SeedNodeResponse;
/**
* Error related to resource provisioning.
*/
provisionError?: CassandraErrorResponse;
/**
* The status of the resource at the time the operation was called.
*/
provisioningState?: string;
/**
* Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
*/
repairEnabled?: boolean;
/**
* List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes.
*/
seedNodes: SeedNodeResponse[];
}
/**
* Cosmos DB Cassandra table column
*/
export interface ColumnResponse {
/**
* Name of the Cosmos DB Cassandra table column
*/
name?: string;
/**
* Type of the Cosmos DB Cassandra table column
*/
type?: string;
}
export interface CompositePathResponse {
/**
* Sort order for composite paths.
*/
order?: string;
/**
* The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
*/
path?: string;
}
/**
* The conflict resolution policy for the container.
*/
export interface ConflictResolutionPolicyResponse {
/**
* The conflict resolution path in the case of LastWriterWins mode.
*/
conflictResolutionPath?: string;
/**
* The procedure to resolve conflicts in the case of custom mode.
*/
conflictResolutionProcedure?: string;
/**
* Indicates the conflict resolution mode.
*/
mode?: string;
}
/**
* conflictResolutionPolicyResponseProvideDefaults sets the appropriate defaults for ConflictResolutionPolicyResponse
*/
export declare function conflictResolutionPolicyResponseProvideDefaults(val: ConflictResolutionPolicyResponse): ConflictResolutionPolicyResponse;
/**
* Connection string for the mongo cluster
*/
export interface ConnectionStringResponse {
/**
* Value of the connection string
*/
connectionString: string;
/**
* Description of the connection string
*/
description: string;
}
/**
* The consistency policy for the Cosmos DB database account.
*/
export interface ConsistencyPolicyResponse {
/**
* The default consistency level and configuration settings of the Cosmos DB account.
*/
defaultConsistencyLevel: string;
/**
* When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
*/
maxIntervalInSeconds?: number;
/**
* When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.
*/
maxStalenessPrefix?: number;
}
/**
* The configuration of the partition key to be used for partitioning data into multiple partitions
*/
export interface ContainerPartitionKeyResponse {
/**
* Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create
*/
kind?: string;
/**
* List of paths using which data within the container can be partitioned
*/
paths?: string[];
/**
* Indicates if the container is using a system generated partition key
*/
systemKey: boolean;
/**
* Indicates the version of the partition key definition
*/
version?: number;
}
/**
* containerPartitionKeyResponseProvideDefaults sets the appropriate defaults for ContainerPartitionKeyResponse
*/
export declare function containerPartitionKeyResponseProvideDefaults(val: ContainerPartitionKeyResponse): ContainerPartitionKeyResponse;
/**
* The object representing continuous mode backup policy.
*/
export interface ContinuousModeBackupPolicyResponse {
/**
* Configuration values for continuous mode backup
*/
continuousModeProperties?: ContinuousModePropertiesResponse;
/**
* The object representing the state of the migration between the backup policies.
*/
migrationState?: BackupPolicyMigrationStateResponse;
/**
* Describes the mode of backups.
* Expected value is 'Continuous'.
*/
type: "Continuous";
}
/**
* Configuration values for periodic mode backup
*/
export interface ContinuousModePropertiesResponse {
/**
* Enum to indicate type of Continuous backup mode
*/
tier?: string;
}
/**
* The CORS policy for the Cosmos DB database account.
*/
export interface CorsPolicyResponse {
/**
* The request headers that the origin domain may specify on the CORS request.
*/
allowedHeaders?: string;
/**
* The methods (HTTP request verbs) that the origin domain may use for a CORS request.
*/
allowedMethods?: string;
/**
* The origin domains that are permitted to make a request against the service via CORS.
*/
allowedOrigins: string;
/**
* The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
*/
exposedHeaders?: string;
/**
* The maximum amount time that a browser should cache the preflight OPTIONS request.
*/
maxAgeInSeconds?: number;
}
/**
* Properties of a managed Cassandra data center.
*/
export interface DataCenterResourceResponseProperties {
/**
* Ldap authentication method properties. This feature is in preview.
*/
authenticationMethodLdapProperties?: AuthenticationMethodLdapPropertiesResponse;
/**
* If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.
*/
availabilityZone?: boolean;
/**
* Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
*/
backupStorageCustomerKeyUri?: string;
/**
* A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed.
*/
base64EncodedCassandraYamlFragment?: string;
/**
* The region this data center should be created in.
*/
dataCenterLocation?: string;
/**
* Whether the data center has been deallocated.
*/
deallocated?: boolean;
/**
* Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'.
*/
delegatedSubnetId?: string;
/**
* Number of disks attached to each node. Default is 4.
*/
diskCapacity?: number;
/**
* Disk SKU used for data centers. Default value is P30.
*/
diskSku?: string;
/**
* Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key.
*/
managedDiskCustomerKeyUri?: string;
/**
* The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster.
*/
nodeCount?: number;
/**
* Error related to resource provisioning.
*/
provisionError?: CassandraErrorResponse;
/**
* The status of the resource at the time the operation was called.
*/
provisioningState?: string;
/**
* IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster.
*/
seedNodes: SeedNodeResponse[];
/**
* Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2
*/
sku?: string;
}
/**
* Resource for a regional service location.
*/
export interface DataTransferRegionalServiceResourceResponse {
/**
* The location name.
*/
location: string;
/**
* The regional service name.
*/
name: string;
/**
* Describes the status of a service.
*/
status: string;
}
/**
* Properties for DataTransferServiceResource.
*/
export interface DataTransferServiceResourcePropertiesResponse {
/**
* Time of the last state change (ISO-8601 format).
*/
creationTime: string;
/**
* Instance count for the service.
*/
instanceCount?: number;
/**
* Instance type for the service.
*/
instanceSize?: string;
/**
* An array that contains all of the locations for the service.
*/
locations: DataTransferRegionalServiceResourceResponse[];
/**
* ServiceType for the service.
* Expected value is 'DataTransfer'.
*/
serviceType: "DataTransfer";
/**
* Describes the status of a service.
*/
status: string;
}
/**
* Connection string for the Cosmos DB account
*/
export interface DatabaseAccountConnectionStringResponse {
/**
* Value of the connection string
*/
connectionString: string;
/**
* Description of the connection string
*/
description: string;
/**
* Kind of the connection string key
*/
keyKind: string;
/**
* Type of the connection string
*/
type: string;
}
/**
* The metadata related to each access key for the given Cosmos DB database account.
*/
export interface DatabaseAccountKeysMetadataResponse {
/**
* The metadata related to the Primary Read-Write Key for the given Cosmos DB database account.
*/
primaryMasterKey: AccountKeyMetadataResponse;
/**
* The metadata related to the Primary Read-Only Key for the given Cosmos DB database account.
*/
primaryReadonlyMasterKey: AccountKeyMetadataResponse;
/**
* The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account.
*/
secondaryMasterKey: AccountKeyMetadataResponse;
/**
* The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account.
*/
secondaryReadonlyMasterKey: AccountKeyMetadataResponse;
}
/**
* Specific Databases to restore.
*/
export interface DatabaseRestoreResourceResponse {
/**
* The names of the collections available for restore.
*/
collectionNames?: string[];
/**
* The name of the database available for restore.
*/
databaseName?: string;
}
export interface ExcludedPathResponse {
/**
* The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
*/
path?: string;
}
/**
* The failover policy for a given region of a database account.
*/
export interface FailoverPolicyResponse {
/**
* The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
*/
failoverPriority?: number;
/**
* The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.
*/
id: string;
/**
* The name of the region in which the database account exists.
*/
locationName?: string;
}
/**
* The properties of a mongo cluster firewall rule.
*/
export interface FirewallRulePropertiesResponse {
/**
* The end IP address of the mongo cluster firewall rule. Must be IPv4 format.
*/
endIpAddress: string;
/**
* The provisioning state of the firewall rule.
*/
provisioningState: string;
/**
* The start IP address of the mongo cluster firewall rule. Must be IPv4 format.
*/
startIpAddress: string;
}
/**
* Resource for a regional service location.
*/
export interface GraphAPIComputeRegionalServiceResourceResponse {
/**
* The regional endpoint for GraphAPICompute.
*/
graphApiComputeEndpoint: string;
/**
* The location name.
*/
location: string;
/**
* The regional service name.
*/
name: string;
/**
* Describes the status of a service.
*/
status: string;
}
/**
* Properties for GraphAPIComputeServiceResource.
*/
export interface GraphAPIComputeServiceResourcePropertiesResponse {
/**
* Time of the last state change (ISO-8601 format).
*/
creationTime: string;
/**
* GraphAPICompute endpoint for the service.
*/
graphApiComputeEndpoint?: string;
/**
* Instance count for the service.
*/
instanceCount?: number;
/**
* Instance type for the service.
*/
instanceSize?: string;
/**
* An array that contains all of the locations for the service.
*/
locations: GraphAPIComputeRegionalServiceResourceResponse[];
/**
* ServiceType for the service.
* Expected value is 'GraphAPICompute'.
*/
serviceType: "GraphAPICompute";
/**
* Describes the status of a service.
*/
status: string;
}
export interface GraphResourceGetPropertiesResponseOptions {
/**
* Specifies the Autoscale settings.
*/
autoscaleSettings?: AutoscaleSettingsResponse;
/**
* Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
*/
throughput?: number;
}
export interface GraphResourceGetPropertiesResponseResource {
/**
* Name of the Cosmos DB Graph
*/
id: string;
}
export interface GremlinDatabaseGetPropertiesResponseOptions {
/**
* Specifies the Autoscale settings.
*/
autoscaleSettings?: AutoscaleSettingsResponse;
/**
* Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
*/
throughput?: number;
}
export interface GremlinDatabaseGetPropertiesResponseResource {
/**
* A system generated property representing the resource etag required for optimistic concurrency control.
*/
etag: string;
/**
* Name of the Cosmos DB Gremlin database
*/
id: string;
/**
* A system generated property. A unique identifier.
*/
rid: string;
/**
* A system generated property that denotes the last updated timestamp of the resource.
*/
ts: number;
}
/**
* Specific Gremlin Databases to restore.
*/
export interface GremlinDatabaseRestoreResourceResponse {
/**
* The name of the gremlin database available for restore.
*/
databaseName?: string;
/**
* The names of the graphs available for restore.
*/
graphNames?: string[];
}
export interface GremlinGraphGetPropertiesResponseOptions {
/**
* Specifies the Autoscale settings.
*/
autoscaleSettings?: AutoscaleSettingsResponse;
/**
* Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
*/
throughput?: number;
}
export interface GremlinGraphGetPropertiesResponseResource {
/**
* Analytical TTL.
*/
analyticalStorageTtl?: number;
/**
* The conflict resolution policy for the graph.
*/
conflictResolutionPolicy?: ConflictResolutionPolicyResponse;
/**
* Default time to live
*/
defaultTtl?: number;
/**
* A system generated property representing the resource etag required for optimistic concurrency control.
*/
etag: string;
/**
* Name of the Cosmos DB Gremlin graph
*/
id: string;
/**
* The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph
*/
indexingPolicy?: IndexingPolicyResponse;
/**
* The configuration of the partition key to be used for partitioning data into multiple partitions
*/
partitionKey?: ContainerPartitionKeyResponse;
/**
* A system generated property. A unique identifier.
*/
rid: string;
/**
* A system generated property that denotes the last updated timestamp of the resource.
*/
ts: number;
/**
* The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
*/
uniqueKeyPolicy?: UniqueKeyPolicyResponse;
}
/**
* gremlinGraphGetPropertiesResponseResourceProvideDefaults sets the appropriate defaults for GremlinGraphGetPropertiesResponseResource
*/
export declare function gremlinGraphGetPropertiesResponseResourceProvideDefaults(val: GremlinGraphGetPropertiesResponseResource): GremlinGraphGetPropertiesResponseResource;
/**
* The paths that are included in indexing
*/
export interface IncludedPathResponse {
/**
* List of indexes for this path
*/
indexes?: IndexesResponse[];
/**
* The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
*/
path?: string;
}
/**
* The indexes for the path.
*/
export interface IndexesResponse {
/**
* The datatype for which the indexing behavior is applied to.
*/
dataType?: string;
/**
* Indicates the type of index.
*/
kind?: string;
/**
* The precision of the index. -1 is maximum precision.
*/
precision?: number;
}
/**
* indexesResponseProvideDefaults sets the appropriate defaults for IndexesResponse
*/
export declare function indexesResponseProvideDefaults(val: IndexesResponse): IndexesResponse;
/**
* Cosmos DB indexing policy
*/
export interface IndexingPolicyResponse {
/**
* Indicates if the indexing policy is automatic
*/
automatic?: boolean;
/**
* List of composite path list
*/
compositeIndexes?: CompositePathResponse[][];
/**
* List of paths to exclude from indexing
*/
excludedPaths?: ExcludedPathResponse[];
/**
* List of paths to include in the indexing
*/
includedPaths?: IncludedPathResponse[];
/**
* Indicates the indexing mode.
*/
indexingMode?: string;
/**
* List of spatial specifics
*/
spatialIndexes?: SpatialSpecResponse[];
}
/**
* indexingPolicyResponseProvideDefaults sets the appropriate defaults for IndexingPolicyResponse
*/
export declare function indexingPolicyResponseProvideDefaults(val: IndexingPolicyResponse): IndexingPolicyResponse;
/**
* IpAddressOrRange object
*/
export interface IpAddressOrRangeResponse {
/**
* A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.
*/
ipAddressOrRange?: string;
}
/**
* A region in which the Azure Cosmos DB database account is deployed.
*/
export interface LocationResponse {
/**
* The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/
*/
documentEndpoint: string;
/**
* The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.
*/
failoverPriority?: number;
/**
* The unique identifier of the region within the database account. Example: <accountName>-<locationName>.
*/
id: string;
/**
* Flag to indicate whether or not this region is an AvailabilityZone region
*/
isZoneRedundant?: boolean;
/**
* The name of the region.
*/
locationName?: string;
/**
* The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.
*/
provisioningState: string;
}
/**
* Identity for the resource.
*/
export interface ManagedCassandraManagedServiceIdentityResponse {
/**
* The object id of the identity resource.
*/
principalId: string;
/**
* The tenant id of the resource.
*/
tenantId: string;
/**
* The type of the resource.
*/
type?: string;
}
/**
* Identity for the resource.
*/
export interface ManagedServiceIdentityResponse {
/**
* The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
*/
principalId: string;
/**
* The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
*/
tenantId: string;
/**
* 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.
*/
type?: string;
/**
* The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
*/
userAssignedIdentities?: {
[key: string]: ManagedServiceIdentityResponseUserAssignedIdentities;
};
}
export interface ManagedServiceIdentityResponseUserAssignedIdentities {
/**
* The client id of user assigned identity.
*/
clientId: string;
/**
* The principal id of user assigned identity.
*/
principalId: string;
}
/**
* Resource for a regional service location.
*/
export interface MaterializedViewsBuilderRegionalServiceResourceResponse {
/**
* The location name.
*/
location: string;
/**
* The regional service name.
*/
name: string;
/**
* Describes the status of a service.
*/
status: string;
}
/**
* Properties for MaterializedViewsBuilderServiceResource.
*/
export interface MaterializedViewsBuilderServiceResourcePropertiesResponse {
/**
* Time of the last state change (ISO-8601 format).
*/
creationTime: string;
/**
* Instance count for the service.
*/
instanceCount?: number;
/**
* Instance type for the service.
*/
instanceSize?: string;
/**
* An array that contains all of the locations for the service.
*/
locations: MaterializedViewsBuilderRegionalServiceResourceResponse[];
/**
* ServiceType for the service.
* Expected value is 'MaterializedViewsBuilder'.
*/
serviceType: "MaterializedViewsBuilder";
/**
* Describes the status of a service.
*/
status: string;
}
export interface MongoDBCollectionGetPropertiesResponseOptions {
/**
* Specifies the Autoscale settings.
*/
autoscaleSettings?: AutoscaleSettingsResponse;
/**
* Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
*/
throughput?: number;
}
export interface MongoDBCollectionGetPropertiesResponseResource {
/**
* Analytical TTL.
*/
analyticalStorageTtl?: number;
/**
* A system generated property representing the resource etag required for optimistic concurrency control.
*/
etag: string;
/**
* Name of the Cosmos DB MongoDB collection
*/
id: string;
/**
* List of index keys
*/
indexes?: MongoIndexResponse[];
/**
* A system generated property. A unique identifier.
*/
rid: string;
/**
* A key-value pair of shard keys to be applied for the request.
*/
shardKey?: {
[key: string]: string;
};
/**
* A system generated property that denotes the last updated timestamp of the resource.
*/
ts: number;
}
export interface MongoDBDatabaseGetPropertiesResponseOptions {
/**
* Specifies the Autoscale settings.
*/
autoscaleSettings?: AutoscaleSettingsResponse;
/**
* Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
*/
throughput?: number;
}
export interface MongoDBDatabaseGetPropertiesResponseResource {
/**
* A system generated property representing the resource etag required for optimistic concurrency control.
*/
etag: string;
/**
* Name of the Cosmos DB MongoDB database
*/
id: string;
/**
* A system generated property. A unique identifier.
*/
rid: string;
/**
* A system generated property that denotes the last updated timestamp of the resource.
*/
ts: number;
}
/**
* Cosmos DB MongoDB collection resource object
*/
export interface MongoIndexKeysResponse {
/**
* List of keys for each MongoDB collection in the Azure Cosmos DB service
*/
keys?: string[];
}
/**
* Cosmos DB MongoDB collection index options
*/
export interface MongoIndexOptionsResponse {
/**
* Expire after seconds
*/
expireAfterSeconds?: number;
/**
* Is unique or not
*/
unique?: boolean;
}
/**
* Cosmos DB MongoDB collection index key
*/
export interface MongoIndexResponse {
/**
* Cosmos DB MongoDB collection index keys
*/
key?: MongoIndexKeysResponse;
/**
* Cosmos DB MongoDB collection index key options
*/
options?: MongoIndexOptionsResponse;
}
/**
* Specification for a node group.
*/
export interface NodeGroupSpecResponse {
/**
* The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024.
*/
diskSizeGB?: number;
/**
* Whether high availability is enabled on the node group.
*/
enableHa?: boolean;
/**
* The node type deployed in the node group.
*/
kind?: string;
/**
* The number of nodes in the node group.
*/
nodeCount?: number;
/**
* The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'.
*/
sku?: string;
}
/**
* The object representing periodic mode backup policy.
*/
export interface PeriodicModeBackupPolicyResponse {
/**
* The object representing the state of the migration between the backup policies.
*/
migrationState?: BackupPolicyMigrationStateResponse;
/**
* Configuration values for periodic mode backup
*/
periodicModeProperties?: PeriodicModePropertiesResponse;
/**
* Describes the mode of backups.
* Expected value is 'Periodic'.
*/
type: "Periodic";
}
/**
* Configuration values for periodic mode backup
*/
export interface PeriodicModePropertiesResponse {
/**
* An integer representing the interval in minutes between two backups
*/
backupIntervalInMinutes?: number;
/**
* An integer representing the time (in hours) that each backup is retained
*/
backupRetentionIntervalInHours?: number;
/**
* Enum to indicate type of backup residency
*/
backupStorageRedundancy?: string;
}
/**
* The set of data plane operations permitted through this Role Definition.
*/
export interface PermissionResponse {
/**
* An array of data actions that are allowed.
*/
dataActions?: string[];
/**
* The id for the permission.
*/
id?: string;
/**
* An array of data actions that are denied.
*/
notDataActions?: string[];
}
/**
* A private endpoint connection
*/
export interface PrivateEndpointConnectionResponse {
/**
* Group id of the private endpoint.
*/
groupId?: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
id: string;
/**
* The name of the resource
*/
name: string;
/**
* Private endpoint which the connection belongs to.
*/
privateEndpoint?: PrivateEndpointPropertyResponse;
/**
* Connection State of the Private Endpoint Connection.
*/
privateLinkServiceConnectionState?: PrivateLinkServiceConnectionStatePropertyResponse;
/**
* Provisioning state of the private endpoint.
*/
provisioningState?: string;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
type: string;
}
/**
* Private endpoint which the connection belongs to.
*/
export interface PrivateEndpointPropertyResponse {
/**
* Resource id of the private endpoint.
*/
id?: string;
}
/**
* Connection State of the Private Endpoint Connection.
*/
export interface PrivateLinkServiceConnectionStatePropertyResponse {
/**
* Any action that is required beyond basic workflow (approve/ reject/ disconnect)
*/
actionsRequired: string;
/**
* The private link service connection description.
*/
description?: string;
/**
* The private link service connection status.
*/
status?: string;
}
/**
* The set of data plane operations permitted through this Role Definition.
*/
export interface PrivilegeResponse {
/**
* An array of actions that are allowed.
*/
actions?: string[];
/**
* An Azure Cosmos DB Mongo DB Resource.
*/
resource?: PrivilegeResponseResource;
}
/**
* An Azure Cosmos DB Mongo DB Resource.
*/
export interface PrivilegeResponseResource {
/**
* The collection name the role is applied.
*/
collection?: string;
/**
* The database name the role is applied.
*/
db?: string;
}
/**
* Parameters to indicate the information about the restore.
*/
export interface RestoreParametersResponse {
/**
* List of specific databases available for restore.
*/
databasesToRestore?: DatabaseRestoreResourceResponse[];
/**
* List of specific gremlin databases available for restore.
*/
gremlinDatabasesToRestore?: GremlinDatabaseRestoreResourceResponse[];
/**
* Describes the mode of the restore.
*/
restoreMode?: string;
/**
* The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}
*/
restoreSource?: string;
/**
* Time to which the account has to be restored (ISO-8601 format).
*/
restoreTimestampInUtc?: string;
/**
* List of specific tables available for restore.
*/
tablesToRestore?: string[];
}
/**
* The set of roles permitted through this Role Definition.
*/
export interface RoleResponse {
/**
* The database name the role is applied.
*/
db?: string;
/**
* The role name.
*/
role?: string;
}
export interface SeedNodeResponse {
/**
* IP address of this seed node.
*/
ipAddress?: string;
}
export interface SpatialSpecResponse {
/**
* The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)
*/
path?: string;
/**
* List of path's spatial type
*/
types?: string[];
}
export interface SqlContainerGetPropertiesResponseOptions {
/**
* Specifies the Autoscale settings.
*/
autoscaleSettings?: AutoscaleSettingsResponse;
/**
* Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
*/
throughput?: number;
}
export interface SqlContainerGetPropertiesResponseResource {
/**
* Analytical TTL.
*/
analyticalStorageTtl?: number;
/**
* The client encryption policy for the container.
*/
clientEncryptionPolicy?: ClientEncryptionPolicyResponse;
/**
* The conflict resolution policy for the container.
*/
conflictResolutionPolicy?: ConflictResolutionPolicyResponse;
/**
* Default time to live
*/
defaultTtl?: number;
/**
* A system generated property representing the resource etag required for optimistic concurrency control.
*/
etag: string;
/**
* Name of the Cosmos DB SQL container
*/
id: string;
/**
* The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container
*/
indexingPolicy?: IndexingPolicyResponse;
/**
* The configuration of the partition key to be used for partitioning data into multiple partitions
*/
partitionKey?: ContainerPartitionKeyResponse;
/**
* A system generated property. A unique identifier.
*/
rid: string;
/**
* A system generated property that denotes the last updated timestamp of the resource.
*/
ts: number;
/**
* The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.
*/
uniqueKeyPolicy?: UniqueKeyPolicyResponse;
}
/**
* sqlContainerGetPropertiesResponseResourceProvideDefaults sets the appropriate defaults for SqlContainerGetPropertiesResponseResource
*/
export declare function sqlContainerGetPropertiesResponseResourceProvideDefaults(val: SqlContainerGetPropertiesResponseResource): SqlContainerGetPropertiesResponseResource;
export interface SqlDatabaseGetPropertiesResponseOptions {
/**
* Specifies the Autoscale settings.
*/
autoscaleSettings?: AutoscaleSettingsResponse;
/**
* Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
*/
throughput?: number;
}
export interface SqlDatabaseGetPropertiesResponseResource {
/**
* A system generated property that specified the addressable path of the collections resource.
*/
colls?: string;
/**
* A system generated property representing the resource etag required for optimistic concurrency control.
*/
etag: string;
/**
* Name of the Cosmos DB SQL database
*/
id: string;
/**
* A system generated property. A unique identifier.
*/
rid: string;
/**
* A system generated property that denotes the last updated timestamp of the resource.
*/
ts: number;
/**
* A system generated property that specifies the addressable path of the users resource.
*/
users?: string;
}
/**
* Resource for a regional service location.
*/
export interface SqlDedicatedGatewayRegionalServiceResourceResponse {
/**
* The location name.
*/
location: string;
/**
* The regional service name.
*/
name: string;
/**
* The regional endpoint for SqlDedicatedGateway.
*/
sqlDedicatedGatewayEndpoint: string;
/**
* Describes the status of a service.
*/
status: string;
}
/**
* Properties for SqlDedicatedGatewayServiceResource.
*/
export interface SqlDedicatedGatewayServiceResourcePropertiesResponse {
/**
* Time of the last state change (ISO-8601 format).
*/
creationTime: string;
/**
* Instance count for the service.
*/
instanceCount?: number;
/**
* Instance type for the service.
*/
instanceSize?: string;
/**
* An array that contains all of the locations for the service.
*/
locations: SqlDedicatedGatewayRegionalServiceResourceResponse[];
/**
* ServiceType for the service.
* Expected value is 'SqlDedicatedGateway'.
*/
serviceType: "SqlDedicatedGateway";
/**
* SqlDedicatedGateway endpoint for the service.
*/
sqlDedicatedGatewayEndpoint?: string;
/**
* Describes the status of a service.
*/
status: string;
}
export interface SqlStoredProcedureGetPropertiesResponseResource {
/**
* Body of the Stored Procedure
*/
body?: string;
/**
* A system generated property representing the resource etag required for optimistic concurrency control.
*/
etag: string;
/**
* Name of the Cosmos DB SQL storedProcedure
*/
id: string;
/**
* A system generated property. A unique identifier.
*/
rid: string;
/**
* A system generated property that denotes the last updated timestamp of the resource.
*/
ts: number;
}
export interface SqlTriggerGetPropertiesResponseResource {
/**
* Body of the Trigger
*/
body?: string;
/**
* A system generated property representing the resource etag required for optimistic concurrency control.
*/
etag: string;
/**
* Name of the Cosmos DB SQL trigger
*/
id: string;
/**
* A system generated property. A unique identifier.
*/
rid: string;
/**
* The operation the trigger is associated with
*/
triggerOperation?: string;
/**
* Type of the Trigger
*/
triggerTyp