documentdb.azure.com/v1beta20210515
documentdb.azure.com/v1beta20210515
Package v1beta20210515 contains API Schema definitions for the documentdb v1beta20210515 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2021-05-15" |
AnalyticalStorageConfiguration
(Appears on:DatabaseAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/AnalyticalStorageConfiguration
Field | Description |
---|---|
schemaType AnalyticalStorageConfigurationSchemaType |
AnalyticalStorageConfigurationARM
(Appears on:DatabaseAccountCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/AnalyticalStorageConfiguration
Field | Description |
---|---|
schemaType AnalyticalStorageConfigurationSchemaType |
AnalyticalStorageConfigurationSchemaType
(string
alias)
(Appears on:AnalyticalStorageConfiguration, AnalyticalStorageConfigurationARM)
Value | Description |
---|---|
"FullFidelity" |
|
"WellDefined" |
AnalyticalStorageConfiguration_Status
(Appears on:DatabaseAccountGetResults_Status)
Field | Description |
---|---|
schemaType AnalyticalStorageSchemaType_Status |
AnalyticalStorageConfiguration_StatusARM
(Appears on:DatabaseAccountGetProperties_StatusARM)
Field | Description |
---|---|
schemaType AnalyticalStorageSchemaType_Status |
AnalyticalStorageSchemaType_Status
(string
alias)
(Appears on:AnalyticalStorageConfiguration_Status, AnalyticalStorageConfiguration_StatusARM)
Value | Description |
---|---|
"FullFidelity" |
|
"WellDefined" |
ApiProperties
(Appears on:DatabaseAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ApiProperties
Field | Description |
---|---|
serverVersion ApiPropertiesServerVersion |
ServerVersion: Describes the ServerVersion of an a MongoDB account. |
ApiPropertiesARM
(Appears on:DatabaseAccountCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ApiProperties
Field | Description |
---|---|
serverVersion ApiPropertiesServerVersion |
ServerVersion: Describes the ServerVersion of an a MongoDB account. |
ApiPropertiesServerVersion
(string
alias)
(Appears on:ApiProperties, ApiPropertiesARM)
Value | Description |
---|---|
"3.2" |
|
"3.6" |
|
"4.0" |
ApiPropertiesStatusServerVersion
(string
alias)
(Appears on:ApiProperties_Status, ApiProperties_StatusARM)
Value | Description |
---|---|
"3.2" |
|
"3.6" |
|
"4.0" |
ApiProperties_Status
(Appears on:DatabaseAccountGetResults_Status)
Field | Description |
---|---|
serverVersion ApiPropertiesStatusServerVersion |
ServerVersion: Describes the ServerVersion of an a MongoDB account. |
ApiProperties_StatusARM
(Appears on:DatabaseAccountGetProperties_StatusARM)
Field | Description |
---|---|
serverVersion ApiPropertiesStatusServerVersion |
ServerVersion: Describes the ServerVersion of an a MongoDB account. |
AutoUpgradePolicyResource
(Appears on:AutoscaleSettingsResource)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/AutoUpgradePolicyResource
Field | Description |
---|---|
throughputPolicy ThroughputPolicyResource |
ThroughputPolicy: Cosmos DB resource throughput policy |
AutoUpgradePolicyResourceARM
(Appears on:AutoscaleSettingsResourceARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/AutoUpgradePolicyResource
Field | Description |
---|---|
throughputPolicy ThroughputPolicyResourceARM |
ThroughputPolicy: Cosmos DB resource throughput policy |
AutoUpgradePolicyResource_Status
(Appears on:AutoscaleSettingsResource_Status)
Field | Description |
---|---|
throughputPolicy ThroughputPolicyResource_Status |
ThroughputPolicy: Represents throughput policy which service must adhere to for auto-upgrade |
AutoUpgradePolicyResource_StatusARM
(Appears on:AutoscaleSettingsResource_StatusARM)
Field | Description |
---|---|
throughputPolicy ThroughputPolicyResource_StatusARM |
ThroughputPolicy: Represents throughput policy which service must adhere to for auto-upgrade |
AutoscaleSettings
(Appears on:CreateUpdateOptions)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/AutoscaleSettings
Field | Description |
---|---|
maxThroughput int |
MaxThroughput: Represents maximum throughput, the resource can scale up to. |
AutoscaleSettingsARM
(Appears on:CreateUpdateOptionsARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/AutoscaleSettings
Field | Description |
---|---|
maxThroughput int |
MaxThroughput: Represents maximum throughput, the resource can scale up to. |
AutoscaleSettingsResource
(Appears on:ThroughputSettingsResource)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/AutoscaleSettingsResource
Field | Description |
---|---|
autoUpgradePolicy AutoUpgradePolicyResource |
AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy |
maxThroughput int |
MaxThroughput: Represents maximum throughput container can scale up to. |
AutoscaleSettingsResourceARM
(Appears on:ThroughputSettingsResourceARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/AutoscaleSettingsResource
Field | Description |
---|---|
autoUpgradePolicy AutoUpgradePolicyResourceARM |
AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy |
maxThroughput int |
MaxThroughput: Represents maximum throughput container can scale up to. |
AutoscaleSettingsResource_Status
(Appears on:ThroughputSettingsGetProperties_Status_Resource)
Field | Description |
---|---|
autoUpgradePolicy AutoUpgradePolicyResource_Status |
AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy |
maxThroughput int |
MaxThroughput: Represents maximum throughput container can scale up to. |
targetMaxThroughput int |
TargetMaxThroughput: Represents target maximum throughput container can scale up to once offer is no longer in pending state. |
AutoscaleSettingsResource_StatusARM
(Appears on:ThroughputSettingsGetProperties_Status_ResourceARM)
Field | Description |
---|---|
autoUpgradePolicy AutoUpgradePolicyResource_StatusARM |
AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy |
maxThroughput int |
MaxThroughput: Represents maximum throughput container can scale up to. |
targetMaxThroughput int |
TargetMaxThroughput: Represents target maximum throughput container can scale up to once offer is no longer in pending state. |
AutoscaleSettings_Status
(Appears on:OptionsResource_Status)
Field | Description |
---|---|
maxThroughput int |
MaxThroughput: Represents maximum throughput, the resource can scale up to. |
AutoscaleSettings_StatusARM
(Appears on:OptionsResource_StatusARM)
Field | Description |
---|---|
maxThroughput int |
MaxThroughput: Represents maximum throughput, the resource can scale up to. |
BackupPolicy
(Appears on:DatabaseAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/BackupPolicy
Field | Description |
---|---|
continuousModeBackupPolicy ContinuousModeBackupPolicy |
Continuous: Mutually exclusive with all other properties |
periodicModeBackupPolicy PeriodicModeBackupPolicy |
Periodic: Mutually exclusive with all other properties |
BackupPolicyARM
(Appears on:DatabaseAccountCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/BackupPolicy
Field | Description |
---|---|
continuousModeBackupPolicy ContinuousModeBackupPolicyARM |
Continuous: Mutually exclusive with all other properties |
periodicModeBackupPolicy PeriodicModeBackupPolicyARM |
Periodic: Mutually exclusive with all other properties |
BackupPolicyType_Status
(string
alias)
(Appears on:BackupPolicy_Status, BackupPolicy_StatusARM)
Value | Description |
---|---|
"Continuous" |
|
"Periodic" |
BackupPolicy_Status
(Appears on:DatabaseAccountGetResults_Status)
Field | Description |
---|---|
type BackupPolicyType_Status |
BackupPolicy_StatusARM
(Appears on:DatabaseAccountGetProperties_StatusARM)
Field | Description |
---|---|
type BackupPolicyType_Status |
Capability
(Appears on:DatabaseAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/Capability
Field | Description |
---|---|
name string |
Name: Name of the Cosmos DB capability. For example, “name”: “EnableCassandra”. Current values also include “EnableTable” and “EnableGremlin”. |
CapabilityARM
(Appears on:DatabaseAccountCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/Capability
Field | Description |
---|---|
name string |
Name: Name of the Cosmos DB capability. For example, “name”: “EnableCassandra”. Current values also include “EnableTable” and “EnableGremlin”. |
Capability_Status
(Appears on:DatabaseAccountGetResults_Status)
Field | Description |
---|---|
name string |
Name: Name of the Cosmos DB capability. For example, “name”: “EnableCassandra”. Current values also include “EnableTable” and “EnableGremlin”. |
Capability_StatusARM
(Appears on:DatabaseAccountGetProperties_StatusARM)
Field | Description |
---|---|
name string |
Name: Name of the Cosmos DB capability. For example, “name”: “EnableCassandra”. Current values also include “EnableTable” and “EnableGremlin”. |
CompositePath
(Appears on:IndexingPolicy)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/CompositePath
Field | Description |
---|---|
order CompositePathOrder |
Order: Sort order for composite paths. |
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
CompositePathARM
(Appears on:IndexingPolicyARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/CompositePath
Field | Description |
---|---|
order CompositePathOrder |
Order: Sort order for composite paths. |
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
CompositePathOrder
(string
alias)
(Appears on:CompositePath, CompositePathARM)
Value | Description |
---|---|
"ascending" |
|
"descending" |
CompositePathStatusOrder
(string
alias)
(Appears on:CompositePath_Status, CompositePath_StatusARM)
Value | Description |
---|---|
"ascending" |
|
"descending" |
CompositePath_Status
(Appears on:IndexingPolicy_Status)
Field | Description |
---|---|
order CompositePathStatusOrder |
Order: Sort order for composite paths. |
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
CompositePath_StatusARM
(Appears on:IndexingPolicy_StatusARM)
Field | Description |
---|---|
order CompositePathStatusOrder |
Order: Sort order for composite paths. |
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
ConflictResolutionPolicy
(Appears on:SqlContainerResource)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ConflictResolutionPolicy
Field | Description |
---|---|
conflictResolutionPath string |
ConflictResolutionPath: The conflict resolution path in the case of LastWriterWins mode. |
conflictResolutionProcedure string |
ConflictResolutionProcedure: The procedure to resolve conflicts in the case of custom mode. |
mode ConflictResolutionPolicyMode |
Mode: Indicates the conflict resolution mode. |
ConflictResolutionPolicyARM
(Appears on:SqlContainerResourceARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ConflictResolutionPolicy
Field | Description |
---|---|
conflictResolutionPath string |
ConflictResolutionPath: The conflict resolution path in the case of LastWriterWins mode. |
conflictResolutionProcedure string |
ConflictResolutionProcedure: The procedure to resolve conflicts in the case of custom mode. |
mode ConflictResolutionPolicyMode |
Mode: Indicates the conflict resolution mode. |
ConflictResolutionPolicyMode
(string
alias)
(Appears on:ConflictResolutionPolicy, ConflictResolutionPolicyARM)
Value | Description |
---|---|
"Custom" |
|
"LastWriterWins" |
ConflictResolutionPolicyStatusMode
(string
alias)
(Appears on:ConflictResolutionPolicy_Status, ConflictResolutionPolicy_StatusARM)
Value | Description |
---|---|
"Custom" |
|
"LastWriterWins" |
ConflictResolutionPolicy_Status
(Appears on:SqlContainerGetProperties_Status_Resource)
Field | Description |
---|---|
conflictResolutionPath string |
ConflictResolutionPath: The conflict resolution path in the case of LastWriterWins mode. |
conflictResolutionProcedure string |
ConflictResolutionProcedure: The procedure to resolve conflicts in the case of custom mode. |
mode ConflictResolutionPolicyStatusMode |
Mode: Indicates the conflict resolution mode. |
ConflictResolutionPolicy_StatusARM
(Appears on:SqlContainerGetProperties_Status_ResourceARM)
Field | Description |
---|---|
conflictResolutionPath string |
ConflictResolutionPath: The conflict resolution path in the case of LastWriterWins mode. |
conflictResolutionProcedure string |
ConflictResolutionProcedure: The procedure to resolve conflicts in the case of custom mode. |
mode ConflictResolutionPolicyStatusMode |
Mode: Indicates the conflict resolution mode. |
ConnectorOffer_Status
(string
alias)
(Appears on:DatabaseAccountGetProperties_StatusARM, DatabaseAccountGetResults_Status)
Value | Description |
---|---|
"Small" |
ConsistencyPolicy
(Appears on:DatabaseAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ConsistencyPolicy
Field | Description |
---|---|
defaultConsistencyLevel ConsistencyPolicyDefaultConsistencyLevel |
DefaultConsistencyLevel: The default consistency level and configuration settings of the Cosmos DB account. |
maxIntervalInSeconds int |
MaxIntervalInSeconds: 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’. |
maxStalenessPrefix int |
MaxStalenessPrefix: 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’. |
ConsistencyPolicyARM
(Appears on:DatabaseAccountCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ConsistencyPolicy
Field | Description |
---|---|
defaultConsistencyLevel ConsistencyPolicyDefaultConsistencyLevel |
DefaultConsistencyLevel: The default consistency level and configuration settings of the Cosmos DB account. |
maxIntervalInSeconds int |
MaxIntervalInSeconds: 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’. |
maxStalenessPrefix int |
MaxStalenessPrefix: 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’. |
ConsistencyPolicyDefaultConsistencyLevel
(string
alias)
(Appears on:ConsistencyPolicy, ConsistencyPolicyARM)
Value | Description |
---|---|
"BoundedStaleness" |
|
"ConsistentPrefix" |
|
"Eventual" |
|
"Session" |
|
"Strong" |
ConsistencyPolicyStatusDefaultConsistencyLevel
(string
alias)
(Appears on:ConsistencyPolicy_Status, ConsistencyPolicy_StatusARM)
Value | Description |
---|---|
"BoundedStaleness" |
|
"ConsistentPrefix" |
|
"Eventual" |
|
"Session" |
|
"Strong" |
ConsistencyPolicy_Status
(Appears on:DatabaseAccountGetResults_Status)
Field | Description |
---|---|
defaultConsistencyLevel ConsistencyPolicyStatusDefaultConsistencyLevel |
DefaultConsistencyLevel: The default consistency level and configuration settings of the Cosmos DB account. |
maxIntervalInSeconds int |
MaxIntervalInSeconds: 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’. |
maxStalenessPrefix int |
MaxStalenessPrefix: 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’. |
ConsistencyPolicy_StatusARM
(Appears on:DatabaseAccountGetProperties_StatusARM)
Field | Description |
---|---|
defaultConsistencyLevel ConsistencyPolicyStatusDefaultConsistencyLevel |
DefaultConsistencyLevel: The default consistency level and configuration settings of the Cosmos DB account. |
maxIntervalInSeconds int |
MaxIntervalInSeconds: 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’. |
maxStalenessPrefix int |
MaxStalenessPrefix: 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’. |
ContainerPartitionKey
(Appears on:SqlContainerResource)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ContainerPartitionKey
Field | Description |
---|---|
kind ContainerPartitionKeyKind |
Kind: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create. |
paths []string |
Paths: List of paths using which data within the container can be partitioned |
version int |
Version: Indicates the version of the partition key definition |
ContainerPartitionKeyARM
(Appears on:SqlContainerResourceARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ContainerPartitionKey
Field | Description |
---|---|
kind ContainerPartitionKeyKind |
Kind: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create. |
paths []string |
Paths: List of paths using which data within the container can be partitioned |
version int |
Version: Indicates the version of the partition key definition |
ContainerPartitionKeyKind
(string
alias)
(Appears on:ContainerPartitionKey, ContainerPartitionKeyARM)
Value | Description |
---|---|
"Hash" |
|
"MultiHash" |
|
"Range" |
ContainerPartitionKeyStatusKind
(string
alias)
(Appears on:ContainerPartitionKey_Status, ContainerPartitionKey_StatusARM)
Value | Description |
---|---|
"Hash" |
|
"MultiHash" |
|
"Range" |
ContainerPartitionKey_Status
(Appears on:SqlContainerGetProperties_Status_Resource)
Field | Description |
---|---|
kind ContainerPartitionKeyStatusKind |
Kind: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create |
paths []string |
Paths: List of paths using which data within the container can be partitioned |
systemKey bool |
SystemKey: Indicates if the container is using a system generated partition key |
version int |
Version: Indicates the version of the partition key definition |
ContainerPartitionKey_StatusARM
(Appears on:SqlContainerGetProperties_Status_ResourceARM)
Field | Description |
---|---|
kind ContainerPartitionKeyStatusKind |
Kind: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create |
paths []string |
Paths: List of paths using which data within the container can be partitioned |
systemKey bool |
SystemKey: Indicates if the container is using a system generated partition key |
version int |
Version: Indicates the version of the partition key definition |
ContinuousModeBackupPolicy
(Appears on:BackupPolicy)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ContinuousModeBackupPolicy
Field | Description |
---|---|
type ContinuousModeBackupPolicyType |
ContinuousModeBackupPolicyARM
(Appears on:BackupPolicyARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ContinuousModeBackupPolicy
Field | Description |
---|---|
type ContinuousModeBackupPolicyType |
ContinuousModeBackupPolicyType
(string
alias)
(Appears on:ContinuousModeBackupPolicy, ContinuousModeBackupPolicyARM)
Value | Description |
---|---|
"Continuous" |
CorsPolicy
(Appears on:DatabaseAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/CorsPolicy
Field | Description |
---|---|
allowedHeaders string |
AllowedHeaders: The request headers that the origin domain may specify on the CORS request. |
allowedMethods string |
AllowedMethods: The methods (HTTP request verbs) that the origin domain may use for a CORS request. |
allowedOrigins string |
AllowedOrigins: The origin domains that are permitted to make a request against the service via CORS. |
exposedHeaders string |
ExposedHeaders: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. |
maxAgeInSeconds int |
MaxAgeInSeconds: The maximum amount time that a browser should cache the preflight OPTIONS request. |
CorsPolicyARM
(Appears on:DatabaseAccountCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/CorsPolicy
Field | Description |
---|---|
allowedHeaders string |
AllowedHeaders: The request headers that the origin domain may specify on the CORS request. |
allowedMethods string |
AllowedMethods: The methods (HTTP request verbs) that the origin domain may use for a CORS request. |
allowedOrigins string |
AllowedOrigins: The origin domains that are permitted to make a request against the service via CORS. |
exposedHeaders string |
ExposedHeaders: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. |
maxAgeInSeconds int |
MaxAgeInSeconds: The maximum amount time that a browser should cache the preflight OPTIONS request. |
CorsPolicy_Status
(Appears on:DatabaseAccountGetResults_Status)
Field | Description |
---|---|
allowedHeaders string |
AllowedHeaders: The request headers that the origin domain may specify on the CORS request. |
allowedMethods string |
AllowedMethods: The methods (HTTP request verbs) that the origin domain may use for a CORS request. |
allowedOrigins string |
AllowedOrigins: The origin domains that are permitted to make a request against the service via CORS. |
exposedHeaders string |
ExposedHeaders: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. |
maxAgeInSeconds int |
MaxAgeInSeconds: The maximum amount time that a browser should cache the preflight OPTIONS request. |
CorsPolicy_StatusARM
(Appears on:DatabaseAccountGetProperties_StatusARM)
Field | Description |
---|---|
allowedHeaders string |
AllowedHeaders: The request headers that the origin domain may specify on the CORS request. |
allowedMethods string |
AllowedMethods: The methods (HTTP request verbs) that the origin domain may use for a CORS request. |
allowedOrigins string |
AllowedOrigins: The origin domains that are permitted to make a request against the service via CORS. |
exposedHeaders string |
ExposedHeaders: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. |
maxAgeInSeconds int |
MaxAgeInSeconds: The maximum amount time that a browser should cache the preflight OPTIONS request. |
CreateUpdateOptions
(Appears on:DatabaseAccountsMongodbDatabasesCollections_Spec, DatabaseAccountsMongodbDatabases_Spec, DatabaseAccountsSqlDatabasesContainersStoredProcedures_Spec, DatabaseAccountsSqlDatabasesContainersTriggers_Spec, DatabaseAccountsSqlDatabasesContainersUserDefinedFunctions_Spec, DatabaseAccountsSqlDatabasesContainers_Spec, DatabaseAccountsSqlDatabases_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/CreateUpdateOptions
Field | Description |
---|---|
autoscaleSettings AutoscaleSettings |
|
throughput int |
Throughput: Request Units per second. For example, “throughput”: 10000. |
CreateUpdateOptionsARM
(Appears on:MongoDBCollectionCreateUpdatePropertiesARM, MongoDBDatabaseCreateUpdatePropertiesARM, SqlContainerCreateUpdatePropertiesARM, SqlDatabaseCreateUpdatePropertiesARM, SqlStoredProcedureCreateUpdatePropertiesARM, SqlTriggerCreateUpdatePropertiesARM, SqlUserDefinedFunctionCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/CreateUpdateOptions
Field | Description |
---|---|
autoscaleSettings AutoscaleSettingsARM |
|
throughput int |
Throughput: Request Units per second. For example, “throughput”: 10000. |
DatabaseAccount
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/resourceDefinitions/databaseAccounts
Field | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
spec DatabaseAccounts_Spec |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status DatabaseAccountGetResults_Status |
DatabaseAccountCreateUpdatePropertiesARM
(Appears on:DatabaseAccounts_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/DatabaseAccountCreateUpdateProperties
Field | Description |
---|---|
analyticalStorageConfiguration AnalyticalStorageConfigurationARM |
AnalyticalStorageConfiguration: Analytical storage specific properties. |
apiProperties ApiPropertiesARM |
|
backupPolicy BackupPolicyARM |
BackupPolicy: The object representing the policy for taking backups on an account. |
capabilities []CapabilityARM |
Capabilities: List of Cosmos DB capabilities for the account |
connectorOffer DatabaseAccountCreateUpdatePropertiesConnectorOffer |
ConnectorOffer: The cassandra connector offer type for the Cosmos DB database C* account. |
consistencyPolicy ConsistencyPolicyARM |
ConsistencyPolicy: The consistency policy for the Cosmos DB database account. |
cors []CorsPolicyARM |
Cors: The CORS policy for the Cosmos DB database account. |
databaseAccountOfferType DatabaseAccountCreateUpdatePropertiesDatabaseAccountOfferType |
DatabaseAccountOfferType: The offer type for the database |
defaultIdentity string |
DefaultIdentity: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more. |
disableKeyBasedMetadataWriteAccess bool |
DisableKeyBasedMetadataWriteAccess: Disable write operations on metadata resources (databases, containers, throughput) via account keys |
enableAnalyticalStorage bool |
EnableAnalyticalStorage: Flag to indicate whether to enable storage analytics. |
enableAutomaticFailover bool |
EnableAutomaticFailover: Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account. |
enableCassandraConnector bool |
EnableCassandraConnector: Enables the cassandra connector on the Cosmos DB C* account |
enableFreeTier bool |
EnableFreeTier: Flag to indicate whether Free Tier is enabled. |
enableMultipleWriteLocations bool |
EnableMultipleWriteLocations: Enables the account to write in multiple locations |
ipRules []IpAddressOrRangeARM |
IpRules: Array of IpAddressOrRange objects. |
isVirtualNetworkFilterEnabled bool |
IsVirtualNetworkFilterEnabled: Flag to indicate whether to enable/disable Virtual Network ACL rules. |
keyVaultKeyUri string |
KeyVaultKeyUri: The URI of the key vault |
locations []LocationARM |
Locations: An array that contains the georeplication locations enabled for the Cosmos DB account. |
networkAclBypass DatabaseAccountCreateUpdatePropertiesNetworkAclBypass |
NetworkAclBypass: Indicates what services are allowed to bypass firewall checks. |
networkAclBypassResourceIds []string |
NetworkAclBypassResourceIds: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. |
publicNetworkAccess DatabaseAccountCreateUpdatePropertiesPublicNetworkAccess |
PublicNetworkAccess: Whether requests from Public Network are allowed. |
virtualNetworkRules []VirtualNetworkRuleARM |
VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account. |
DatabaseAccountCreateUpdatePropertiesConnectorOffer
(string
alias)
(Appears on:DatabaseAccountCreateUpdatePropertiesARM, DatabaseAccounts_Spec)
Value | Description |
---|---|
"Small" |
DatabaseAccountCreateUpdatePropertiesDatabaseAccountOfferType
(string
alias)
(Appears on:DatabaseAccountCreateUpdatePropertiesARM, DatabaseAccounts_Spec)
Value | Description |
---|---|
"Standard" |
DatabaseAccountCreateUpdatePropertiesNetworkAclBypass
(string
alias)
(Appears on:DatabaseAccountCreateUpdatePropertiesARM, DatabaseAccounts_Spec)
Value | Description |
---|---|
"AzureServices" |
|
"None" |
DatabaseAccountCreateUpdatePropertiesPublicNetworkAccess
(string
alias)
(Appears on:DatabaseAccountCreateUpdatePropertiesARM, DatabaseAccounts_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
DatabaseAccountGetProperties_StatusARM
(Appears on:DatabaseAccountGetResults_StatusARM)
Field | Description |
---|---|
analyticalStorageConfiguration AnalyticalStorageConfiguration_StatusARM |
AnalyticalStorageConfiguration: Analytical storage specific properties. |
apiProperties ApiProperties_StatusARM |
ApiProperties: API specific properties. |
backupPolicy BackupPolicy_StatusARM |
BackupPolicy: The object representing the policy for taking backups on an account. |
capabilities []Capability_StatusARM |
Capabilities: List of Cosmos DB capabilities for the account |
connectorOffer ConnectorOffer_Status |
ConnectorOffer: The cassandra connector offer type for the Cosmos DB database C* account. |
consistencyPolicy ConsistencyPolicy_StatusARM |
ConsistencyPolicy: The consistency policy for the Cosmos DB database account. |
cors []CorsPolicy_StatusARM |
Cors: The CORS policy for the Cosmos DB database account. |
databaseAccountOfferType DatabaseAccountOfferType_Status |
DatabaseAccountOfferType: The offer type for the Cosmos DB database account. Default value: Standard. |
defaultIdentity string |
DefaultIdentity: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more. |
disableKeyBasedMetadataWriteAccess bool |
DisableKeyBasedMetadataWriteAccess: Disable write operations on metadata resources (databases, containers, throughput) via account keys |
documentEndpoint string |
DocumentEndpoint: The connection endpoint for the Cosmos DB database account. |
enableAnalyticalStorage bool |
EnableAnalyticalStorage: Flag to indicate whether to enable storage analytics. |
enableAutomaticFailover bool |
EnableAutomaticFailover: Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account. |
enableCassandraConnector bool |
EnableCassandraConnector: Enables the cassandra connector on the Cosmos DB C* account |
enableFreeTier bool |
EnableFreeTier: Flag to indicate whether Free Tier is enabled. |
enableMultipleWriteLocations bool |
EnableMultipleWriteLocations: Enables the account to write in multiple locations |
failoverPolicies []FailoverPolicy_StatusARM |
FailoverPolicies: An array that contains the regions ordered by their failover priorities. |
ipRules []IpAddressOrRange_StatusARM |
IpRules: List of IpRules. |
isVirtualNetworkFilterEnabled bool |
IsVirtualNetworkFilterEnabled: Flag to indicate whether to enable/disable Virtual Network ACL rules. |
keyVaultKeyUri string |
KeyVaultKeyUri: The URI of the key vault |
locations []Location_StatusARM |
Locations: An array that contains all of the locations enabled for the Cosmos DB account. |
networkAclBypass NetworkAclBypass_Status |
NetworkAclBypass: Indicates what services are allowed to bypass firewall checks. |
networkAclBypassResourceIds []string |
NetworkAclBypassResourceIds: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. |
privateEndpointConnections []PrivateEndpointConnection_Status_SubResourceEmbeddedARM |
PrivateEndpointConnections: List of Private Endpoint Connections configured for the Cosmos DB account. |
provisioningState string |
|
publicNetworkAccess PublicNetworkAccess_Status |
PublicNetworkAccess: Whether requests from Public Network are allowed |
readLocations []Location_StatusARM |
ReadLocations: An array that contains of the read locations enabled for the Cosmos DB account. |
virtualNetworkRules []VirtualNetworkRule_StatusARM |
VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account. |
writeLocations []Location_StatusARM |
WriteLocations: An array that contains the write location for the Cosmos DB account. |
DatabaseAccountGetResultsStatusKind
(string
alias)
(Appears on:DatabaseAccountGetResults_Status, DatabaseAccountGetResults_StatusARM)
Value | Description |
---|---|
"GlobalDocumentDB" |
|
"MongoDB" |
|
"Parse" |
DatabaseAccountGetResults_Status
(Appears on:DatabaseAccount)
Field | Description |
---|---|
analyticalStorageConfiguration AnalyticalStorageConfiguration_Status |
AnalyticalStorageConfiguration: Analytical storage specific properties. |
apiProperties ApiProperties_Status |
ApiProperties: API specific properties. |
backupPolicy BackupPolicy_Status |
BackupPolicy: The object representing the policy for taking backups on an account. |
capabilities []Capability_Status |
Capabilities: List of Cosmos DB capabilities for the account |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
connectorOffer ConnectorOffer_Status |
ConnectorOffer: The cassandra connector offer type for the Cosmos DB database C* account. |
consistencyPolicy ConsistencyPolicy_Status |
ConsistencyPolicy: The consistency policy for the Cosmos DB database account. |
cors []CorsPolicy_Status |
Cors: The CORS policy for the Cosmos DB database account. |
databaseAccountOfferType DatabaseAccountOfferType_Status |
DatabaseAccountOfferType: The offer type for the Cosmos DB database account. Default value: Standard. |
defaultIdentity string |
DefaultIdentity: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more. |
disableKeyBasedMetadataWriteAccess bool |
DisableKeyBasedMetadataWriteAccess: Disable write operations on metadata resources (databases, containers, throughput) via account keys |
documentEndpoint string |
DocumentEndpoint: The connection endpoint for the Cosmos DB database account. |
enableAnalyticalStorage bool |
EnableAnalyticalStorage: Flag to indicate whether to enable storage analytics. |
enableAutomaticFailover bool |
EnableAutomaticFailover: Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account. |
enableCassandraConnector bool |
EnableCassandraConnector: Enables the cassandra connector on the Cosmos DB C* account |
enableFreeTier bool |
EnableFreeTier: Flag to indicate whether Free Tier is enabled. |
enableMultipleWriteLocations bool |
EnableMultipleWriteLocations: Enables the account to write in multiple locations |
failoverPolicies []FailoverPolicy_Status |
FailoverPolicies: An array that contains the regions ordered by their failover priorities. |
id string |
Id: The unique resource identifier of the ARM resource. |
identity ManagedServiceIdentity_Status |
|
ipRules []IpAddressOrRange_Status |
IpRules: List of IpRules. |
isVirtualNetworkFilterEnabled bool |
IsVirtualNetworkFilterEnabled: Flag to indicate whether to enable/disable Virtual Network ACL rules. |
keyVaultKeyUri string |
KeyVaultKeyUri: The URI of the key vault |
kind DatabaseAccountGetResultsStatusKind |
Kind: Indicates the type of database account. This can only be set at database account creation. |
location string |
Location: The location of the resource group to which the resource belongs. |
locations []Location_Status |
Locations: An array that contains all of the locations enabled for the Cosmos DB account. |
name string |
Name: The name of the ARM resource. |
networkAclBypass NetworkAclBypass_Status |
NetworkAclBypass: Indicates what services are allowed to bypass firewall checks. |
networkAclBypassResourceIds []string |
NetworkAclBypassResourceIds: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. |
privateEndpointConnections []PrivateEndpointConnection_Status_SubResourceEmbedded |
PrivateEndpointConnections: List of Private Endpoint Connections configured for the Cosmos DB account. |
provisioningState string |
|
publicNetworkAccess PublicNetworkAccess_Status |
PublicNetworkAccess: Whether requests from Public Network are allowed |
readLocations []Location_Status |
ReadLocations: An array that contains of the read locations enabled for the Cosmos DB account. |
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
virtualNetworkRules []VirtualNetworkRule_Status |
VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account. |
writeLocations []Location_Status |
WriteLocations: An array that contains the write location for the Cosmos DB account. |
DatabaseAccountGetResults_StatusARM
Field | Description |
---|---|
id string |
Id: The unique resource identifier of the ARM resource. |
identity ManagedServiceIdentity_StatusARM |
|
kind DatabaseAccountGetResultsStatusKind |
Kind: Indicates the type of database account. This can only be set at database account creation. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
properties DatabaseAccountGetProperties_StatusARM |
|
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
DatabaseAccountOfferType_Status
(string
alias)
(Appears on:DatabaseAccountGetProperties_StatusARM, DatabaseAccountGetResults_Status)
Value | Description |
---|---|
"Standard" |
DatabaseAccountOperatorSecrets
(Appears on:DatabaseAccountOperatorSpec)
Field | Description |
---|---|
documentEndpoint genruntime.SecretDestination |
DocumentEndpoint: indicates where the DocumentEndpoint secret should be placed. If omitted, the secret will not be retrieved from Azure. |
primaryMasterKey genruntime.SecretDestination |
PrimaryMasterKey: indicates where the PrimaryMasterKey secret should be placed. If omitted, the secret will not be retrieved from Azure. |
primaryReadonlyMasterKey genruntime.SecretDestination |
PrimaryReadonlyMasterKey: indicates where the PrimaryReadonlyMasterKey secret should be placed. If omitted, the secret will not be retrieved from Azure. |
secondaryMasterKey genruntime.SecretDestination |
SecondaryMasterKey: indicates where the SecondaryMasterKey secret should be placed. If omitted, the secret will not be retrieved from Azure. |
secondaryReadonlyMasterKey genruntime.SecretDestination |
SecondaryReadonlyMasterKey: indicates where the SecondaryReadonlyMasterKey secret should be placed. If omitted, the secret will not be retrieved from Azure. |
DatabaseAccountOperatorSpec
(Appears on:DatabaseAccounts_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
secrets DatabaseAccountOperatorSecrets |
Secrets: configures where to place Azure generated secrets. |
DatabaseAccountsMongodbDatabasesCollectionsThroughputSettings_Spec
(Appears on:MongodbDatabaseCollectionThroughputSetting)
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/MongodbDatabaseCollection resource |
resource ThroughputSettingsResource |
Resource: Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsMongodbDatabasesCollectionsThroughputSettings_SpecARM
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: Name of the resource |
properties ThroughputSettingsUpdatePropertiesARM |
Properties: Properties to update Azure Cosmos DB resource throughput. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsMongodbDatabasesCollections_Spec
(Appears on:MongodbDatabaseCollection)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
location string |
Location: The location of the resource group to which the resource belongs. |
options CreateUpdateOptions |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/MongodbDatabase resource |
resource MongoDBCollectionResource |
Resource: Cosmos DB MongoDB collection resource object |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsMongodbDatabasesCollections_SpecARM
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: Cosmos DB collection name. |
properties MongoDBCollectionCreateUpdatePropertiesARM |
Properties: Properties to create and update Azure Cosmos DB MongoDB collection. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsMongodbDatabasesThroughputSettings_Spec
(Appears on:MongodbDatabaseThroughputSetting)
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/MongodbDatabase resource |
resource ThroughputSettingsResource |
Resource: Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsMongodbDatabasesThroughputSettings_SpecARM
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: Name of the resource |
properties ThroughputSettingsUpdatePropertiesARM |
Properties: Properties to update Azure Cosmos DB resource throughput. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsMongodbDatabases_Spec
(Appears on:MongodbDatabase)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
location string |
Location: The location of the resource group to which the resource belongs. |
options CreateUpdateOptions |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/DatabaseAccount resource |
resource MongoDBDatabaseResource |
Resource: Cosmos DB MongoDB database resource object |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsMongodbDatabases_SpecARM
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: Cosmos DB database name. |
properties MongoDBDatabaseCreateUpdatePropertiesARM |
Properties: Properties to create and update Azure Cosmos DB MongoDB database. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSpecKind
(string
alias)
(Appears on:DatabaseAccounts_Spec, DatabaseAccounts_SpecARM)
Value | Description |
---|---|
"GlobalDocumentDB" |
|
"MongoDB" |
|
"Parse" |
DatabaseAccountsSqlDatabasesContainersStoredProcedures_Spec
(Appears on:SqlDatabaseContainerStoredProcedure)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
location string |
Location: The location of the resource group to which the resource belongs. |
options CreateUpdateOptions |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/SqlDatabaseContainer resource |
resource SqlStoredProcedureResource |
Resource: Cosmos DB SQL storedProcedure resource object |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSqlDatabasesContainersStoredProcedures_SpecARM
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: Cosmos DB storedProcedure name. |
properties SqlStoredProcedureCreateUpdatePropertiesARM |
Properties: Properties to create and update Azure Cosmos DB storedProcedure. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSqlDatabasesContainersThroughputSettings_Spec
(Appears on:SqlDatabaseContainerThroughputSetting)
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/SqlDatabaseContainer resource |
resource ThroughputSettingsResource |
Resource: Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSqlDatabasesContainersThroughputSettings_SpecARM
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: Name of the resource |
properties ThroughputSettingsUpdatePropertiesARM |
Properties: Properties to update Azure Cosmos DB resource throughput. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSqlDatabasesContainersTriggers_Spec
(Appears on:SqlDatabaseContainerTrigger)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
location string |
Location: The location of the resource group to which the resource belongs. |
options CreateUpdateOptions |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/SqlDatabaseContainer resource |
resource SqlTriggerResource |
Resource: Cosmos DB SQL trigger resource object |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSqlDatabasesContainersTriggers_SpecARM
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: Cosmos DB trigger name. |
properties SqlTriggerCreateUpdatePropertiesARM |
Properties: Properties to create and update Azure Cosmos DB trigger. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSqlDatabasesContainersUserDefinedFunctions_Spec
(Appears on:SqlDatabaseContainerUserDefinedFunction)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
location string |
Location: The location of the resource group to which the resource belongs. |
options CreateUpdateOptions |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/SqlDatabaseContainer resource |
resource SqlUserDefinedFunctionResource |
Resource: Cosmos DB SQL userDefinedFunction resource object |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSqlDatabasesContainersUserDefinedFunctions_SpecARM
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: Cosmos DB userDefinedFunction name. |
properties SqlUserDefinedFunctionCreateUpdatePropertiesARM |
Properties: Properties to create and update Azure Cosmos DB userDefinedFunction. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSqlDatabasesContainers_Spec
(Appears on:SqlDatabaseContainer)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
location string |
Location: The location of the resource group to which the resource belongs. |
options CreateUpdateOptions |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/SqlDatabase resource |
resource SqlContainerResource |
Resource: Cosmos DB SQL container resource object |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSqlDatabasesContainers_SpecARM
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: Cosmos DB container name. |
properties SqlContainerCreateUpdatePropertiesARM |
Properties: Properties to create and update Azure Cosmos DB container. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSqlDatabasesThroughputSettings_Spec
(Appears on:SqlDatabaseThroughputSetting)
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/SqlDatabase resource |
resource ThroughputSettingsResource |
Resource: Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSqlDatabasesThroughputSettings_SpecARM
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: Name of the resource |
properties ThroughputSettingsUpdatePropertiesARM |
Properties: Properties to update Azure Cosmos DB resource throughput. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSqlDatabases_Spec
(Appears on:SqlDatabase)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
location string |
Location: The location of the resource group to which the resource belongs. |
options CreateUpdateOptions |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/DatabaseAccount resource |
resource SqlDatabaseResource |
Resource: Cosmos DB SQL database resource object |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccountsSqlDatabases_SpecARM
Field | Description |
---|---|
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: Cosmos DB database name. |
properties SqlDatabaseCreateUpdatePropertiesARM |
Properties: Properties to create and update Azure Cosmos DB SQL database. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
DatabaseAccounts_Spec
(Appears on:DatabaseAccount)
Field | Description |
---|---|
analyticalStorageConfiguration AnalyticalStorageConfiguration |
AnalyticalStorageConfiguration: Analytical storage specific properties. |
apiProperties ApiProperties |
|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
backupPolicy BackupPolicy |
BackupPolicy: The object representing the policy for taking backups on an account. |
capabilities []Capability |
Capabilities: List of Cosmos DB capabilities for the account |
connectorOffer DatabaseAccountCreateUpdatePropertiesConnectorOffer |
ConnectorOffer: The cassandra connector offer type for the Cosmos DB database C* account. |
consistencyPolicy ConsistencyPolicy |
ConsistencyPolicy: The consistency policy for the Cosmos DB database account. |
cors []CorsPolicy |
Cors: The CORS policy for the Cosmos DB database account. |
databaseAccountOfferType DatabaseAccountCreateUpdatePropertiesDatabaseAccountOfferType |
DatabaseAccountOfferType: The offer type for the database |
defaultIdentity string |
DefaultIdentity: The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more. |
disableKeyBasedMetadataWriteAccess bool |
DisableKeyBasedMetadataWriteAccess: Disable write operations on metadata resources (databases, containers, throughput) via account keys |
enableAnalyticalStorage bool |
EnableAnalyticalStorage: Flag to indicate whether to enable storage analytics. |
enableAutomaticFailover bool |
EnableAutomaticFailover: Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account. |
enableCassandraConnector bool |
EnableCassandraConnector: Enables the cassandra connector on the Cosmos DB C* account |
enableFreeTier bool |
EnableFreeTier: Flag to indicate whether Free Tier is enabled. |
enableMultipleWriteLocations bool |
EnableMultipleWriteLocations: Enables the account to write in multiple locations |
identity ManagedServiceIdentity |
Identity: Identity for the resource. |
ipRules []IpAddressOrRange |
IpRules: Array of IpAddressOrRange objects. |
isVirtualNetworkFilterEnabled bool |
IsVirtualNetworkFilterEnabled: Flag to indicate whether to enable/disable Virtual Network ACL rules. |
keyVaultKeyUri string |
KeyVaultKeyUri: The URI of the key vault |
kind DatabaseAccountsSpecKind |
Kind: Indicates the type of database account. This can only be set at database account creation. |
location string |
Location: The location of the resource group to which the resource belongs. |
locations []Location |
Locations: An array that contains the georeplication locations enabled for the Cosmos DB account. |
networkAclBypass DatabaseAccountCreateUpdatePropertiesNetworkAclBypass |
NetworkAclBypass: Indicates what services are allowed to bypass firewall checks. |
networkAclBypassResourceIds []string |
NetworkAclBypassResourceIds: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. |
operatorSpec DatabaseAccountOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
publicNetworkAccess DatabaseAccountCreateUpdatePropertiesPublicNetworkAccess |
PublicNetworkAccess: Whether requests from Public Network are allowed. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
virtualNetworkRules []VirtualNetworkRule |
VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account. |
DatabaseAccounts_SpecARM
Field | Description |
---|---|
identity ManagedServiceIdentityARM |
Identity: Identity for the resource. |
kind DatabaseAccountsSpecKind |
Kind: Indicates the type of database account. This can only be set at database account creation. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: Cosmos DB database account name. |
properties DatabaseAccountCreateUpdatePropertiesARM |
Properties: Properties to create and update Azure Cosmos DB database accounts. |
tags map[string]string |
Tags: Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with “defaultExperience”: “Cassandra”. Current “defaultExperience” values also include “Table”, “Graph”, “DocumentDB”, and “MongoDB”. |
ExcludedPath
(Appears on:IndexingPolicy)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ExcludedPath
Field | Description |
---|---|
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
ExcludedPathARM
(Appears on:IndexingPolicyARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ExcludedPath
Field | Description |
---|---|
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
ExcludedPath_Status
(Appears on:IndexingPolicy_Status)
Field | Description |
---|---|
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
ExcludedPath_StatusARM
(Appears on:IndexingPolicy_StatusARM)
Field | Description |
---|---|
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
FailoverPolicy_Status
(Appears on:DatabaseAccountGetResults_Status)
Field | Description |
---|---|
failoverPriority int |
FailoverPriority: 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. |
id string |
Id: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. |
locationName string |
LocationName: The name of the region in which the database account exists. |
FailoverPolicy_StatusARM
(Appears on:DatabaseAccountGetProperties_StatusARM)
Field | Description |
---|---|
failoverPriority int |
FailoverPriority: 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. |
id string |
Id: The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. |
locationName string |
LocationName: The name of the region in which the database account exists. |
IncludedPath
(Appears on:IndexingPolicy)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/IncludedPath
Field | Description |
---|---|
indexes []Indexes |
Indexes: List of indexes for this path |
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
IncludedPathARM
(Appears on:IndexingPolicyARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/IncludedPath
Field | Description |
---|---|
indexes []IndexesARM |
Indexes: List of indexes for this path |
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
IncludedPath_Status
(Appears on:IndexingPolicy_Status)
Field | Description |
---|---|
indexes []Indexes_Status |
Indexes: List of indexes for this path |
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
IncludedPath_StatusARM
(Appears on:IndexingPolicy_StatusARM)
Field | Description |
---|---|
indexes []Indexes_StatusARM |
Indexes: List of indexes for this path |
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
Indexes
(Appears on:IncludedPath)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/Indexes
Field | Description |
---|---|
dataType IndexesDataType |
DataType: The datatype for which the indexing behavior is applied to. |
kind IndexesKind |
Kind: Indicates the type of index. |
precision int |
Precision: The precision of the index. -1 is maximum precision. |
IndexesARM
(Appears on:IncludedPathARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/Indexes
Field | Description |
---|---|
dataType IndexesDataType |
DataType: The datatype for which the indexing behavior is applied to. |
kind IndexesKind |
Kind: Indicates the type of index. |
precision int |
Precision: The precision of the index. -1 is maximum precision. |
IndexesDataType
(string
alias)
(Appears on:Indexes, IndexesARM)
Value | Description |
---|---|
"LineString" |
|
"MultiPolygon" |
|
"Number" |
|
"Point" |
|
"Polygon" |
|
"String" |
IndexesKind
(string
alias)
(Appears on:Indexes, IndexesARM)
Value | Description |
---|---|
"Hash" |
|
"Range" |
|
"Spatial" |
IndexesStatusDataType
(string
alias)
(Appears on:Indexes_Status, Indexes_StatusARM)
Value | Description |
---|---|
"LineString" |
|
"MultiPolygon" |
|
"Number" |
|
"Point" |
|
"Polygon" |
|
"String" |
IndexesStatusKind
(string
alias)
(Appears on:Indexes_Status, Indexes_StatusARM)
Value | Description |
---|---|
"Hash" |
|
"Range" |
|
"Spatial" |
Indexes_Status
(Appears on:IncludedPath_Status)
Field | Description |
---|---|
dataType IndexesStatusDataType |
DataType: The datatype for which the indexing behavior is applied to. |
kind IndexesStatusKind |
Kind: Indicates the type of index. |
precision int |
Precision: The precision of the index. -1 is maximum precision. |
Indexes_StatusARM
(Appears on:IncludedPath_StatusARM)
Field | Description |
---|---|
dataType IndexesStatusDataType |
DataType: The datatype for which the indexing behavior is applied to. |
kind IndexesStatusKind |
Kind: Indicates the type of index. |
precision int |
Precision: The precision of the index. -1 is maximum precision. |
IndexingPolicy
(Appears on:SqlContainerResource)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/IndexingPolicy
Field | Description |
---|---|
automatic bool |
Automatic: Indicates if the indexing policy is automatic |
compositeIndexes []CompositePath |
CompositeIndexes: List of composite path list |
excludedPaths []ExcludedPath |
ExcludedPaths: List of paths to exclude from indexing |
includedPaths []IncludedPath |
IncludedPaths: List of paths to include in the indexing |
indexingMode IndexingPolicyIndexingMode |
IndexingMode: Indicates the indexing mode. |
spatialIndexes []SpatialSpec |
SpatialIndexes: List of spatial specifics |
IndexingPolicyARM
(Appears on:SqlContainerResourceARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/IndexingPolicy
Field | Description |
---|---|
automatic bool |
Automatic: Indicates if the indexing policy is automatic |
compositeIndexes []CompositePathARM |
CompositeIndexes: List of composite path list |
excludedPaths []ExcludedPathARM |
ExcludedPaths: List of paths to exclude from indexing |
includedPaths []IncludedPathARM |
IncludedPaths: List of paths to include in the indexing |
indexingMode IndexingPolicyIndexingMode |
IndexingMode: Indicates the indexing mode. |
spatialIndexes []SpatialSpecARM |
SpatialIndexes: List of spatial specifics |
IndexingPolicyIndexingMode
(string
alias)
(Appears on:IndexingPolicy, IndexingPolicyARM)
Value | Description |
---|---|
"consistent" |
|
"lazy" |
|
"none" |
IndexingPolicyStatusIndexingMode
(string
alias)
(Appears on:IndexingPolicy_Status, IndexingPolicy_StatusARM)
Value | Description |
---|---|
"consistent" |
|
"lazy" |
|
"none" |
IndexingPolicy_Status
(Appears on:SqlContainerGetProperties_Status_Resource)
Field | Description |
---|---|
automatic bool |
Automatic: Indicates if the indexing policy is automatic |
compositeIndexes []CompositePath_Status |
CompositeIndexes: List of composite path list |
excludedPaths []ExcludedPath_Status |
ExcludedPaths: List of paths to exclude from indexing |
includedPaths []IncludedPath_Status |
IncludedPaths: List of paths to include in the indexing |
indexingMode IndexingPolicyStatusIndexingMode |
IndexingMode: Indicates the indexing mode. |
spatialIndexes []SpatialSpec_Status |
SpatialIndexes: List of spatial specifics |
IndexingPolicy_StatusARM
(Appears on:SqlContainerGetProperties_Status_ResourceARM)
Field | Description |
---|---|
automatic bool |
Automatic: Indicates if the indexing policy is automatic |
compositeIndexes []CompositePath_StatusARM |
CompositeIndexes: List of composite path list |
excludedPaths []ExcludedPath_StatusARM |
ExcludedPaths: List of paths to exclude from indexing |
includedPaths []IncludedPath_StatusARM |
IncludedPaths: List of paths to include in the indexing |
indexingMode IndexingPolicyStatusIndexingMode |
IndexingMode: Indicates the indexing mode. |
spatialIndexes []SpatialSpec_StatusARM |
SpatialIndexes: List of spatial specifics |
IpAddressOrRange
(Appears on:DatabaseAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/IpAddressOrRange
Field | Description |
---|---|
ipAddressOrRange string |
IpAddressOrRange: 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”. |
IpAddressOrRangeARM
(Appears on:DatabaseAccountCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/IpAddressOrRange
Field | Description |
---|---|
ipAddressOrRange string |
IpAddressOrRange: 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_Status
(Appears on:DatabaseAccountGetResults_Status)
Field | Description |
---|---|
ipAddressOrRange string |
IpAddressOrRange: 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_StatusARM
(Appears on:DatabaseAccountGetProperties_StatusARM)
Field | Description |
---|---|
ipAddressOrRange string |
IpAddressOrRange: 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”. |
Location
(Appears on:DatabaseAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/Location
Field | Description |
---|---|
failoverPriority int |
FailoverPriority: 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. |
isZoneRedundant bool |
IsZoneRedundant: Flag to indicate whether or not this region is an AvailabilityZone region |
locationName string |
LocationName: The name of the region. |
LocationARM
(Appears on:DatabaseAccountCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/Location
Field | Description |
---|---|
failoverPriority int |
FailoverPriority: 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. |
isZoneRedundant bool |
IsZoneRedundant: Flag to indicate whether or not this region is an AvailabilityZone region |
locationName string |
LocationName: The name of the region. |
Location_Status
(Appears on:DatabaseAccountGetResults_Status)
Field | Description |
---|---|
documentEndpoint string |
DocumentEndpoint: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ |
failoverPriority int |
FailoverPriority: 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. |
id string |
Id: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. |
isZoneRedundant bool |
IsZoneRedundant: Flag to indicate whether or not this region is an AvailabilityZone region |
locationName string |
LocationName: The name of the region. |
provisioningState string |
Location_StatusARM
(Appears on:DatabaseAccountGetProperties_StatusARM)
Field | Description |
---|---|
documentEndpoint string |
DocumentEndpoint: The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ |
failoverPriority int |
FailoverPriority: 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. |
id string |
Id: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. |
isZoneRedundant bool |
IsZoneRedundant: Flag to indicate whether or not this region is an AvailabilityZone region |
locationName string |
LocationName: The name of the region. |
provisioningState string |
ManagedServiceIdentity
(Appears on:DatabaseAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ManagedServiceIdentity
Field | Description |
---|---|
type ManagedServiceIdentityType |
Type: 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. |
ManagedServiceIdentityARM
(Appears on:DatabaseAccounts_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ManagedServiceIdentity
Field | Description |
---|---|
type ManagedServiceIdentityType |
Type: 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. |
ManagedServiceIdentityStatusType
(string
alias)
(Appears on:ManagedServiceIdentity_Status, ManagedServiceIdentity_StatusARM)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned,UserAssigned" |
|
"UserAssigned" |
ManagedServiceIdentityType
(string
alias)
(Appears on:ManagedServiceIdentity, ManagedServiceIdentityARM)
Value | Description |
---|---|
"None" |
|
"SystemAssigned" |
|
"SystemAssigned,UserAssigned" |
|
"UserAssigned" |
ManagedServiceIdentity_Status
(Appears on:DatabaseAccountGetResults_Status)
Field | Description |
---|---|
principalId string |
PrincipalId: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. |
tenantId string |
TenantId: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. |
type ManagedServiceIdentityStatusType |
Type: 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. |
userAssignedIdentities map[string]./api/documentdb/v1beta20210515.ManagedServiceIdentity_Status_UserAssignedIdentities |
UserAssignedIdentities: 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}’.p> |
ManagedServiceIdentity_StatusARM
(Appears on:DatabaseAccountGetResults_StatusARM)
Field | Description |
---|---|
principalId string |
PrincipalId: The principal id of the system assigned identity. This property will only be provided for a system assigned identity. |
tenantId string |
TenantId: The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. |
type ManagedServiceIdentityStatusType |
Type: 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. |
userAssignedIdentities map[string]./api/documentdb/v1beta20210515.ManagedServiceIdentity_Status_UserAssignedIdentitiesARM |
UserAssignedIdentities: 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}’.p> |
ManagedServiceIdentity_Status_UserAssignedIdentities
(Appears on:ManagedServiceIdentity_Status)
Field | Description |
---|---|
clientId string |
ClientId: The client id of user assigned identity. |
principalId string |
PrincipalId: The principal id of user assigned identity. |
ManagedServiceIdentity_Status_UserAssignedIdentitiesARM
(Appears on:ManagedServiceIdentity_StatusARM)
Field | Description |
---|---|
clientId string |
ClientId: The client id of user assigned identity. |
principalId string |
PrincipalId: The principal id of user assigned identity. |
MongoDBCollectionCreateUpdatePropertiesARM
(Appears on:DatabaseAccountsMongodbDatabasesCollections_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/MongoDBCollectionCreateUpdateProperties
Field | Description |
---|---|
options CreateUpdateOptionsARM |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
resource MongoDBCollectionResourceARM |
Resource: Cosmos DB MongoDB collection resource object |
MongoDBCollectionGetProperties_StatusARM
(Appears on:MongoDBCollectionGetResults_StatusARM)
Field | Description |
---|---|
options OptionsResource_StatusARM |
|
resource MongoDBCollectionGetProperties_Status_ResourceARM |
MongoDBCollectionGetProperties_Status_Resource
(Appears on:MongoDBCollectionGetResults_Status)
Field | Description |
---|---|
analyticalStorageTtl int |
AnalyticalStorageTtl: Analytical TTL. |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB MongoDB collection |
indexes []MongoIndex_Status |
Indexes: List of index keys |
_rid string |
Rid: A system generated property. A unique identifier. |
shardKey map[string]string |
ShardKey: A key-value pair of shard keys to be applied for the request. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
MongoDBCollectionGetProperties_Status_ResourceARM
(Appears on:MongoDBCollectionGetProperties_StatusARM)
Field | Description |
---|---|
analyticalStorageTtl int |
AnalyticalStorageTtl: Analytical TTL. |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB MongoDB collection |
indexes []MongoIndex_StatusARM |
Indexes: List of index keys |
_rid string |
Rid: A system generated property. A unique identifier. |
shardKey map[string]string |
ShardKey: A key-value pair of shard keys to be applied for the request. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
MongoDBCollectionGetResults_Status
(Appears on:MongodbDatabaseCollection)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
options OptionsResource_Status |
|
resource MongoDBCollectionGetProperties_Status_Resource |
|
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
MongoDBCollectionGetResults_StatusARM
Field | Description |
---|---|
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
properties MongoDBCollectionGetProperties_StatusARM |
Properties: The properties of an Azure Cosmos DB MongoDB collection |
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
MongoDBCollectionResource
(Appears on:DatabaseAccountsMongodbDatabasesCollections_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/MongoDBCollectionResource
Field | Description |
---|---|
analyticalStorageTtl int |
AnalyticalStorageTtl: Analytical TTL. |
id string |
Id: Name of the Cosmos DB MongoDB collection |
indexes []MongoIndex |
Indexes: List of index keys |
shardKey map[string]string |
ShardKey: The shard key and partition kind pair, only support “Hash” partition kind |
MongoDBCollectionResourceARM
(Appears on:MongoDBCollectionCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/MongoDBCollectionResource
Field | Description |
---|---|
analyticalStorageTtl int |
AnalyticalStorageTtl: Analytical TTL. |
id string |
Id: Name of the Cosmos DB MongoDB collection |
indexes []MongoIndexARM |
Indexes: List of index keys |
shardKey map[string]string |
ShardKey: The shard key and partition kind pair, only support “Hash” partition kind |
MongoDBDatabaseCreateUpdatePropertiesARM
(Appears on:DatabaseAccountsMongodbDatabases_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/MongoDBDatabaseCreateUpdateProperties
Field | Description |
---|---|
options CreateUpdateOptionsARM |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
resource MongoDBDatabaseResourceARM |
Resource: Cosmos DB MongoDB database resource object |
MongoDBDatabaseGetProperties_StatusARM
(Appears on:MongoDBDatabaseGetResults_StatusARM)
Field | Description |
---|---|
options OptionsResource_StatusARM |
|
resource MongoDBDatabaseGetProperties_Status_ResourceARM |
MongoDBDatabaseGetProperties_Status_Resource
(Appears on:MongoDBDatabaseGetResults_Status)
Field | Description |
---|---|
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB MongoDB database |
_rid string |
Rid: A system generated property. A unique identifier. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
MongoDBDatabaseGetProperties_Status_ResourceARM
(Appears on:MongoDBDatabaseGetProperties_StatusARM)
Field | Description |
---|---|
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB MongoDB database |
_rid string |
Rid: A system generated property. A unique identifier. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
MongoDBDatabaseGetResults_Status
(Appears on:MongodbDatabase)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
options OptionsResource_Status |
|
resource MongoDBDatabaseGetProperties_Status_Resource |
|
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
MongoDBDatabaseGetResults_StatusARM
Field | Description |
---|---|
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
properties MongoDBDatabaseGetProperties_StatusARM |
Properties: The properties of an Azure Cosmos DB MongoDB database |
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
MongoDBDatabaseResource
(Appears on:DatabaseAccountsMongodbDatabases_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/MongoDBDatabaseResource
Field | Description |
---|---|
id string |
Id: Name of the Cosmos DB MongoDB database |
MongoDBDatabaseResourceARM
(Appears on:MongoDBDatabaseCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/MongoDBDatabaseResource
Field | Description |
---|---|
id string |
Id: Name of the Cosmos DB MongoDB database |
MongoIndex
(Appears on:MongoDBCollectionResource)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/MongoIndex
Field | Description |
---|---|
key MongoIndexKeys |
Key: Cosmos DB MongoDB collection resource object |
options MongoIndexOptions |
Options: Cosmos DB MongoDB collection index options |
MongoIndexARM
(Appears on:MongoDBCollectionResourceARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/MongoIndex
Field | Description |
---|---|
key MongoIndexKeysARM |
Key: Cosmos DB MongoDB collection resource object |
options MongoIndexOptionsARM |
Options: Cosmos DB MongoDB collection index options |
MongoIndexKeys
(Appears on:MongoIndex)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/MongoIndexKeys
Field | Description |
---|---|
keys []string |
Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service |
MongoIndexKeysARM
(Appears on:MongoIndexARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/MongoIndexKeys
Field | Description |
---|---|
keys []string |
Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service |
MongoIndexKeys_Status
(Appears on:MongoIndex_Status)
Field | Description |
---|---|
keys []string |
Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service |
MongoIndexKeys_StatusARM
(Appears on:MongoIndex_StatusARM)
Field | Description |
---|---|
keys []string |
Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service |
MongoIndexOptions
(Appears on:MongoIndex)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/MongoIndexOptions
Field | Description |
---|---|
expireAfterSeconds int |
ExpireAfterSeconds: Expire after seconds |
unique bool |
Unique: Is unique or not |
MongoIndexOptionsARM
(Appears on:MongoIndexARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/MongoIndexOptions
Field | Description |
---|---|
expireAfterSeconds int |
ExpireAfterSeconds: Expire after seconds |
unique bool |
Unique: Is unique or not |
MongoIndexOptions_Status
(Appears on:MongoIndex_Status)
Field | Description |
---|---|
expireAfterSeconds int |
ExpireAfterSeconds: Expire after seconds |
unique bool |
Unique: Is unique or not |
MongoIndexOptions_StatusARM
(Appears on:MongoIndex_StatusARM)
Field | Description |
---|---|
expireAfterSeconds int |
ExpireAfterSeconds: Expire after seconds |
unique bool |
Unique: Is unique or not |
MongoIndex_Status
(Appears on:MongoDBCollectionGetProperties_Status_Resource)
Field | Description |
---|---|
key MongoIndexKeys_Status |
Key: Cosmos DB MongoDB collection index keys |
options MongoIndexOptions_Status |
Options: Cosmos DB MongoDB collection index key options |
MongoIndex_StatusARM
(Appears on:MongoDBCollectionGetProperties_Status_ResourceARM)
Field | Description |
---|---|
key MongoIndexKeys_StatusARM |
Key: Cosmos DB MongoDB collection index keys |
options MongoIndexOptions_StatusARM |
Options: Cosmos DB MongoDB collection index key options |
MongodbDatabase
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/resourceDefinitions/databaseAccounts_mongodbDatabases
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec DatabaseAccountsMongodbDatabases_Spec |
|
||||||||||||
status MongoDBDatabaseGetResults_Status |
MongodbDatabaseCollection
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec DatabaseAccountsMongodbDatabasesCollections_Spec |
|
||||||||||||
status MongoDBCollectionGetResults_Status |
MongodbDatabaseCollectionThroughputSetting
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec DatabaseAccountsMongodbDatabasesCollectionsThroughputSettings_Spec |
|
||||||||
status ThroughputSettingsGetResults_Status |
MongodbDatabaseThroughputSetting
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec DatabaseAccountsMongodbDatabasesThroughputSettings_Spec |
|
||||||||
status ThroughputSettingsGetResults_Status |
NetworkAclBypass_Status
(string
alias)
(Appears on:DatabaseAccountGetProperties_StatusARM, DatabaseAccountGetResults_Status)
Value | Description |
---|---|
"AzureServices" |
|
"None" |
OptionsResource_Status
(Appears on:MongoDBCollectionGetResults_Status, MongoDBDatabaseGetResults_Status, SqlContainerGetResults_Status, SqlDatabaseGetResults_Status)
Field | Description |
---|---|
autoscaleSettings AutoscaleSettings_Status |
AutoscaleSettings: Specifies the Autoscale settings. |
throughput int |
Throughput: Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details. |
OptionsResource_StatusARM
(Appears on:MongoDBCollectionGetProperties_StatusARM, MongoDBDatabaseGetProperties_StatusARM, SqlContainerGetProperties_StatusARM, SqlDatabaseGetProperties_StatusARM)
Field | Description |
---|---|
autoscaleSettings AutoscaleSettings_StatusARM |
AutoscaleSettings: Specifies the Autoscale settings. |
throughput int |
Throughput: Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details. |
PeriodicModeBackupPolicy
(Appears on:BackupPolicy)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/PeriodicModeBackupPolicy
Field | Description |
---|---|
periodicModeProperties PeriodicModeProperties |
PeriodicModeProperties: Configuration values for periodic mode backup |
type PeriodicModeBackupPolicyType |
PeriodicModeBackupPolicyARM
(Appears on:BackupPolicyARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/PeriodicModeBackupPolicy
Field | Description |
---|---|
periodicModeProperties PeriodicModePropertiesARM |
PeriodicModeProperties: Configuration values for periodic mode backup |
type PeriodicModeBackupPolicyType |
PeriodicModeBackupPolicyType
(string
alias)
(Appears on:PeriodicModeBackupPolicy, PeriodicModeBackupPolicyARM)
Value | Description |
---|---|
"Periodic" |
PeriodicModeProperties
(Appears on:PeriodicModeBackupPolicy)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/PeriodicModeProperties
Field | Description |
---|---|
backupIntervalInMinutes int |
BackupIntervalInMinutes: An integer representing the interval in minutes between two backups |
backupRetentionIntervalInHours int |
BackupRetentionIntervalInHours: An integer representing the time (in hours) that each backup is retained |
PeriodicModePropertiesARM
(Appears on:PeriodicModeBackupPolicyARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/PeriodicModeProperties
Field | Description |
---|---|
backupIntervalInMinutes int |
BackupIntervalInMinutes: An integer representing the interval in minutes between two backups |
backupRetentionIntervalInHours int |
BackupRetentionIntervalInHours: An integer representing the time (in hours) that each backup is retained |
PrivateEndpointConnection_Status_SubResourceEmbedded
(Appears on:DatabaseAccountGetResults_Status)
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
PrivateEndpointConnection_Status_SubResourceEmbeddedARM
(Appears on:DatabaseAccountGetProperties_StatusARM)
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
PublicNetworkAccess_Status
(string
alias)
(Appears on:DatabaseAccountGetProperties_StatusARM, DatabaseAccountGetResults_Status)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
SpatialSpec
(Appears on:IndexingPolicy)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SpatialSpec
Field | Description |
---|---|
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
types []SpatialSpecTypes |
Types: List of path’s spatial type |
SpatialSpecARM
(Appears on:IndexingPolicyARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SpatialSpec
Field | Description |
---|---|
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
types []SpatialSpecTypes |
Types: List of path’s spatial type |
SpatialSpecTypes
(string
alias)
(Appears on:SpatialSpec, SpatialSpecARM)
Value | Description |
---|---|
"LineString" |
|
"MultiPolygon" |
|
"Point" |
|
"Polygon" |
SpatialSpec_Status
(Appears on:IndexingPolicy_Status)
Field | Description |
---|---|
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
types []SpatialType_Status |
Types: List of path’s spatial type |
SpatialSpec_StatusARM
(Appears on:IndexingPolicy_StatusARM)
Field | Description |
---|---|
path string |
Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) |
types []SpatialType_Status |
Types: List of path’s spatial type |
SpatialType_Status
(string
alias)
(Appears on:SpatialSpec_Status, SpatialSpec_StatusARM)
Value | Description |
---|---|
"LineString" |
|
"MultiPolygon" |
|
"Point" |
|
"Polygon" |
SqlContainerCreateUpdatePropertiesARM
(Appears on:DatabaseAccountsSqlDatabasesContainers_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlContainerCreateUpdateProperties
Field | Description |
---|---|
options CreateUpdateOptionsARM |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
resource SqlContainerResourceARM |
Resource: Cosmos DB SQL container resource object |
SqlContainerGetProperties_StatusARM
(Appears on:SqlContainerGetResults_StatusARM)
Field | Description |
---|---|
options OptionsResource_StatusARM |
|
resource SqlContainerGetProperties_Status_ResourceARM |
SqlContainerGetProperties_Status_Resource
(Appears on:SqlContainerGetResults_Status)
Field | Description |
---|---|
analyticalStorageTtl int |
AnalyticalStorageTtl: Analytical TTL. |
conflictResolutionPolicy ConflictResolutionPolicy_Status |
ConflictResolutionPolicy: The conflict resolution policy for the container. |
defaultTtl int |
DefaultTtl: Default time to live |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB SQL container |
indexingPolicy IndexingPolicy_Status |
IndexingPolicy: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container |
partitionKey ContainerPartitionKey_Status |
PartitionKey: The configuration of the partition key to be used for partitioning data into multiple partitions |
_rid string |
Rid: A system generated property. A unique identifier. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
uniqueKeyPolicy UniqueKeyPolicy_Status |
UniqueKeyPolicy: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. |
SqlContainerGetProperties_Status_ResourceARM
(Appears on:SqlContainerGetProperties_StatusARM)
Field | Description |
---|---|
analyticalStorageTtl int |
AnalyticalStorageTtl: Analytical TTL. |
conflictResolutionPolicy ConflictResolutionPolicy_StatusARM |
ConflictResolutionPolicy: The conflict resolution policy for the container. |
defaultTtl int |
DefaultTtl: Default time to live |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB SQL container |
indexingPolicy IndexingPolicy_StatusARM |
IndexingPolicy: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container |
partitionKey ContainerPartitionKey_StatusARM |
PartitionKey: The configuration of the partition key to be used for partitioning data into multiple partitions |
_rid string |
Rid: A system generated property. A unique identifier. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
uniqueKeyPolicy UniqueKeyPolicy_StatusARM |
UniqueKeyPolicy: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. |
SqlContainerGetResults_Status
(Appears on:SqlDatabaseContainer)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
options OptionsResource_Status |
|
resource SqlContainerGetProperties_Status_Resource |
|
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
SqlContainerGetResults_StatusARM
Field | Description |
---|---|
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
properties SqlContainerGetProperties_StatusARM |
Properties: The properties of an Azure Cosmos DB container |
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
SqlContainerResource
(Appears on:DatabaseAccountsSqlDatabasesContainers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlContainerResource
Field | Description |
---|---|
analyticalStorageTtl int |
AnalyticalStorageTtl: Analytical TTL. |
conflictResolutionPolicy ConflictResolutionPolicy |
ConflictResolutionPolicy: The conflict resolution policy for the container. |
defaultTtl int |
DefaultTtl: Default time to live |
id string |
Id: Name of the Cosmos DB SQL container |
indexingPolicy IndexingPolicy |
IndexingPolicy: Cosmos DB indexing policy |
partitionKey ContainerPartitionKey |
PartitionKey: The configuration of the partition key to be used for partitioning data into multiple partitions |
uniqueKeyPolicy UniqueKeyPolicy |
UniqueKeyPolicy: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. |
SqlContainerResourceARM
(Appears on:SqlContainerCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlContainerResource
Field | Description |
---|---|
analyticalStorageTtl int |
AnalyticalStorageTtl: Analytical TTL. |
conflictResolutionPolicy ConflictResolutionPolicyARM |
ConflictResolutionPolicy: The conflict resolution policy for the container. |
defaultTtl int |
DefaultTtl: Default time to live |
id string |
Id: Name of the Cosmos DB SQL container |
indexingPolicy IndexingPolicyARM |
IndexingPolicy: Cosmos DB indexing policy |
partitionKey ContainerPartitionKeyARM |
PartitionKey: The configuration of the partition key to be used for partitioning data into multiple partitions |
uniqueKeyPolicy UniqueKeyPolicyARM |
UniqueKeyPolicy: The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. |
SqlDatabase
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/resourceDefinitions/databaseAccounts_sqlDatabases
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec DatabaseAccountsSqlDatabases_Spec |
|
||||||||||||
status SqlDatabaseGetResults_Status |
SqlDatabaseContainer
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/resourceDefinitions/databaseAccounts_sqlDatabases_containers
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec DatabaseAccountsSqlDatabasesContainers_Spec |
|
||||||||||||
status SqlContainerGetResults_Status |
SqlDatabaseContainerStoredProcedure
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec DatabaseAccountsSqlDatabasesContainersStoredProcedures_Spec |
|
||||||||||||
status SqlStoredProcedureGetResults_Status |
SqlDatabaseContainerThroughputSetting
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec DatabaseAccountsSqlDatabasesContainersThroughputSettings_Spec |
|
||||||||
status ThroughputSettingsGetResults_Status |
SqlDatabaseContainerTrigger
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec DatabaseAccountsSqlDatabasesContainersTriggers_Spec |
|
||||||||||||
status SqlTriggerGetResults_Status |
SqlDatabaseContainerUserDefinedFunction
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
spec DatabaseAccountsSqlDatabasesContainersUserDefinedFunctions_Spec |
|
||||||||||||
status SqlUserDefinedFunctionGetResults_Status |
SqlDatabaseCreateUpdatePropertiesARM
(Appears on:DatabaseAccountsSqlDatabases_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlDatabaseCreateUpdateProperties
Field | Description |
---|---|
options CreateUpdateOptionsARM |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
resource SqlDatabaseResourceARM |
Resource: Cosmos DB SQL database resource object |
SqlDatabaseGetProperties_StatusARM
(Appears on:SqlDatabaseGetResults_StatusARM)
Field | Description |
---|---|
options OptionsResource_StatusARM |
|
resource SqlDatabaseGetProperties_Status_ResourceARM |
SqlDatabaseGetProperties_Status_Resource
(Appears on:SqlDatabaseGetResults_Status)
Field | Description |
---|---|
_colls string |
Colls: A system generated property that specified the addressable path of the collections resource. |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB SQL database |
_rid string |
Rid: A system generated property. A unique identifier. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
_users string |
Users: A system generated property that specifies the addressable path of the users resource. |
SqlDatabaseGetProperties_Status_ResourceARM
(Appears on:SqlDatabaseGetProperties_StatusARM)
Field | Description |
---|---|
_colls string |
Colls: A system generated property that specified the addressable path of the collections resource. |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB SQL database |
_rid string |
Rid: A system generated property. A unique identifier. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
_users string |
Users: A system generated property that specifies the addressable path of the users resource. |
SqlDatabaseGetResults_Status
(Appears on:SqlDatabase)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
options OptionsResource_Status |
|
resource SqlDatabaseGetProperties_Status_Resource |
|
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
SqlDatabaseGetResults_StatusARM
Field | Description |
---|---|
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
properties SqlDatabaseGetProperties_StatusARM |
Properties: The properties of an Azure Cosmos DB SQL database |
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
SqlDatabaseResource
(Appears on:DatabaseAccountsSqlDatabases_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlDatabaseResource
Field | Description |
---|---|
id string |
Id: Name of the Cosmos DB SQL database |
SqlDatabaseResourceARM
(Appears on:SqlDatabaseCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlDatabaseResource
Field | Description |
---|---|
id string |
Id: Name of the Cosmos DB SQL database |
SqlDatabaseThroughputSetting
Field | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
spec DatabaseAccountsSqlDatabasesThroughputSettings_Spec |
|
||||||||
status ThroughputSettingsGetResults_Status |
SqlStoredProcedureCreateUpdatePropertiesARM
(Appears on:DatabaseAccountsSqlDatabasesContainersStoredProcedures_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlStoredProcedureCreateUpdateProperties
Field | Description |
---|---|
options CreateUpdateOptionsARM |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
resource SqlStoredProcedureResourceARM |
Resource: Cosmos DB SQL storedProcedure resource object |
SqlStoredProcedureGetProperties_StatusARM
(Appears on:SqlStoredProcedureGetResults_StatusARM)
Field | Description |
---|---|
resource SqlStoredProcedureGetProperties_Status_ResourceARM |
SqlStoredProcedureGetProperties_Status_Resource
(Appears on:SqlStoredProcedureGetResults_Status)
Field | Description |
---|---|
body string |
Body: Body of the Stored Procedure |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB SQL storedProcedure |
_rid string |
Rid: A system generated property. A unique identifier. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
SqlStoredProcedureGetProperties_Status_ResourceARM
(Appears on:SqlStoredProcedureGetProperties_StatusARM)
Field | Description |
---|---|
body string |
Body: Body of the Stored Procedure |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB SQL storedProcedure |
_rid string |
Rid: A system generated property. A unique identifier. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
SqlStoredProcedureGetResults_Status
(Appears on:SqlDatabaseContainerStoredProcedure)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
resource SqlStoredProcedureGetProperties_Status_Resource |
|
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
SqlStoredProcedureGetResults_StatusARM
Field | Description |
---|---|
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
properties SqlStoredProcedureGetProperties_StatusARM |
Properties: The properties of an Azure Cosmos DB storedProcedure |
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
SqlStoredProcedureResource
(Appears on:DatabaseAccountsSqlDatabasesContainersStoredProcedures_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlStoredProcedureResource
Field | Description |
---|---|
body string |
Body: Body of the Stored Procedure |
id string |
Id: Name of the Cosmos DB SQL storedProcedure |
SqlStoredProcedureResourceARM
(Appears on:SqlStoredProcedureCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlStoredProcedureResource
Field | Description |
---|---|
body string |
Body: Body of the Stored Procedure |
id string |
Id: Name of the Cosmos DB SQL storedProcedure |
SqlTriggerCreateUpdatePropertiesARM
(Appears on:DatabaseAccountsSqlDatabasesContainersTriggers_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlTriggerCreateUpdateProperties
Field | Description |
---|---|
options CreateUpdateOptionsARM |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
resource SqlTriggerResourceARM |
Resource: Cosmos DB SQL trigger resource object |
SqlTriggerGetPropertiesStatusResourceTriggerOperation
(string
alias)
(Appears on:SqlTriggerGetProperties_Status_Resource, SqlTriggerGetProperties_Status_ResourceARM)
Value | Description |
---|---|
"All" |
|
"Create" |
|
"Delete" |
|
"Replace" |
|
"Update" |
SqlTriggerGetPropertiesStatusResourceTriggerType
(string
alias)
(Appears on:SqlTriggerGetProperties_Status_Resource, SqlTriggerGetProperties_Status_ResourceARM)
Value | Description |
---|---|
"Post" |
|
"Pre" |
SqlTriggerGetProperties_StatusARM
(Appears on:SqlTriggerGetResults_StatusARM)
Field | Description |
---|---|
resource SqlTriggerGetProperties_Status_ResourceARM |
SqlTriggerGetProperties_Status_Resource
(Appears on:SqlTriggerGetResults_Status)
Field | Description |
---|---|
body string |
Body: Body of the Trigger |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB SQL trigger |
_rid string |
Rid: A system generated property. A unique identifier. |
triggerOperation SqlTriggerGetPropertiesStatusResourceTriggerOperation |
TriggerOperation: The operation the trigger is associated with |
triggerType SqlTriggerGetPropertiesStatusResourceTriggerType |
TriggerType: Type of the Trigger |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
SqlTriggerGetProperties_Status_ResourceARM
(Appears on:SqlTriggerGetProperties_StatusARM)
Field | Description |
---|---|
body string |
Body: Body of the Trigger |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB SQL trigger |
_rid string |
Rid: A system generated property. A unique identifier. |
triggerOperation SqlTriggerGetPropertiesStatusResourceTriggerOperation |
TriggerOperation: The operation the trigger is associated with |
triggerType SqlTriggerGetPropertiesStatusResourceTriggerType |
TriggerType: Type of the Trigger |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
SqlTriggerGetResults_Status
(Appears on:SqlDatabaseContainerTrigger)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
resource SqlTriggerGetProperties_Status_Resource |
|
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
SqlTriggerGetResults_StatusARM
Field | Description |
---|---|
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
properties SqlTriggerGetProperties_StatusARM |
Properties: The properties of an Azure Cosmos DB trigger |
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
SqlTriggerResource
(Appears on:DatabaseAccountsSqlDatabasesContainersTriggers_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlTriggerResource
Field | Description |
---|---|
body string |
Body: Body of the Trigger |
id string |
Id: Name of the Cosmos DB SQL trigger |
triggerOperation SqlTriggerResourceTriggerOperation |
TriggerOperation: The operation the trigger is associated with. |
triggerType SqlTriggerResourceTriggerType |
TriggerType: Type of the Trigger. |
SqlTriggerResourceARM
(Appears on:SqlTriggerCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlTriggerResource
Field | Description |
---|---|
body string |
Body: Body of the Trigger |
id string |
Id: Name of the Cosmos DB SQL trigger |
triggerOperation SqlTriggerResourceTriggerOperation |
TriggerOperation: The operation the trigger is associated with. |
triggerType SqlTriggerResourceTriggerType |
TriggerType: Type of the Trigger. |
SqlTriggerResourceTriggerOperation
(string
alias)
(Appears on:SqlTriggerResource, SqlTriggerResourceARM)
Value | Description |
---|---|
"All" |
|
"Create" |
|
"Delete" |
|
"Replace" |
|
"Update" |
SqlTriggerResourceTriggerType
(string
alias)
(Appears on:SqlTriggerResource, SqlTriggerResourceARM)
Value | Description |
---|---|
"Post" |
|
"Pre" |
SqlUserDefinedFunctionCreateUpdatePropertiesARM
(Appears on:DatabaseAccountsSqlDatabasesContainersUserDefinedFunctions_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlUserDefinedFunctionCreateUpdateProperties
Field | Description |
---|---|
options CreateUpdateOptionsARM |
Options: CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, “If-None-Match”, “Session-Token” and “Throughput” |
resource SqlUserDefinedFunctionResourceARM |
Resource: Cosmos DB SQL userDefinedFunction resource object |
SqlUserDefinedFunctionGetProperties_StatusARM
(Appears on:SqlUserDefinedFunctionGetResults_StatusARM)
Field | Description |
---|---|
resource SqlUserDefinedFunctionGetProperties_Status_ResourceARM |
SqlUserDefinedFunctionGetProperties_Status_Resource
(Appears on:SqlUserDefinedFunctionGetResults_Status)
Field | Description |
---|---|
body string |
Body: Body of the User Defined Function |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB SQL userDefinedFunction |
_rid string |
Rid: A system generated property. A unique identifier. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
SqlUserDefinedFunctionGetProperties_Status_ResourceARM
(Appears on:SqlUserDefinedFunctionGetProperties_StatusARM)
Field | Description |
---|---|
body string |
Body: Body of the User Defined Function |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
id string |
Id: Name of the Cosmos DB SQL userDefinedFunction |
_rid string |
Rid: A system generated property. A unique identifier. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
SqlUserDefinedFunctionGetResults_Status
(Appears on:SqlDatabaseContainerUserDefinedFunction)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
resource SqlUserDefinedFunctionGetProperties_Status_Resource |
|
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
SqlUserDefinedFunctionGetResults_StatusARM
Field | Description |
---|---|
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
properties SqlUserDefinedFunctionGetProperties_StatusARM |
Properties: The properties of an Azure Cosmos DB userDefinedFunction |
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
SqlUserDefinedFunctionResource
(Appears on:DatabaseAccountsSqlDatabasesContainersUserDefinedFunctions_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlUserDefinedFunctionResource
Field | Description |
---|---|
body string |
Body: Body of the User Defined Function |
id string |
Id: Name of the Cosmos DB SQL userDefinedFunction |
SqlUserDefinedFunctionResourceARM
(Appears on:SqlUserDefinedFunctionCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/SqlUserDefinedFunctionResource
Field | Description |
---|---|
body string |
Body: Body of the User Defined Function |
id string |
Id: Name of the Cosmos DB SQL userDefinedFunction |
ThroughputPolicyResource
(Appears on:AutoUpgradePolicyResource)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ThroughputPolicyResource
Field | Description |
---|---|
incrementPercent int |
IncrementPercent: Represents the percentage by which throughput can increase every time throughput policy kicks in. |
isEnabled bool |
IsEnabled: Determines whether the ThroughputPolicy is active or not |
ThroughputPolicyResourceARM
(Appears on:AutoUpgradePolicyResourceARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ThroughputPolicyResource
Field | Description |
---|---|
incrementPercent int |
IncrementPercent: Represents the percentage by which throughput can increase every time throughput policy kicks in. |
isEnabled bool |
IsEnabled: Determines whether the ThroughputPolicy is active or not |
ThroughputPolicyResource_Status
(Appears on:AutoUpgradePolicyResource_Status)
Field | Description |
---|---|
incrementPercent int |
IncrementPercent: Represents the percentage by which throughput can increase every time throughput policy kicks in. |
isEnabled bool |
IsEnabled: Determines whether the ThroughputPolicy is active or not |
ThroughputPolicyResource_StatusARM
(Appears on:AutoUpgradePolicyResource_StatusARM)
Field | Description |
---|---|
incrementPercent int |
IncrementPercent: Represents the percentage by which throughput can increase every time throughput policy kicks in. |
isEnabled bool |
IsEnabled: Determines whether the ThroughputPolicy is active or not |
ThroughputSettingsGetProperties_StatusARM
(Appears on:ThroughputSettingsGetResults_StatusARM)
Field | Description |
---|---|
resource ThroughputSettingsGetProperties_Status_ResourceARM |
ThroughputSettingsGetProperties_Status_Resource
(Appears on:ThroughputSettingsGetResults_Status)
Field | Description |
---|---|
autoscaleSettings AutoscaleSettingsResource_Status |
AutoscaleSettings: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
minimumThroughput string |
MinimumThroughput: The minimum throughput of the resource |
offerReplacePending string |
OfferReplacePending: The throughput replace is pending |
_rid string |
Rid: A system generated property. A unique identifier. |
throughput int |
Throughput: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
ThroughputSettingsGetProperties_Status_ResourceARM
(Appears on:ThroughputSettingsGetProperties_StatusARM)
Field | Description |
---|---|
autoscaleSettings AutoscaleSettingsResource_StatusARM |
AutoscaleSettings: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both. |
_etag string |
Etag: A system generated property representing the resource etag required for optimistic concurrency control. |
minimumThroughput string |
MinimumThroughput: The minimum throughput of the resource |
offerReplacePending string |
OfferReplacePending: The throughput replace is pending |
_rid string |
Rid: A system generated property. A unique identifier. |
throughput int |
Throughput: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. |
_ts float64 |
Ts: A system generated property that denotes the last updated timestamp of the resource. |
ThroughputSettingsGetResults_Status
(Appears on:MongodbDatabaseCollectionThroughputSetting, MongodbDatabaseThroughputSetting, SqlDatabaseContainerThroughputSetting, SqlDatabaseThroughputSetting)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
resource ThroughputSettingsGetProperties_Status_Resource |
|
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
ThroughputSettingsGetResults_StatusARM
Field | Description |
---|---|
id string |
Id: The unique resource identifier of the ARM resource. |
location string |
Location: The location of the resource group to which the resource belongs. |
name string |
Name: The name of the ARM resource. |
properties ThroughputSettingsGetProperties_StatusARM |
Properties: The properties of an Azure Cosmos DB resource throughput |
tags map[string]string |
|
type string |
Type: The type of Azure resource. |
ThroughputSettingsResource
(Appears on:DatabaseAccountsMongodbDatabasesCollectionsThroughputSettings_Spec, DatabaseAccountsMongodbDatabasesThroughputSettings_Spec, DatabaseAccountsSqlDatabasesContainersThroughputSettings_Spec, DatabaseAccountsSqlDatabasesThroughputSettings_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ThroughputSettingsResource
Field | Description |
---|---|
autoscaleSettings AutoscaleSettingsResource |
AutoscaleSettings: Cosmos DB provisioned throughput settings object |
throughput int |
Throughput: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. |
ThroughputSettingsResourceARM
(Appears on:ThroughputSettingsUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ThroughputSettingsResource
Field | Description |
---|---|
autoscaleSettings AutoscaleSettingsResourceARM |
AutoscaleSettings: Cosmos DB provisioned throughput settings object |
throughput int |
Throughput: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both. |
ThroughputSettingsUpdatePropertiesARM
(Appears on:DatabaseAccountsMongodbDatabasesCollectionsThroughputSettings_SpecARM, DatabaseAccountsMongodbDatabasesThroughputSettings_SpecARM, DatabaseAccountsSqlDatabasesContainersThroughputSettings_SpecARM, DatabaseAccountsSqlDatabasesThroughputSettings_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/ThroughputSettingsUpdateProperties
Field | Description |
---|---|
resource ThroughputSettingsResourceARM |
Resource: Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both. |
UniqueKey
(Appears on:UniqueKeyPolicy)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/UniqueKey
Field | Description |
---|---|
paths []string |
Paths: List of paths must be unique for each document in the Azure Cosmos DB service |
UniqueKeyARM
(Appears on:UniqueKeyPolicyARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/UniqueKey
Field | Description |
---|---|
paths []string |
Paths: List of paths must be unique for each document in the Azure Cosmos DB service |
UniqueKeyPolicy
(Appears on:SqlContainerResource)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/UniqueKeyPolicy
Field | Description |
---|---|
uniqueKeys []UniqueKey |
UniqueKeys: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. |
UniqueKeyPolicyARM
(Appears on:SqlContainerResourceARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/UniqueKeyPolicy
Field | Description |
---|---|
uniqueKeys []UniqueKeyARM |
UniqueKeys: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. |
UniqueKeyPolicy_Status
(Appears on:SqlContainerGetProperties_Status_Resource)
Field | Description |
---|---|
uniqueKeys []UniqueKey_Status |
UniqueKeys: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. |
UniqueKeyPolicy_StatusARM
(Appears on:SqlContainerGetProperties_Status_ResourceARM)
Field | Description |
---|---|
uniqueKeys []UniqueKey_StatusARM |
UniqueKeys: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. |
UniqueKey_Status
(Appears on:UniqueKeyPolicy_Status)
Field | Description |
---|---|
paths []string |
Paths: List of paths must be unique for each document in the Azure Cosmos DB service |
UniqueKey_StatusARM
(Appears on:UniqueKeyPolicy_StatusARM)
Field | Description |
---|---|
paths []string |
Paths: List of paths must be unique for each document in the Azure Cosmos DB service |
VirtualNetworkRule
(Appears on:DatabaseAccounts_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/VirtualNetworkRule
Field | Description |
---|---|
ignoreMissingVNetServiceEndpoint bool |
IgnoreMissingVNetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled. |
reference genruntime.ResourceReference |
Reference: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.p> |
VirtualNetworkRuleARM
(Appears on:DatabaseAccountCreateUpdatePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-05-15/Microsoft.DocumentDB.json#/definitions/VirtualNetworkRule
Field | Description |
---|---|
id string |
|
ignoreMissingVNetServiceEndpoint bool |
IgnoreMissingVNetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled. |
VirtualNetworkRule_Status
(Appears on:DatabaseAccountGetResults_Status)
Field | Description |
---|---|
id string |
Id: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.p> |
ignoreMissingVNetServiceEndpoint bool |
IgnoreMissingVNetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled. |
VirtualNetworkRule_StatusARM
(Appears on:DatabaseAccountGetProperties_StatusARM)
Field | Description |
---|---|
id string |
Id: Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}.p> |
ignoreMissingVNetServiceEndpoint bool |
IgnoreMissingVNetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled. |