documentdb.azure.com/v1api20210515

documentdb.azure.com/v1api20210515

Package v1api20210515 contains API Schema definitions for the documentdb v1api20210515 API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2021-05-15"

    AnalyticalStorageConfiguration

    (Appears on:DatabaseAccount_Spec)

    Analytical storage specific properties.

    Field Description
    schemaType
    AnalyticalStorageSchemaType

    SchemaType: Describes the types of schema for analytical storage.

    AnalyticalStorageConfiguration_ARM

    (Appears on:DatabaseAccountCreateUpdateProperties_ARM)

    Analytical storage specific properties.

    Field Description
    schemaType
    AnalyticalStorageSchemaType

    SchemaType: Describes the types of schema for analytical storage.

    AnalyticalStorageConfiguration_STATUS

    (Appears on:DatabaseAccount_STATUS)

    Analytical storage specific properties.

    Field Description
    schemaType
    AnalyticalStorageSchemaType_STATUS

    SchemaType: Describes the types of schema for analytical storage.

    AnalyticalStorageConfiguration_STATUS_ARM

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM)

    Analytical storage specific properties.

    Field Description
    schemaType
    AnalyticalStorageSchemaType_STATUS

    SchemaType: Describes the types of schema for analytical storage.

    AnalyticalStorageSchemaType (string alias)

    (Appears on:AnalyticalStorageConfiguration, AnalyticalStorageConfiguration_ARM)

    Describes the types of schema for analytical storage.

    Value Description

    "FullFidelity"

    "WellDefined"

    AnalyticalStorageSchemaType_STATUS (string alias)

    (Appears on:AnalyticalStorageConfiguration_STATUS, AnalyticalStorageConfiguration_STATUS_ARM)

    Describes the types of schema for analytical storage.

    Value Description

    "FullFidelity"

    "WellDefined"

    ApiProperties

    (Appears on:DatabaseAccount_Spec)

    Field Description
    serverVersion
    ApiProperties_ServerVersion

    ServerVersion: Describes the ServerVersion of an a MongoDB account.

    ApiProperties_ARM

    (Appears on:DatabaseAccountCreateUpdateProperties_ARM)

    Field Description
    serverVersion
    ApiProperties_ServerVersion

    ServerVersion: Describes the ServerVersion of an a MongoDB account.

    ApiProperties_STATUS

    (Appears on:DatabaseAccount_STATUS)

    Field Description
    serverVersion
    ApiProperties_ServerVersion_STATUS

    ServerVersion: Describes the ServerVersion of an a MongoDB account.

    ApiProperties_STATUS_ARM

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM)

    Field Description
    serverVersion
    ApiProperties_ServerVersion_STATUS

    ServerVersion: Describes the ServerVersion of an a MongoDB account.

    ApiProperties_ServerVersion (string alias)

    (Appears on:ApiProperties, ApiProperties_ARM)

    Value Description

    "3.2"

    "3.6"

    "4.0"

    ApiProperties_ServerVersion_STATUS (string alias)

    (Appears on:ApiProperties_STATUS, ApiProperties_STATUS_ARM)

    Value Description

    "3.2"

    "3.6"

    "4.0"

    AutoUpgradePolicyResource

    (Appears on:AutoscaleSettingsResource)

    Cosmos DB resource auto-upgrade policy

    Field Description
    throughputPolicy
    ThroughputPolicyResource

    ThroughputPolicy: Represents throughput policy which service must adhere to for auto-upgrade

    AutoUpgradePolicyResource_ARM

    (Appears on:AutoscaleSettingsResource_ARM)

    Cosmos DB resource auto-upgrade policy

    Field Description
    throughputPolicy
    ThroughputPolicyResource_ARM

    ThroughputPolicy: Represents throughput policy which service must adhere to for auto-upgrade

    AutoUpgradePolicyResource_STATUS

    (Appears on:AutoscaleSettingsResource_STATUS)

    Cosmos DB resource auto-upgrade policy

    Field Description
    throughputPolicy
    ThroughputPolicyResource_STATUS

    ThroughputPolicy: Represents throughput policy which service must adhere to for auto-upgrade

    AutoUpgradePolicyResource_STATUS_ARM

    (Appears on:AutoscaleSettingsResource_STATUS_ARM)

    Cosmos DB resource auto-upgrade policy

    Field Description
    throughputPolicy
    ThroughputPolicyResource_STATUS_ARM

    ThroughputPolicy: Represents throughput policy which service must adhere to for auto-upgrade

    AutoscaleSettings

    (Appears on:CreateUpdateOptions)

    Field Description
    maxThroughput
    int

    MaxThroughput: Represents maximum throughput, the resource can scale up to.

    AutoscaleSettingsResource

    (Appears on:ThroughputSettingsResource)

    Cosmos DB provisioned throughput settings object

    Field Description
    autoUpgradePolicy
    AutoUpgradePolicyResource

    AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy

    maxThroughput
    int

    MaxThroughput: Represents maximum throughput container can scale up to.

    AutoscaleSettingsResource_ARM

    (Appears on:ThroughputSettingsResource_ARM)

    Cosmos DB provisioned throughput settings object

    Field Description
    autoUpgradePolicy
    AutoUpgradePolicyResource_ARM

    AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy

    maxThroughput
    int

    MaxThroughput: Represents maximum throughput container can scale up to.

    AutoscaleSettingsResource_STATUS

    (Appears on:ThroughputSettingsGetProperties_Resource_STATUS)

    Cosmos DB provisioned throughput settings object

    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_STATUS_ARM

    (Appears on:ThroughputSettingsGetProperties_Resource_STATUS_ARM)

    Cosmos DB provisioned throughput settings object

    Field Description
    autoUpgradePolicy
    AutoUpgradePolicyResource_STATUS_ARM

    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_ARM

    (Appears on:CreateUpdateOptions_ARM)

    Field Description
    maxThroughput
    int

    MaxThroughput: Represents maximum throughput, the resource can scale up to.

    AutoscaleSettings_STATUS

    (Appears on:OptionsResource_STATUS)

    Field Description
    maxThroughput
    int

    MaxThroughput: Represents maximum throughput, the resource can scale up to.

    AutoscaleSettings_STATUS_ARM

    (Appears on:OptionsResource_STATUS_ARM)

    Field Description
    maxThroughput
    int

    MaxThroughput: Represents maximum throughput, the resource can scale up to.

    BackupPolicy

    (Appears on:DatabaseAccount_Spec)

    Field Description
    continuous
    ContinuousModeBackupPolicy

    Continuous: Mutually exclusive with all other properties

    periodic
    PeriodicModeBackupPolicy

    Periodic: Mutually exclusive with all other properties

    BackupPolicy_ARM

    (Appears on:DatabaseAccountCreateUpdateProperties_ARM)

    Field Description
    continuous
    ContinuousModeBackupPolicy_ARM

    Continuous: Mutually exclusive with all other properties

    periodic
    PeriodicModeBackupPolicy_ARM

    Periodic: Mutually exclusive with all other properties

    BackupPolicy_STATUS

    (Appears on:DatabaseAccount_STATUS)

    Field Description
    continuous
    ContinuousModeBackupPolicy_STATUS

    Continuous: Mutually exclusive with all other properties

    periodic
    PeriodicModeBackupPolicy_STATUS

    Periodic: Mutually exclusive with all other properties

    BackupPolicy_STATUS_ARM

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM)

    Field Description
    continuous
    ContinuousModeBackupPolicy_STATUS_ARM

    Continuous: Mutually exclusive with all other properties

    periodic
    PeriodicModeBackupPolicy_STATUS_ARM

    Periodic: Mutually exclusive with all other properties

    Capability

    (Appears on:DatabaseAccount_Spec)

    Cosmos DB capability object

    Field Description
    name
    string

    Name: Name of the Cosmos DB capability. For example, “name”: “EnableCassandra”. Current values also include “EnableTable” and “EnableGremlin”.

    Capability_ARM

    (Appears on:DatabaseAccountCreateUpdateProperties_ARM)

    Cosmos DB capability object

    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:DatabaseAccount_STATUS)

    Cosmos DB capability object

    Field Description
    name
    string

    Name: Name of the Cosmos DB capability. For example, “name”: “EnableCassandra”. Current values also include “EnableTable” and “EnableGremlin”.

    Capability_STATUS_ARM

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM)

    Cosmos DB capability object

    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)

    Field Description
    order
    CompositePath_Order

    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_ARM

    (Appears on:IndexingPolicy_ARM)

    Field Description
    order
    CompositePath_Order

    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_Order (string alias)

    (Appears on:CompositePath, CompositePath_ARM)

    Value Description

    "ascending"

    "descending"

    CompositePath_Order_STATUS (string alias)

    (Appears on:CompositePath_STATUS, CompositePath_STATUS_ARM)

    Value Description

    "ascending"

    "descending"

    CompositePath_STATUS

    (Appears on:IndexingPolicy_STATUS)

    Field Description
    order
    CompositePath_Order_STATUS

    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_STATUS_ARM

    (Appears on:IndexingPolicy_STATUS_ARM)

    Field Description
    order
    CompositePath_Order_STATUS

    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)

    The conflict resolution policy for the container.

    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
    ConflictResolutionPolicy_Mode

    Mode: Indicates the conflict resolution mode.

    ConflictResolutionPolicy_ARM

    (Appears on:SqlContainerResource_ARM)

    The conflict resolution policy for the container.

    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
    ConflictResolutionPolicy_Mode

    Mode: Indicates the conflict resolution mode.

    ConflictResolutionPolicy_Mode (string alias)

    (Appears on:ConflictResolutionPolicy, ConflictResolutionPolicy_ARM)

    Value Description

    "Custom"

    "LastWriterWins"

    ConflictResolutionPolicy_Mode_STATUS (string alias)

    (Appears on:ConflictResolutionPolicy_STATUS, ConflictResolutionPolicy_STATUS_ARM)

    Value Description

    "Custom"

    "LastWriterWins"

    ConflictResolutionPolicy_STATUS

    (Appears on:SqlContainerGetProperties_Resource_STATUS)

    The conflict resolution policy for the container.

    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
    ConflictResolutionPolicy_Mode_STATUS

    Mode: Indicates the conflict resolution mode.

    ConflictResolutionPolicy_STATUS_ARM

    (Appears on:SqlContainerGetProperties_Resource_STATUS_ARM)

    The conflict resolution policy for the container.

    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
    ConflictResolutionPolicy_Mode_STATUS

    Mode: Indicates the conflict resolution mode.

    ConnectorOffer (string alias)

    (Appears on:DatabaseAccountCreateUpdateProperties_ARM, DatabaseAccount_Spec)

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

    Value Description

    "Small"

    ConnectorOffer_STATUS (string alias)

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM, DatabaseAccount_STATUS)

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

    Value Description

    "Small"

    ConsistencyPolicy

    (Appears on:DatabaseAccount_Spec)

    The consistency policy for the Cosmos DB database account.

    Field Description
    defaultConsistencyLevel
    ConsistencyPolicy_DefaultConsistencyLevel

    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_ARM

    (Appears on:DatabaseAccountCreateUpdateProperties_ARM)

    The consistency policy for the Cosmos DB database account.

    Field Description
    defaultConsistencyLevel
    ConsistencyPolicy_DefaultConsistencyLevel

    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_DefaultConsistencyLevel (string alias)

    (Appears on:ConsistencyPolicy, ConsistencyPolicy_ARM)

    Value Description

    "BoundedStaleness"

    "ConsistentPrefix"

    "Eventual"

    "Session"

    "Strong"

    ConsistencyPolicy_DefaultConsistencyLevel_STATUS (string alias)

    (Appears on:ConsistencyPolicy_STATUS, ConsistencyPolicy_STATUS_ARM)

    Value Description

    "BoundedStaleness"

    "ConsistentPrefix"

    "Eventual"

    "Session"

    "Strong"

    ConsistencyPolicy_STATUS

    (Appears on:DatabaseAccount_STATUS)

    The consistency policy for the Cosmos DB database account.

    Field Description
    defaultConsistencyLevel
    ConsistencyPolicy_DefaultConsistencyLevel_STATUS

    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_STATUS_ARM

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM)

    The consistency policy for the Cosmos DB database account.

    Field Description
    defaultConsistencyLevel
    ConsistencyPolicy_DefaultConsistencyLevel_STATUS

    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)

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

    Field Description
    kind
    ContainerPartitionKey_Kind

    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

    ContainerPartitionKey_ARM

    (Appears on:SqlContainerResource_ARM)

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

    Field Description
    kind
    ContainerPartitionKey_Kind

    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

    ContainerPartitionKey_Kind (string alias)

    (Appears on:ContainerPartitionKey, ContainerPartitionKey_ARM)

    Value Description

    "Hash"

    "MultiHash"

    "Range"

    ContainerPartitionKey_Kind_STATUS (string alias)

    (Appears on:ContainerPartitionKey_STATUS, ContainerPartitionKey_STATUS_ARM)

    Value Description

    "Hash"

    "MultiHash"

    "Range"

    ContainerPartitionKey_STATUS

    (Appears on:SqlContainerGetProperties_Resource_STATUS)

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

    Field Description
    kind
    ContainerPartitionKey_Kind_STATUS

    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_STATUS_ARM

    (Appears on:SqlContainerGetProperties_Resource_STATUS_ARM)

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

    Field Description
    kind
    ContainerPartitionKey_Kind_STATUS

    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)

    Field Description
    type
    ContinuousModeBackupPolicy_Type

    ContinuousModeBackupPolicy_ARM

    (Appears on:BackupPolicy_ARM)

    Field Description
    type
    ContinuousModeBackupPolicy_Type

    ContinuousModeBackupPolicy_STATUS

    (Appears on:BackupPolicy_STATUS)

    Field Description
    type
    ContinuousModeBackupPolicy_Type_STATUS

    ContinuousModeBackupPolicy_STATUS_ARM

    (Appears on:BackupPolicy_STATUS_ARM)

    Field Description
    type
    ContinuousModeBackupPolicy_Type_STATUS

    ContinuousModeBackupPolicy_Type (string alias)

    (Appears on:ContinuousModeBackupPolicy, ContinuousModeBackupPolicy_ARM)

    Value Description

    "Continuous"

    ContinuousModeBackupPolicy_Type_STATUS (string alias)

    (Appears on:ContinuousModeBackupPolicy_STATUS, ContinuousModeBackupPolicy_STATUS_ARM)

    Value Description

    "Continuous"

    CorsPolicy

    (Appears on:DatabaseAccount_Spec)

    The CORS policy for the Cosmos DB database account.

    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_ARM

    (Appears on:DatabaseAccountCreateUpdateProperties_ARM)

    The CORS policy for the Cosmos DB database account.

    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:DatabaseAccount_STATUS)

    The CORS policy for the Cosmos DB database account.

    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_ARM

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM)

    The CORS policy for the Cosmos DB database account.

    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:DatabaseAccounts_MongodbDatabase_Spec, DatabaseAccounts_MongodbDatabases_Collection_Spec, DatabaseAccounts_SqlDatabase_Spec, DatabaseAccounts_SqlDatabases_Container_Spec, DatabaseAccounts_SqlDatabases_Containers_StoredProcedure_Spec, DatabaseAccounts_SqlDatabases_Containers_Trigger_Spec, DatabaseAccounts_SqlDatabases_Containers_UserDefinedFunction_Spec)

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

    Field Description
    autoscaleSettings
    AutoscaleSettings

    AutoscaleSettings: Specifies the Autoscale settings.

    throughput
    int

    Throughput: Request Units per second. For example, “throughput”: 10000.

    CreateUpdateOptions_ARM

    (Appears on:MongoDBCollectionCreateUpdateProperties_ARM, MongoDBDatabaseCreateUpdateProperties_ARM, SqlContainerCreateUpdateProperties_ARM, SqlDatabaseCreateUpdateProperties_ARM, SqlStoredProcedureCreateUpdateProperties_ARM, SqlTriggerCreateUpdateProperties_ARM, SqlUserDefinedFunctionCreateUpdateProperties_ARM)

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

    Field Description
    autoscaleSettings
    AutoscaleSettings_ARM

    AutoscaleSettings: Specifies the Autoscale settings.

    throughput
    int

    Throughput: Request Units per second. For example, “throughput”: 10000.

    DatabaseAccount

    Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​databaseAccounts/​{accountName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DatabaseAccount_Spec


    analyticalStorageConfiguration
    AnalyticalStorageConfiguration

    AnalyticalStorageConfiguration: Analytical storage specific properties.

    apiProperties
    ApiProperties

    ApiProperties: API specific properties. Currently, supported only for MongoDB API.

    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
    ConnectorOffer

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

    consistencyPolicy
    ConsistencyPolicy

    ConsistencyPolicy: The consistency policy for the Cosmos DB account.

    cors
    []CorsPolicy

    Cors: The CORS policy for the Cosmos DB database account.

    databaseAccountOfferType
    DatabaseAccountOfferType

    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: 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
    DatabaseAccount_Kind_Spec

    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
    NetworkAclBypass

    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
    PublicNetworkAccess

    PublicNetworkAccess: Whether requests from Public Network are allowed

    tags
    map[string]string
    virtualNetworkRules
    []VirtualNetworkRule

    VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account.

    status
    DatabaseAccount_STATUS

    DatabaseAccountCreateUpdateProperties_ARM

    (Appears on:DatabaseAccount_Spec_ARM)

    Properties to create and update Azure Cosmos DB database accounts.

    Field Description
    analyticalStorageConfiguration
    AnalyticalStorageConfiguration_ARM

    AnalyticalStorageConfiguration: Analytical storage specific properties.

    apiProperties
    ApiProperties_ARM

    ApiProperties: API specific properties. Currently, supported only for MongoDB API.

    backupPolicy
    BackupPolicy_ARM

    BackupPolicy: The object representing the policy for taking backups on an account.

    capabilities
    []Capability_ARM

    Capabilities: List of Cosmos DB capabilities for the account

    connectorOffer
    ConnectorOffer

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

    consistencyPolicy
    ConsistencyPolicy_ARM

    ConsistencyPolicy: The consistency policy for the Cosmos DB account.

    cors
    []CorsPolicy_ARM

    Cors: The CORS policy for the Cosmos DB database account.

    databaseAccountOfferType
    DatabaseAccountOfferType

    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
    []IpAddressOrRange_ARM

    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_ARM

    Locations: An array that contains the georeplication locations enabled for the Cosmos DB account.

    networkAclBypass
    NetworkAclBypass

    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
    PublicNetworkAccess

    PublicNetworkAccess: Whether requests from Public Network are allowed

    virtualNetworkRules
    []VirtualNetworkRule_ARM

    VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account.

    DatabaseAccountGetProperties_STATUS_ARM

    (Appears on:DatabaseAccount_STATUS_ARM)

    Properties for the database account.

    Field Description
    analyticalStorageConfiguration
    AnalyticalStorageConfiguration_STATUS_ARM

    AnalyticalStorageConfiguration: Analytical storage specific properties.

    apiProperties
    ApiProperties_STATUS_ARM

    ApiProperties: API specific properties.

    backupPolicy
    BackupPolicy_STATUS_ARM

    BackupPolicy: The object representing the policy for taking backups on an account.

    capabilities
    []Capability_STATUS_ARM

    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_STATUS_ARM

    ConsistencyPolicy: The consistency policy for the Cosmos DB database account.

    cors
    []CorsPolicy_STATUS_ARM

    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_ARM

    FailoverPolicies: An array that contains the regions ordered by their failover priorities.

    ipRules
    []IpAddressOrRange_STATUS_ARM

    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_STATUS_ARM

    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_ARM

    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_ARM

    ReadLocations: An array that contains of the read locations enabled for the Cosmos DB account.

    virtualNetworkRules
    []VirtualNetworkRule_STATUS_ARM

    VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account.

    writeLocations
    []Location_STATUS_ARM

    WriteLocations: An array that contains the write location for the Cosmos DB account.

    DatabaseAccountOfferType (string alias)

    (Appears on:DatabaseAccountCreateUpdateProperties_ARM, DatabaseAccount_Spec)

    The offer type for the Cosmos DB database account.

    Value Description

    "Standard"

    DatabaseAccountOfferType_STATUS (string alias)

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM, DatabaseAccount_STATUS)

    The offer type for the Cosmos DB database account.

    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:DatabaseAccount_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.

    DatabaseAccount_Kind_STATUS (string alias)

    (Appears on:DatabaseAccount_STATUS, DatabaseAccount_STATUS_ARM)

    Value Description

    "GlobalDocumentDB"

    "MongoDB"

    "Parse"

    DatabaseAccount_Kind_Spec (string alias)

    (Appears on:DatabaseAccount_Spec, DatabaseAccount_Spec_ARM)

    Value Description

    "GlobalDocumentDB"

    "MongoDB"

    "Parse"

    DatabaseAccount_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

    Identity: Identity for the resource.

    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
    DatabaseAccount_Kind_STATUS

    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

    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.

    DatabaseAccount_STATUS_ARM

    Field Description
    id
    string

    Id: The unique resource identifier of the ARM resource.

    identity
    ManagedServiceIdentity_STATUS_ARM

    Identity: Identity for the resource.

    kind
    DatabaseAccount_Kind_STATUS

    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_STATUS_ARM

    Properties: Properties for the database account.

    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccount_Spec

    (Appears on:DatabaseAccount)

    Field Description
    analyticalStorageConfiguration
    AnalyticalStorageConfiguration

    AnalyticalStorageConfiguration: Analytical storage specific properties.

    apiProperties
    ApiProperties

    ApiProperties: API specific properties. Currently, supported only for MongoDB API.

    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
    ConnectorOffer

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

    consistencyPolicy
    ConsistencyPolicy

    ConsistencyPolicy: The consistency policy for the Cosmos DB account.

    cors
    []CorsPolicy

    Cors: The CORS policy for the Cosmos DB database account.

    databaseAccountOfferType
    DatabaseAccountOfferType

    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: 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
    DatabaseAccount_Kind_Spec

    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
    NetworkAclBypass

    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
    PublicNetworkAccess

    PublicNetworkAccess: Whether requests from Public Network are allowed

    tags
    map[string]string
    virtualNetworkRules
    []VirtualNetworkRule

    VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account.

    DatabaseAccount_Spec_ARM

    Field Description
    identity
    ManagedServiceIdentity_ARM

    Identity: Identity for the resource.

    kind
    DatabaseAccount_Kind_Spec

    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
    properties
    DatabaseAccountCreateUpdateProperties_ARM

    Properties: Properties to create and update Azure Cosmos DB database accounts.

    tags
    map[string]string

    DatabaseAccounts_MongodbDatabase_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

    Options: Cosmos DB options resource object

    resource
    MongoDBDatabaseGetProperties_Resource_STATUS
    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_MongodbDatabase_STATUS_ARM

    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_STATUS_ARM

    Properties: The properties of an Azure Cosmos DB MongoDB database

    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_MongodbDatabase_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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a MongoDB database

    tags
    map[string]string

    DatabaseAccounts_MongodbDatabase_Spec_ARM

    Field Description
    location
    string

    Location: The location of the resource group to which the resource belongs.

    name
    string
    properties
    MongoDBDatabaseCreateUpdateProperties_ARM

    Properties: Properties to create and update Azure Cosmos DB MongoDB database.

    tags
    map[string]string

    DatabaseAccounts_MongodbDatabases_Collection_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

    Options: Cosmos DB options resource object

    resource
    MongoDBCollectionGetProperties_Resource_STATUS
    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_MongodbDatabases_Collection_STATUS_ARM

    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_STATUS_ARM

    Properties: The properties of an Azure Cosmos DB MongoDB collection

    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_MongodbDatabases_Collection_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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a MongoDB collection

    tags
    map[string]string

    DatabaseAccounts_MongodbDatabases_Collection_Spec_ARM

    Field Description
    location
    string

    Location: The location of the resource group to which the resource belongs.

    name
    string
    properties
    MongoDBCollectionCreateUpdateProperties_ARM

    Properties: Properties to create and update Azure Cosmos DB MongoDB collection.

    tags
    map[string]string

    DatabaseAccounts_MongodbDatabases_Collections_ThroughputSetting_STATUS

    (Appears on:MongodbDatabaseCollectionThroughputSetting)

    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_Resource_STATUS
    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_MongodbDatabases_Collections_ThroughputSetting_STATUS_ARM

    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_STATUS_ARM

    Properties: The properties of an Azure Cosmos DB resource throughput

    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_MongodbDatabases_Collections_ThroughputSetting_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: The standard JSON format of a resource throughput

    tags
    map[string]string

    DatabaseAccounts_MongodbDatabases_Collections_ThroughputSetting_Spec_ARM

    Field Description
    location
    string

    Location: The location of the resource group to which the resource belongs.

    name
    string
    properties
    ThroughputSettingsUpdateProperties_ARM

    Properties: Properties to update Azure Cosmos DB resource throughput.

    tags
    map[string]string

    DatabaseAccounts_MongodbDatabases_ThroughputSetting_STATUS

    (Appears on:MongodbDatabaseThroughputSetting)

    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_Resource_STATUS
    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_MongodbDatabases_ThroughputSetting_STATUS_ARM

    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_STATUS_ARM

    Properties: The properties of an Azure Cosmos DB resource throughput

    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_MongodbDatabases_ThroughputSetting_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: The standard JSON format of a resource throughput

    tags
    map[string]string

    DatabaseAccounts_MongodbDatabases_ThroughputSetting_Spec_ARM

    Field Description
    location
    string

    Location: The location of the resource group to which the resource belongs.

    name
    string
    properties
    ThroughputSettingsUpdateProperties_ARM

    Properties: Properties to update Azure Cosmos DB resource throughput.

    tags
    map[string]string

    DatabaseAccounts_SqlDatabase_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

    Options: Cosmos DB options resource object

    resource
    SqlDatabaseGetProperties_Resource_STATUS
    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabase_STATUS_ARM

    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_STATUS_ARM

    Properties: The properties of an Azure Cosmos DB SQL database

    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabase_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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a SQL database

    tags
    map[string]string

    DatabaseAccounts_SqlDatabase_Spec_ARM

    Field Description
    location
    string

    Location: The location of the resource group to which the resource belongs.

    name
    string
    properties
    SqlDatabaseCreateUpdateProperties_ARM

    Properties: Properties to create and update Azure Cosmos DB SQL database.

    tags
    map[string]string

    DatabaseAccounts_SqlDatabases_Container_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

    Options: Cosmos DB options resource object

    resource
    SqlContainerGetProperties_Resource_STATUS
    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabases_Container_STATUS_ARM

    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_STATUS_ARM

    Properties: The properties of an Azure Cosmos DB container

    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabases_Container_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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a container

    tags
    map[string]string

    DatabaseAccounts_SqlDatabases_Container_Spec_ARM

    Field Description
    location
    string

    Location: The location of the resource group to which the resource belongs.

    name
    string
    properties
    SqlContainerCreateUpdateProperties_ARM

    Properties: Properties to create and update Azure Cosmos DB container.

    tags
    map[string]string

    DatabaseAccounts_SqlDatabases_Containers_StoredProcedure_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_Resource_STATUS
    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabases_Containers_StoredProcedure_STATUS_ARM

    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_STATUS_ARM

    Properties: The properties of an Azure Cosmos DB storedProcedure

    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabases_Containers_StoredProcedure_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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a storedProcedure

    tags
    map[string]string

    DatabaseAccounts_SqlDatabases_Containers_StoredProcedure_Spec_ARM

    Field Description
    location
    string

    Location: The location of the resource group to which the resource belongs.

    name
    string
    properties
    SqlStoredProcedureCreateUpdateProperties_ARM

    Properties: Properties to create and update Azure Cosmos DB storedProcedure.

    tags
    map[string]string

    DatabaseAccounts_SqlDatabases_Containers_ThroughputSetting_STATUS

    (Appears on:SqlDatabaseContainerThroughputSetting)

    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_Resource_STATUS
    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabases_Containers_ThroughputSetting_STATUS_ARM

    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_STATUS_ARM

    Properties: The properties of an Azure Cosmos DB resource throughput

    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabases_Containers_ThroughputSetting_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: The standard JSON format of a resource throughput

    tags
    map[string]string

    DatabaseAccounts_SqlDatabases_Containers_ThroughputSetting_Spec_ARM

    Field Description
    location
    string

    Location: The location of the resource group to which the resource belongs.

    name
    string
    properties
    ThroughputSettingsUpdateProperties_ARM

    Properties: Properties to update Azure Cosmos DB resource throughput.

    tags
    map[string]string

    DatabaseAccounts_SqlDatabases_Containers_Trigger_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_Resource_STATUS
    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabases_Containers_Trigger_STATUS_ARM

    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_STATUS_ARM

    Properties: The properties of an Azure Cosmos DB trigger

    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabases_Containers_Trigger_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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a trigger

    tags
    map[string]string

    DatabaseAccounts_SqlDatabases_Containers_Trigger_Spec_ARM

    Field Description
    location
    string

    Location: The location of the resource group to which the resource belongs.

    name
    string
    properties
    SqlTriggerCreateUpdateProperties_ARM

    Properties: Properties to create and update Azure Cosmos DB trigger.

    tags
    map[string]string

    DatabaseAccounts_SqlDatabases_Containers_UserDefinedFunction_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_Resource_STATUS
    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabases_Containers_UserDefinedFunction_STATUS_ARM

    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_STATUS_ARM

    Properties: The properties of an Azure Cosmos DB userDefinedFunction

    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabases_Containers_UserDefinedFunction_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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a userDefinedFunction

    tags
    map[string]string

    DatabaseAccounts_SqlDatabases_Containers_UserDefinedFunction_Spec_ARM

    Field Description
    location
    string

    Location: The location of the resource group to which the resource belongs.

    name
    string
    properties
    SqlUserDefinedFunctionCreateUpdateProperties_ARM

    Properties: Properties to create and update Azure Cosmos DB userDefinedFunction.

    tags
    map[string]string

    DatabaseAccounts_SqlDatabases_ThroughputSetting_STATUS

    (Appears on: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_Resource_STATUS
    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabases_ThroughputSetting_STATUS_ARM

    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_STATUS_ARM

    Properties: The properties of an Azure Cosmos DB resource throughput

    tags
    map[string]string
    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlDatabases_ThroughputSetting_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: The standard JSON format of a resource throughput

    tags
    map[string]string

    DatabaseAccounts_SqlDatabases_ThroughputSetting_Spec_ARM

    Field Description
    location
    string

    Location: The location of the resource group to which the resource belongs.

    name
    string
    properties
    ThroughputSettingsUpdateProperties_ARM

    Properties: Properties to update Azure Cosmos DB resource throughput.

    tags
    map[string]string

    DatabaseAccounts_SqlRoleAssignment_STATUS

    (Appears on:SqlRoleAssignment)

    Field Description
    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: The unique resource identifier of the database account.

    name
    string

    Name: The name of the database account.

    principalId
    string

    PrincipalId: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.

    roleDefinitionId
    string

    RoleDefinitionId: The unique identifier for the associated Role Definition.

    scope
    string

    Scope: The data plane resource path for which access is being granted through this Role Assignment.

    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlRoleAssignment_STATUS_ARM

    Field Description
    id
    string

    Id: The unique resource identifier of the database account.

    name
    string

    Name: The name of the database account.

    properties
    SqlRoleAssignmentResource_STATUS_ARM

    Properties: Properties related to the Role Assignment.

    type
    string

    Type: The type of Azure resource.

    DatabaseAccounts_SqlRoleAssignment_Spec

    (Appears on:SqlRoleAssignment)

    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.

    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

    principalId
    string

    PrincipalId: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.

    principalIdFromConfig
    genruntime.ConfigMapReference

    PrincipalIdFromConfig: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.

    roleDefinitionId
    string

    RoleDefinitionId: The unique identifier for the associated Role Definition.

    scope
    string

    Scope: The data plane resource path for which access is being granted through this Role Assignment.

    DatabaseAccounts_SqlRoleAssignment_Spec_ARM

    Field Description
    name
    string
    properties
    SqlRoleAssignmentResource_ARM

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

    ExcludedPath

    (Appears on:IndexingPolicy)

    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_ARM

    (Appears on:IndexingPolicy_ARM)

    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_STATUS_ARM

    (Appears on:IndexingPolicy_STATUS_ARM)

    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:DatabaseAccount_STATUS)

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

    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_STATUS_ARM

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM)

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

    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)

    The paths that are included in indexing

    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/*)

    IncludedPath_ARM

    (Appears on:IndexingPolicy_ARM)

    The paths that are included in indexing

    Field Description
    indexes
    []Indexes_ARM

    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)

    The paths that are included in indexing

    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_STATUS_ARM

    (Appears on:IndexingPolicy_STATUS_ARM)

    The paths that are included in indexing

    Field Description
    indexes
    []Indexes_STATUS_ARM

    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)

    The indexes for the path.

    Field Description
    dataType
    Indexes_DataType

    DataType: The datatype for which the indexing behavior is applied to.

    kind
    Indexes_Kind

    Kind: Indicates the type of index.

    precision
    int

    Precision: The precision of the index. -1 is maximum precision.

    Indexes_ARM

    (Appears on:IncludedPath_ARM)

    The indexes for the path.

    Field Description
    dataType
    Indexes_DataType

    DataType: The datatype for which the indexing behavior is applied to.

    kind
    Indexes_Kind

    Kind: Indicates the type of index.

    precision
    int

    Precision: The precision of the index. -1 is maximum precision.

    Indexes_DataType (string alias)

    (Appears on:Indexes, Indexes_ARM)

    Value Description

    "LineString"

    "MultiPolygon"

    "Number"

    "Point"

    "Polygon"

    "String"

    Indexes_DataType_STATUS (string alias)

    (Appears on:Indexes_STATUS, Indexes_STATUS_ARM)

    Value Description

    "LineString"

    "MultiPolygon"

    "Number"

    "Point"

    "Polygon"

    "String"

    Indexes_Kind (string alias)

    (Appears on:Indexes, Indexes_ARM)

    Value Description

    "Hash"

    "Range"

    "Spatial"

    Indexes_Kind_STATUS (string alias)

    (Appears on:Indexes_STATUS, Indexes_STATUS_ARM)

    Value Description

    "Hash"

    "Range"

    "Spatial"

    Indexes_STATUS

    (Appears on:IncludedPath_STATUS)

    The indexes for the path.

    Field Description
    dataType
    Indexes_DataType_STATUS

    DataType: The datatype for which the indexing behavior is applied to.

    kind
    Indexes_Kind_STATUS

    Kind: Indicates the type of index.

    precision
    int

    Precision: The precision of the index. -1 is maximum precision.

    Indexes_STATUS_ARM

    (Appears on:IncludedPath_STATUS_ARM)

    The indexes for the path.

    Field Description
    dataType
    Indexes_DataType_STATUS

    DataType: The datatype for which the indexing behavior is applied to.

    kind
    Indexes_Kind_STATUS

    Kind: Indicates the type of index.

    precision
    int

    Precision: The precision of the index. -1 is maximum precision.

    IndexingPolicy

    (Appears on:SqlContainerResource)

    Cosmos DB indexing policy

    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
    IndexingPolicy_IndexingMode

    IndexingMode: Indicates the indexing mode.

    spatialIndexes
    []SpatialSpec

    SpatialIndexes: List of spatial specifics

    IndexingPolicy_ARM

    (Appears on:SqlContainerResource_ARM)

    Cosmos DB indexing policy

    Field Description
    automatic
    bool

    Automatic: Indicates if the indexing policy is automatic

    compositeIndexes
    []CompositePath_ARM

    CompositeIndexes: List of composite path list

    excludedPaths
    []ExcludedPath_ARM

    ExcludedPaths: List of paths to exclude from indexing

    includedPaths
    []IncludedPath_ARM

    IncludedPaths: List of paths to include in the indexing

    indexingMode
    IndexingPolicy_IndexingMode

    IndexingMode: Indicates the indexing mode.

    spatialIndexes
    []SpatialSpec_ARM

    SpatialIndexes: List of spatial specifics

    IndexingPolicy_IndexingMode (string alias)

    (Appears on:IndexingPolicy, IndexingPolicy_ARM)

    Value Description

    "consistent"

    "lazy"

    "none"

    IndexingPolicy_IndexingMode_STATUS (string alias)

    (Appears on:IndexingPolicy_STATUS, IndexingPolicy_STATUS_ARM)

    Value Description

    "consistent"

    "lazy"

    "none"

    IndexingPolicy_STATUS

    (Appears on:SqlContainerGetProperties_Resource_STATUS)

    Cosmos DB indexing policy

    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
    IndexingPolicy_IndexingMode_STATUS

    IndexingMode: Indicates the indexing mode.

    spatialIndexes
    []SpatialSpec_STATUS

    SpatialIndexes: List of spatial specifics

    IndexingPolicy_STATUS_ARM

    (Appears on:SqlContainerGetProperties_Resource_STATUS_ARM)

    Cosmos DB indexing policy

    Field Description
    automatic
    bool

    Automatic: Indicates if the indexing policy is automatic

    compositeIndexes
    []CompositePath_STATUS_ARM

    CompositeIndexes: List of composite path list

    excludedPaths
    []ExcludedPath_STATUS_ARM

    ExcludedPaths: List of paths to exclude from indexing

    includedPaths
    []IncludedPath_STATUS_ARM

    IncludedPaths: List of paths to include in the indexing

    indexingMode
    IndexingPolicy_IndexingMode_STATUS

    IndexingMode: Indicates the indexing mode.

    spatialIndexes
    []SpatialSpec_STATUS_ARM

    SpatialIndexes: List of spatial specifics

    IpAddressOrRange

    (Appears on:DatabaseAccount_Spec)

    IpAddressOrRange object

    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_ARM

    (Appears on:DatabaseAccountCreateUpdateProperties_ARM)

    IpAddressOrRange object

    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:DatabaseAccount_STATUS)

    IpAddressOrRange object

    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_ARM

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM)

    IpAddressOrRange object

    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:DatabaseAccount_Spec)

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

    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_ARM

    (Appears on:DatabaseAccountCreateUpdateProperties_ARM)

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

    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:DatabaseAccount_STATUS)

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

    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_STATUS_ARM

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM)

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

    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:DatabaseAccount_Spec)

    Identity for the resource.

    Field Description
    type
    ManagedServiceIdentity_Type

    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
    []UserAssignedIdentityDetails

    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}’.

    ManagedServiceIdentity_ARM

    (Appears on:DatabaseAccount_Spec_ARM)

    Identity for the resource.

    Field Description
    type
    ManagedServiceIdentity_Type

    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/v1api20210515.UserAssignedIdentityDetails_ARM

    ManagedServiceIdentity_STATUS

    (Appears on:DatabaseAccount_STATUS)

    Identity for the resource.

    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
    ManagedServiceIdentity_Type_STATUS

    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/v1api20210515.ManagedServiceIdentity_UserAssignedIdentities_STATUS

    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}’.

    ManagedServiceIdentity_STATUS_ARM

    (Appears on:DatabaseAccount_STATUS_ARM)

    Identity for the resource.

    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
    ManagedServiceIdentity_Type_STATUS

    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/v1api20210515.ManagedServiceIdentity_UserAssignedIdentities_STATUS_ARM

    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}’.

    ManagedServiceIdentity_Type (string alias)

    (Appears on:ManagedServiceIdentity, ManagedServiceIdentity_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned,UserAssigned"

    "UserAssigned"

    ManagedServiceIdentity_Type_STATUS (string alias)

    (Appears on:ManagedServiceIdentity_STATUS, ManagedServiceIdentity_STATUS_ARM)

    Value Description

    "None"

    "SystemAssigned"

    "SystemAssigned,UserAssigned"

    "UserAssigned"

    ManagedServiceIdentity_UserAssignedIdentities_STATUS

    (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_UserAssignedIdentities_STATUS_ARM

    (Appears on:ManagedServiceIdentity_STATUS_ARM)

    Field Description
    clientId
    string

    ClientId: The client id of user assigned identity.

    principalId
    string

    PrincipalId: The principal id of user assigned identity.

    MongoDBCollectionCreateUpdateProperties_ARM

    (Appears on:DatabaseAccounts_MongodbDatabases_Collection_Spec_ARM)

    Properties to create and update Azure Cosmos DB MongoDB collection.

    Field Description
    options
    CreateUpdateOptions_ARM

    Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    resource
    MongoDBCollectionResource_ARM

    Resource: The standard JSON format of a MongoDB collection

    MongoDBCollectionGetProperties_Resource_STATUS

    (Appears on:DatabaseAccounts_MongodbDatabases_Collection_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_Resource_STATUS_ARM

    (Appears on:MongoDBCollectionGetProperties_STATUS_ARM)

    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_ARM

    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_ARM

    (Appears on:DatabaseAccounts_MongodbDatabases_Collection_STATUS_ARM)

    The properties of an Azure Cosmos DB MongoDB collection

    Field Description
    options
    OptionsResource_STATUS_ARM

    Options: Cosmos DB options resource object

    resource
    MongoDBCollectionGetProperties_Resource_STATUS_ARM

    MongoDBCollectionResource

    (Appears on:DatabaseAccounts_MongodbDatabases_Collection_Spec)

    Cosmos DB MongoDB collection resource object

    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: A key-value pair of shard keys to be applied for the request.

    MongoDBCollectionResource_ARM

    (Appears on:MongoDBCollectionCreateUpdateProperties_ARM)

    Cosmos DB MongoDB collection resource object

    Field Description
    analyticalStorageTtl
    int

    AnalyticalStorageTtl: Analytical TTL.

    id
    string

    Id: Name of the Cosmos DB MongoDB collection

    indexes
    []MongoIndex_ARM

    Indexes: List of index keys

    shardKey
    map[string]string

    ShardKey: A key-value pair of shard keys to be applied for the request.

    MongoDBDatabaseCreateUpdateProperties_ARM

    (Appears on:DatabaseAccounts_MongodbDatabase_Spec_ARM)

    Properties to create and update Azure Cosmos DB MongoDB database.

    Field Description
    options
    CreateUpdateOptions_ARM

    Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    resource
    MongoDBDatabaseResource_ARM

    Resource: The standard JSON format of a MongoDB database

    MongoDBDatabaseGetProperties_Resource_STATUS

    (Appears on:DatabaseAccounts_MongodbDatabase_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_Resource_STATUS_ARM

    (Appears on:MongoDBDatabaseGetProperties_STATUS_ARM)

    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_ARM

    (Appears on:DatabaseAccounts_MongodbDatabase_STATUS_ARM)

    The properties of an Azure Cosmos DB MongoDB database

    Field Description
    options
    OptionsResource_STATUS_ARM

    Options: Cosmos DB options resource object

    resource
    MongoDBDatabaseGetProperties_Resource_STATUS_ARM

    MongoDBDatabaseResource

    (Appears on:DatabaseAccounts_MongodbDatabase_Spec)

    Cosmos DB MongoDB database resource object

    Field Description
    id
    string

    Id: Name of the Cosmos DB MongoDB database

    MongoDBDatabaseResource_ARM

    (Appears on:MongoDBDatabaseCreateUpdateProperties_ARM)

    Cosmos DB MongoDB database resource object

    Field Description
    id
    string

    Id: Name of the Cosmos DB MongoDB database

    MongoIndex

    (Appears on:MongoDBCollectionResource)

    Cosmos DB MongoDB collection index key

    Field Description
    key
    MongoIndexKeys

    Key: Cosmos DB MongoDB collection index keys

    options
    MongoIndexOptions

    Options: Cosmos DB MongoDB collection index key options

    MongoIndexKeys

    (Appears on:MongoIndex)

    Cosmos DB MongoDB collection resource object

    Field Description
    keys
    []string

    Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service

    MongoIndexKeys_ARM

    (Appears on:MongoIndex_ARM)

    Cosmos DB MongoDB collection resource object

    Field Description
    keys
    []string

    Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service

    MongoIndexKeys_STATUS

    (Appears on:MongoIndex_STATUS)

    Cosmos DB MongoDB collection resource object

    Field Description
    keys
    []string

    Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service

    MongoIndexKeys_STATUS_ARM

    (Appears on:MongoIndex_STATUS_ARM)

    Cosmos DB MongoDB collection resource object

    Field Description
    keys
    []string

    Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service

    MongoIndexOptions

    (Appears on:MongoIndex)

    Cosmos DB MongoDB collection index options

    Field Description
    expireAfterSeconds
    int

    ExpireAfterSeconds: Expire after seconds

    unique
    bool

    Unique: Is unique or not

    MongoIndexOptions_ARM

    (Appears on:MongoIndex_ARM)

    Cosmos DB MongoDB collection index options

    Field Description
    expireAfterSeconds
    int

    ExpireAfterSeconds: Expire after seconds

    unique
    bool

    Unique: Is unique or not

    MongoIndexOptions_STATUS

    (Appears on:MongoIndex_STATUS)

    Cosmos DB MongoDB collection index options

    Field Description
    expireAfterSeconds
    int

    ExpireAfterSeconds: Expire after seconds

    unique
    bool

    Unique: Is unique or not

    MongoIndexOptions_STATUS_ARM

    (Appears on:MongoIndex_STATUS_ARM)

    Cosmos DB MongoDB collection index options

    Field Description
    expireAfterSeconds
    int

    ExpireAfterSeconds: Expire after seconds

    unique
    bool

    Unique: Is unique or not

    MongoIndex_ARM

    (Appears on:MongoDBCollectionResource_ARM)

    Cosmos DB MongoDB collection index key

    Field Description
    key
    MongoIndexKeys_ARM

    Key: Cosmos DB MongoDB collection index keys

    options
    MongoIndexOptions_ARM

    Options: Cosmos DB MongoDB collection index key options

    MongoIndex_STATUS

    (Appears on:MongoDBCollectionGetProperties_Resource_STATUS)

    Cosmos DB MongoDB collection index key

    Field Description
    key
    MongoIndexKeys_STATUS

    Key: Cosmos DB MongoDB collection index keys

    options
    MongoIndexOptions_STATUS

    Options: Cosmos DB MongoDB collection index key options

    MongoIndex_STATUS_ARM

    (Appears on:MongoDBCollectionGetProperties_Resource_STATUS_ARM)

    Cosmos DB MongoDB collection index key

    Field Description
    key
    MongoIndexKeys_STATUS_ARM

    Key: Cosmos DB MongoDB collection index keys

    options
    MongoIndexOptions_STATUS_ARM

    Options: Cosmos DB MongoDB collection index key options

    MongodbDatabase

    Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​databaseAccounts/​{accountName}/​mongodbDatabases/​{databaseName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DatabaseAccounts_MongodbDatabase_Spec


    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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a MongoDB database

    tags
    map[string]string
    status
    DatabaseAccounts_MongodbDatabase_STATUS

    MongodbDatabaseCollection

    Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​databaseAccounts/​{accountName}/​mongodbDatabases/​{databaseName}/​collections/​{collectionName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DatabaseAccounts_MongodbDatabases_Collection_Spec


    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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a MongoDB collection

    tags
    map[string]string
    status
    DatabaseAccounts_MongodbDatabases_Collection_STATUS

    MongodbDatabaseCollectionThroughputSetting

    Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​databaseAccounts/​{accountName}/​mongodbDatabases/​{databaseName}/​collections/​{collectionName}/​throughputSettings/​default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DatabaseAccounts_MongodbDatabases_Collections_ThroughputSetting_Spec


    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: The standard JSON format of a resource throughput

    tags
    map[string]string
    status
    DatabaseAccounts_MongodbDatabases_Collections_ThroughputSetting_STATUS

    MongodbDatabaseThroughputSetting

    Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​databaseAccounts/​{accountName}/​mongodbDatabases/​{databaseName}/​throughputSettings/​default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DatabaseAccounts_MongodbDatabases_ThroughputSetting_Spec


    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: The standard JSON format of a resource throughput

    tags
    map[string]string
    status
    DatabaseAccounts_MongodbDatabases_ThroughputSetting_STATUS

    NetworkAclBypass (string alias)

    (Appears on:DatabaseAccountCreateUpdateProperties_ARM, DatabaseAccount_Spec)

    Indicates what services are allowed to bypass firewall checks.

    Value Description

    "AzureServices"

    "None"

    NetworkAclBypass_STATUS (string alias)

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM, DatabaseAccount_STATUS)

    Indicates what services are allowed to bypass firewall checks.

    Value Description

    "AzureServices"

    "None"

    OptionsResource_STATUS

    (Appears on:DatabaseAccounts_MongodbDatabase_STATUS, DatabaseAccounts_MongodbDatabases_Collection_STATUS, DatabaseAccounts_SqlDatabase_STATUS, DatabaseAccounts_SqlDatabases_Container_STATUS)

    Cosmos DB options resource object

    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_STATUS_ARM

    (Appears on:MongoDBCollectionGetProperties_STATUS_ARM, MongoDBDatabaseGetProperties_STATUS_ARM, SqlContainerGetProperties_STATUS_ARM, SqlDatabaseGetProperties_STATUS_ARM)

    Cosmos DB options resource object

    Field Description
    autoscaleSettings
    AutoscaleSettings_STATUS_ARM

    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)

    Field Description
    periodicModeProperties
    PeriodicModeProperties

    PeriodicModeProperties: Configuration values for periodic mode backup

    type
    PeriodicModeBackupPolicy_Type

    PeriodicModeBackupPolicy_ARM

    (Appears on:BackupPolicy_ARM)

    Field Description
    periodicModeProperties
    PeriodicModeProperties_ARM

    PeriodicModeProperties: Configuration values for periodic mode backup

    type
    PeriodicModeBackupPolicy_Type

    PeriodicModeBackupPolicy_STATUS

    (Appears on:BackupPolicy_STATUS)

    Field Description
    periodicModeProperties
    PeriodicModeProperties_STATUS

    PeriodicModeProperties: Configuration values for periodic mode backup

    type
    PeriodicModeBackupPolicy_Type_STATUS

    PeriodicModeBackupPolicy_STATUS_ARM

    (Appears on:BackupPolicy_STATUS_ARM)

    Field Description
    periodicModeProperties
    PeriodicModeProperties_STATUS_ARM

    PeriodicModeProperties: Configuration values for periodic mode backup

    type
    PeriodicModeBackupPolicy_Type_STATUS

    PeriodicModeBackupPolicy_Type (string alias)

    (Appears on:PeriodicModeBackupPolicy, PeriodicModeBackupPolicy_ARM)

    Value Description

    "Periodic"

    PeriodicModeBackupPolicy_Type_STATUS (string alias)

    (Appears on:PeriodicModeBackupPolicy_STATUS, PeriodicModeBackupPolicy_STATUS_ARM)

    Value Description

    "Periodic"

    PeriodicModeProperties

    (Appears on:PeriodicModeBackupPolicy)

    Configuration values for periodic mode backup

    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

    PeriodicModeProperties_ARM

    (Appears on:PeriodicModeBackupPolicy_ARM)

    Configuration values for periodic mode backup

    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

    PeriodicModeProperties_STATUS

    (Appears on:PeriodicModeBackupPolicy_STATUS)

    Configuration values for periodic mode backup

    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

    PeriodicModeProperties_STATUS_ARM

    (Appears on:PeriodicModeBackupPolicy_STATUS_ARM)

    Configuration values for periodic mode backup

    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

    (Appears on:DatabaseAccount_STATUS)

    A private endpoint connection

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    PrivateEndpointConnection_STATUS_ARM

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM)

    A private endpoint connection

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    PublicNetworkAccess (string alias)

    (Appears on:DatabaseAccountCreateUpdateProperties_ARM, DatabaseAccount_Spec)

    Whether requests from Public Network are allowed

    Value Description

    "Disabled"

    "Enabled"

    PublicNetworkAccess_STATUS (string alias)

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM, DatabaseAccount_STATUS)

    Whether requests from Public Network are allowed

    Value Description

    "Disabled"

    "Enabled"

    SpatialSpec

    (Appears on:IndexingPolicy)

    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

    Types: List of path’s spatial type

    SpatialSpec_ARM

    (Appears on:IndexingPolicy_ARM)

    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

    Types: List of path’s spatial type

    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_STATUS_ARM

    (Appears on:IndexingPolicy_STATUS_ARM)

    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 (string alias)

    (Appears on:SpatialSpec, SpatialSpec_ARM)

    Indicates the spatial type of index.

    Value Description

    "LineString"

    "MultiPolygon"

    "Point"

    "Polygon"

    SpatialType_STATUS (string alias)

    (Appears on:SpatialSpec_STATUS, SpatialSpec_STATUS_ARM)

    Indicates the spatial type of index.

    Value Description

    "LineString"

    "MultiPolygon"

    "Point"

    "Polygon"

    SqlContainerCreateUpdateProperties_ARM

    (Appears on:DatabaseAccounts_SqlDatabases_Container_Spec_ARM)

    Properties to create and update Azure Cosmos DB container.

    Field Description
    options
    CreateUpdateOptions_ARM

    Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    resource
    SqlContainerResource_ARM

    Resource: The standard JSON format of a container

    SqlContainerGetProperties_Resource_STATUS

    (Appears on:DatabaseAccounts_SqlDatabases_Container_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_Resource_STATUS_ARM

    (Appears on:SqlContainerGetProperties_STATUS_ARM)

    Field Description
    analyticalStorageTtl
    int

    AnalyticalStorageTtl: Analytical TTL.

    conflictResolutionPolicy
    ConflictResolutionPolicy_STATUS_ARM

    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_ARM

    IndexingPolicy: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container

    partitionKey
    ContainerPartitionKey_STATUS_ARM

    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_ARM

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

    SqlContainerGetProperties_STATUS_ARM

    (Appears on:DatabaseAccounts_SqlDatabases_Container_STATUS_ARM)

    The properties of an Azure Cosmos DB container

    Field Description
    options
    OptionsResource_STATUS_ARM

    Options: Cosmos DB options resource object

    resource
    SqlContainerGetProperties_Resource_STATUS_ARM

    SqlContainerResource

    (Appears on:DatabaseAccounts_SqlDatabases_Container_Spec)

    Cosmos DB SQL container resource object

    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: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container

    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.

    SqlContainerResource_ARM

    (Appears on:SqlContainerCreateUpdateProperties_ARM)

    Cosmos DB SQL container resource object

    Field Description
    analyticalStorageTtl
    int

    AnalyticalStorageTtl: Analytical TTL.

    conflictResolutionPolicy
    ConflictResolutionPolicy_ARM

    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_ARM

    IndexingPolicy: The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container

    partitionKey
    ContainerPartitionKey_ARM

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

    uniqueKeyPolicy
    UniqueKeyPolicy_ARM

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

    SqlDatabase

    Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​databaseAccounts/​{accountName}/​sqlDatabases/​{databaseName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DatabaseAccounts_SqlDatabase_Spec


    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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a SQL database

    tags
    map[string]string
    status
    DatabaseAccounts_SqlDatabase_STATUS

    SqlDatabaseContainer

    Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​databaseAccounts/​{accountName}/​sqlDatabases/​{databaseName}/​containers/​{containerName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DatabaseAccounts_SqlDatabases_Container_Spec


    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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a container

    tags
    map[string]string
    status
    DatabaseAccounts_SqlDatabases_Container_STATUS

    SqlDatabaseContainerStoredProcedure

    Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​databaseAccounts/​{accountName}/​sqlDatabases/​{databaseName}/​containers/​{containerName}/​storedProcedures/​{storedProcedureName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DatabaseAccounts_SqlDatabases_Containers_StoredProcedure_Spec


    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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a storedProcedure

    tags
    map[string]string
    status
    DatabaseAccounts_SqlDatabases_Containers_StoredProcedure_STATUS

    SqlDatabaseContainerThroughputSetting

    Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​databaseAccounts/​{accountName}/​sqlDatabases/​{databaseName}/​containers/​{containerName}/​throughputSettings/​default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DatabaseAccounts_SqlDatabases_Containers_ThroughputSetting_Spec


    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: The standard JSON format of a resource throughput

    tags
    map[string]string
    status
    DatabaseAccounts_SqlDatabases_Containers_ThroughputSetting_STATUS

    SqlDatabaseContainerTrigger

    Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​databaseAccounts/​{accountName}/​sqlDatabases/​{databaseName}/​containers/​{containerName}/​triggers/​{triggerName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DatabaseAccounts_SqlDatabases_Containers_Trigger_Spec


    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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a trigger

    tags
    map[string]string
    status
    DatabaseAccounts_SqlDatabases_Containers_Trigger_STATUS

    SqlDatabaseContainerUserDefinedFunction

    Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​databaseAccounts/​{accountName}/​sqlDatabases/​{databaseName}/​containers/​{containerName}/​userDefinedFunctions/​{userDefinedFunctionName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DatabaseAccounts_SqlDatabases_Containers_UserDefinedFunction_Spec


    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: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    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: The standard JSON format of a userDefinedFunction

    tags
    map[string]string
    status
    DatabaseAccounts_SqlDatabases_Containers_UserDefinedFunction_STATUS

    SqlDatabaseCreateUpdateProperties_ARM

    (Appears on:DatabaseAccounts_SqlDatabase_Spec_ARM)

    Properties to create and update Azure Cosmos DB SQL database.

    Field Description
    options
    CreateUpdateOptions_ARM

    Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    resource
    SqlDatabaseResource_ARM

    Resource: The standard JSON format of a SQL database

    SqlDatabaseGetProperties_Resource_STATUS

    (Appears on:DatabaseAccounts_SqlDatabase_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_Resource_STATUS_ARM

    (Appears on:SqlDatabaseGetProperties_STATUS_ARM)

    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_ARM

    (Appears on:DatabaseAccounts_SqlDatabase_STATUS_ARM)

    The properties of an Azure Cosmos DB SQL database

    Field Description
    options
    OptionsResource_STATUS_ARM

    Options: Cosmos DB options resource object

    resource
    SqlDatabaseGetProperties_Resource_STATUS_ARM

    SqlDatabaseResource

    (Appears on:DatabaseAccounts_SqlDatabase_Spec)

    Cosmos DB SQL database resource object

    Field Description
    id
    string

    Id: Name of the Cosmos DB SQL database

    SqlDatabaseResource_ARM

    (Appears on:SqlDatabaseCreateUpdateProperties_ARM)

    Cosmos DB SQL database resource object

    Field Description
    id
    string

    Id: Name of the Cosmos DB SQL database

    SqlDatabaseThroughputSetting

    Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/cosmos-db.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​databaseAccounts/​{accountName}/​sqlDatabases/​{databaseName}/​throughputSettings/​default

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DatabaseAccounts_SqlDatabases_ThroughputSetting_Spec


    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: The standard JSON format of a resource throughput

    tags
    map[string]string
    status
    DatabaseAccounts_SqlDatabases_ThroughputSetting_STATUS

    SqlRoleAssignment

    Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2021-05-15/rbac.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.DocumentDB/​databaseAccounts/​{accountName}/​sqlRoleAssignments/​{roleAssignmentId}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    DatabaseAccounts_SqlRoleAssignment_Spec


    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.

    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

    principalId
    string

    PrincipalId: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.

    principalIdFromConfig
    genruntime.ConfigMapReference

    PrincipalIdFromConfig: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.

    roleDefinitionId
    string

    RoleDefinitionId: The unique identifier for the associated Role Definition.

    scope
    string

    Scope: The data plane resource path for which access is being granted through this Role Assignment.

    status
    DatabaseAccounts_SqlRoleAssignment_STATUS

    SqlRoleAssignmentResource_ARM

    (Appears on:DatabaseAccounts_SqlRoleAssignment_Spec_ARM)

    Azure Cosmos DB SQL Role Assignment resource object.

    Field Description
    principalId
    string

    PrincipalId: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.

    roleDefinitionId
    string

    RoleDefinitionId: The unique identifier for the associated Role Definition.

    scope
    string

    Scope: The data plane resource path for which access is being granted through this Role Assignment.

    SqlRoleAssignmentResource_STATUS_ARM

    (Appears on:DatabaseAccounts_SqlRoleAssignment_STATUS_ARM)

    Azure Cosmos DB SQL Role Assignment resource object.

    Field Description
    principalId
    string

    PrincipalId: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.

    roleDefinitionId
    string

    RoleDefinitionId: The unique identifier for the associated Role Definition.

    scope
    string

    Scope: The data plane resource path for which access is being granted through this Role Assignment.

    SqlStoredProcedureCreateUpdateProperties_ARM

    (Appears on:DatabaseAccounts_SqlDatabases_Containers_StoredProcedure_Spec_ARM)

    Properties to create and update Azure Cosmos DB storedProcedure.

    Field Description
    options
    CreateUpdateOptions_ARM

    Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    resource
    SqlStoredProcedureResource_ARM

    Resource: The standard JSON format of a storedProcedure

    SqlStoredProcedureGetProperties_Resource_STATUS

    (Appears on:DatabaseAccounts_SqlDatabases_Containers_StoredProcedure_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_Resource_STATUS_ARM

    (Appears on:SqlStoredProcedureGetProperties_STATUS_ARM)

    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_ARM

    (Appears on:DatabaseAccounts_SqlDatabases_Containers_StoredProcedure_STATUS_ARM)

    The properties of an Azure Cosmos DB StoredProcedure

    Field Description
    resource
    SqlStoredProcedureGetProperties_Resource_STATUS_ARM

    SqlStoredProcedureResource

    (Appears on:DatabaseAccounts_SqlDatabases_Containers_StoredProcedure_Spec)

    Cosmos DB SQL storedProcedure resource object

    Field Description
    body
    string

    Body: Body of the Stored Procedure

    id
    string

    Id: Name of the Cosmos DB SQL storedProcedure

    SqlStoredProcedureResource_ARM

    (Appears on:SqlStoredProcedureCreateUpdateProperties_ARM)

    Cosmos DB SQL storedProcedure resource object

    Field Description
    body
    string

    Body: Body of the Stored Procedure

    id
    string

    Id: Name of the Cosmos DB SQL storedProcedure

    SqlTriggerCreateUpdateProperties_ARM

    (Appears on:DatabaseAccounts_SqlDatabases_Containers_Trigger_Spec_ARM)

    Properties to create and update Azure Cosmos DB trigger.

    Field Description
    options
    CreateUpdateOptions_ARM

    Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    resource
    SqlTriggerResource_ARM

    Resource: The standard JSON format of a trigger

    SqlTriggerGetProperties_Resource_STATUS

    (Appears on:DatabaseAccounts_SqlDatabases_Containers_Trigger_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
    SqlTriggerGetProperties_Resource_TriggerOperation_STATUS

    TriggerOperation: The operation the trigger is associated with

    triggerType
    SqlTriggerGetProperties_Resource_TriggerType_STATUS

    TriggerType: Type of the Trigger

    _ts
    float64

    Ts: A system generated property that denotes the last updated timestamp of the resource.

    SqlTriggerGetProperties_Resource_STATUS_ARM

    (Appears on:SqlTriggerGetProperties_STATUS_ARM)

    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
    SqlTriggerGetProperties_Resource_TriggerOperation_STATUS

    TriggerOperation: The operation the trigger is associated with

    triggerType
    SqlTriggerGetProperties_Resource_TriggerType_STATUS

    TriggerType: Type of the Trigger

    _ts
    float64

    Ts: A system generated property that denotes the last updated timestamp of the resource.

    SqlTriggerGetProperties_Resource_TriggerOperation_STATUS (string alias)

    (Appears on:SqlTriggerGetProperties_Resource_STATUS, SqlTriggerGetProperties_Resource_STATUS_ARM)

    Value Description

    "All"

    "Create"

    "Delete"

    "Replace"

    "Update"

    SqlTriggerGetProperties_Resource_TriggerType_STATUS (string alias)

    (Appears on:SqlTriggerGetProperties_Resource_STATUS, SqlTriggerGetProperties_Resource_STATUS_ARM)

    Value Description

    "Post"

    "Pre"

    SqlTriggerGetProperties_STATUS_ARM

    (Appears on:DatabaseAccounts_SqlDatabases_Containers_Trigger_STATUS_ARM)

    The properties of an Azure Cosmos DB trigger

    Field Description
    resource
    SqlTriggerGetProperties_Resource_STATUS_ARM

    SqlTriggerResource

    (Appears on:DatabaseAccounts_SqlDatabases_Containers_Trigger_Spec)

    Cosmos DB SQL trigger resource object

    Field Description
    body
    string

    Body: Body of the Trigger

    id
    string

    Id: Name of the Cosmos DB SQL trigger

    triggerOperation
    SqlTriggerResource_TriggerOperation

    TriggerOperation: The operation the trigger is associated with

    triggerType
    SqlTriggerResource_TriggerType

    TriggerType: Type of the Trigger

    SqlTriggerResource_ARM

    (Appears on:SqlTriggerCreateUpdateProperties_ARM)

    Cosmos DB SQL trigger resource object

    Field Description
    body
    string

    Body: Body of the Trigger

    id
    string

    Id: Name of the Cosmos DB SQL trigger

    triggerOperation
    SqlTriggerResource_TriggerOperation

    TriggerOperation: The operation the trigger is associated with

    triggerType
    SqlTriggerResource_TriggerType

    TriggerType: Type of the Trigger

    SqlTriggerResource_TriggerOperation (string alias)

    (Appears on:SqlTriggerResource, SqlTriggerResource_ARM)

    Value Description

    "All"

    "Create"

    "Delete"

    "Replace"

    "Update"

    SqlTriggerResource_TriggerType (string alias)

    (Appears on:SqlTriggerResource, SqlTriggerResource_ARM)

    Value Description

    "Post"

    "Pre"

    SqlUserDefinedFunctionCreateUpdateProperties_ARM

    (Appears on:DatabaseAccounts_SqlDatabases_Containers_UserDefinedFunction_Spec_ARM)

    Properties to create and update Azure Cosmos DB userDefinedFunction.

    Field Description
    options
    CreateUpdateOptions_ARM

    Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.

    resource
    SqlUserDefinedFunctionResource_ARM

    Resource: The standard JSON format of a userDefinedFunction

    SqlUserDefinedFunctionGetProperties_Resource_STATUS

    (Appears on:DatabaseAccounts_SqlDatabases_Containers_UserDefinedFunction_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_Resource_STATUS_ARM

    (Appears on:SqlUserDefinedFunctionGetProperties_STATUS_ARM)

    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_ARM

    (Appears on:DatabaseAccounts_SqlDatabases_Containers_UserDefinedFunction_STATUS_ARM)

    The properties of an Azure Cosmos DB userDefinedFunction

    Field Description
    resource
    SqlUserDefinedFunctionGetProperties_Resource_STATUS_ARM

    SqlUserDefinedFunctionResource

    (Appears on:DatabaseAccounts_SqlDatabases_Containers_UserDefinedFunction_Spec)

    Cosmos DB SQL userDefinedFunction resource object

    Field Description
    body
    string

    Body: Body of the User Defined Function

    id
    string

    Id: Name of the Cosmos DB SQL userDefinedFunction

    SqlUserDefinedFunctionResource_ARM

    (Appears on:SqlUserDefinedFunctionCreateUpdateProperties_ARM)

    Cosmos DB SQL userDefinedFunction resource object

    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)

    Cosmos DB resource throughput policy

    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_ARM

    (Appears on:AutoUpgradePolicyResource_ARM)

    Cosmos DB resource throughput policy

    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)

    Cosmos DB resource throughput policy

    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_ARM

    (Appears on:AutoUpgradePolicyResource_STATUS_ARM)

    Cosmos DB resource throughput policy

    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_Resource_STATUS

    (Appears on:DatabaseAccounts_MongodbDatabases_Collections_ThroughputSetting_STATUS, DatabaseAccounts_MongodbDatabases_ThroughputSetting_STATUS, DatabaseAccounts_SqlDatabases_Containers_ThroughputSetting_STATUS, DatabaseAccounts_SqlDatabases_ThroughputSetting_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_Resource_STATUS_ARM

    (Appears on:ThroughputSettingsGetProperties_STATUS_ARM)

    Field Description
    autoscaleSettings
    AutoscaleSettingsResource_STATUS_ARM

    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_ARM

    (Appears on:DatabaseAccounts_MongodbDatabases_Collections_ThroughputSetting_STATUS_ARM, DatabaseAccounts_MongodbDatabases_ThroughputSetting_STATUS_ARM, DatabaseAccounts_SqlDatabases_Containers_ThroughputSetting_STATUS_ARM, DatabaseAccounts_SqlDatabases_ThroughputSetting_STATUS_ARM)

    The properties of an Azure Cosmos DB resource throughput

    Field Description
    resource
    ThroughputSettingsGetProperties_Resource_STATUS_ARM

    ThroughputSettingsResource

    (Appears on:DatabaseAccounts_MongodbDatabases_Collections_ThroughputSetting_Spec, DatabaseAccounts_MongodbDatabases_ThroughputSetting_Spec, DatabaseAccounts_SqlDatabases_Containers_ThroughputSetting_Spec, DatabaseAccounts_SqlDatabases_ThroughputSetting_Spec)

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

    Field Description
    autoscaleSettings
    AutoscaleSettingsResource

    AutoscaleSettings: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.

    throughput
    int

    Throughput: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.

    ThroughputSettingsResource_ARM

    (Appears on:ThroughputSettingsUpdateProperties_ARM)

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

    Field Description
    autoscaleSettings
    AutoscaleSettingsResource_ARM

    AutoscaleSettings: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.

    throughput
    int

    Throughput: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.

    ThroughputSettingsUpdateProperties_ARM

    (Appears on:DatabaseAccounts_MongodbDatabases_Collections_ThroughputSetting_Spec_ARM, DatabaseAccounts_MongodbDatabases_ThroughputSetting_Spec_ARM, DatabaseAccounts_SqlDatabases_Containers_ThroughputSetting_Spec_ARM, DatabaseAccounts_SqlDatabases_ThroughputSetting_Spec_ARM)

    Properties to update Azure Cosmos DB resource throughput.

    Field Description
    resource
    ThroughputSettingsResource_ARM

    Resource: The standard JSON format of a resource throughput

    UniqueKey

    (Appears on:UniqueKeyPolicy)

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

    Field Description
    paths
    []string

    Paths: List of paths must be unique for each document in the Azure Cosmos DB service

    UniqueKeyPolicy

    (Appears on:SqlContainerResource)

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

    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.

    UniqueKeyPolicy_ARM

    (Appears on:SqlContainerResource_ARM)

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

    Field Description
    uniqueKeys
    []UniqueKey_ARM

    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_Resource_STATUS)

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

    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_STATUS_ARM

    (Appears on:SqlContainerGetProperties_Resource_STATUS_ARM)

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

    Field Description
    uniqueKeys
    []UniqueKey_STATUS_ARM

    UniqueKeys: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

    UniqueKey_ARM

    (Appears on:UniqueKeyPolicy_ARM)

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

    Field Description
    paths
    []string

    Paths: List of paths must be unique for each document in the Azure Cosmos DB service

    UniqueKey_STATUS

    (Appears on:UniqueKeyPolicy_STATUS)

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

    Field Description
    paths
    []string

    Paths: List of paths must be unique for each document in the Azure Cosmos DB service

    UniqueKey_STATUS_ARM

    (Appears on:UniqueKeyPolicy_STATUS_ARM)

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

    Field Description
    paths
    []string

    Paths: List of paths must be unique for each document in the Azure Cosmos DB service

    UserAssignedIdentityDetails

    (Appears on:ManagedServiceIdentity)

    Information about the user assigned identity for the resource

    Field Description
    reference
    genruntime.ResourceReference

    UserAssignedIdentityDetails_ARM

    (Appears on:ManagedServiceIdentity_ARM)

    Information about the user assigned identity for the resource

    VirtualNetworkRule

    (Appears on:DatabaseAccount_Spec)

    Virtual Network ACL Rule object

    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}.

    VirtualNetworkRule_ARM

    (Appears on:DatabaseAccountCreateUpdateProperties_ARM)

    Virtual Network ACL Rule object

    Field Description
    id
    string
    ignoreMissingVNetServiceEndpoint
    bool

    IgnoreMissingVNetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled.

    VirtualNetworkRule_STATUS

    (Appears on:DatabaseAccount_STATUS)

    Virtual Network ACL Rule object

    Field Description
    id
    string

    Id: Resource ID of a subnet, for example: /​subscriptions/​{subscriptionId}/​resourceGroups/​{groupName}/​providers/​Microsoft.Network/​virtualNetworks/​{virtualNetworkName}/​subnets/​{subnetName}.

    ignoreMissingVNetServiceEndpoint
    bool

    IgnoreMissingVNetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled.

    VirtualNetworkRule_STATUS_ARM

    (Appears on:DatabaseAccountGetProperties_STATUS_ARM)

    Virtual Network ACL Rule object

    Field Description
    id
    string

    Id: Resource ID of a subnet, for example: /​subscriptions/​{subscriptionId}/​resourceGroups/​{groupName}/​providers/​Microsoft.Network/​virtualNetworks/​{virtualNetworkName}/​subnets/​{subnetName}.

    ignoreMissingVNetServiceEndpoint
    bool

    IgnoreMissingVNetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled.