Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getDatabaseAccount

An Azure Cosmos DB database account. API Version: 2021-03-15.

Using getDatabaseAccount

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDatabaseAccount(args: GetDatabaseAccountArgs, opts?: InvokeOptions): Promise<GetDatabaseAccountResult>
function getDatabaseAccountOutput(args: GetDatabaseAccountOutputArgs, opts?: InvokeOptions): Output<GetDatabaseAccountResult>
def get_database_account(account_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetDatabaseAccountResult
def get_database_account_output(account_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseAccountResult]
func LookupDatabaseAccount(ctx *Context, args *LookupDatabaseAccountArgs, opts ...InvokeOption) (*LookupDatabaseAccountResult, error)
func LookupDatabaseAccountOutput(ctx *Context, args *LookupDatabaseAccountOutputArgs, opts ...InvokeOption) LookupDatabaseAccountResultOutput

> Note: This function is named LookupDatabaseAccount in the Go SDK.

public static class GetDatabaseAccount 
{
    public static Task<GetDatabaseAccountResult> InvokeAsync(GetDatabaseAccountArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseAccountResult> Invoke(GetDatabaseAccountInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDatabaseAccountResult> getDatabaseAccount(GetDatabaseAccountArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:documentdb:getDatabaseAccount
  Arguments:
    # Arguments dictionary

The following arguments are supported:

AccountName string

Cosmos DB database account name.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

AccountName string

Cosmos DB database account name.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

accountName String

Cosmos DB database account name.

resourceGroupName String

The name of the resource group. The name is case insensitive.

accountName string

Cosmos DB database account name.

resourceGroupName string

The name of the resource group. The name is case insensitive.

account_name str

Cosmos DB database account name.

resource_group_name str

The name of the resource group. The name is case insensitive.

accountName String

Cosmos DB database account name.

resourceGroupName String

The name of the resource group. The name is case insensitive.

getDatabaseAccount Result

The following output properties are available:

DatabaseAccountOfferType string

The offer type for the Cosmos DB database account. Default value: Standard.

DocumentEndpoint string

The connection endpoint for the Cosmos DB database account.

FailoverPolicies List<Pulumi.AzureNative.DocumentDB.Outputs.FailoverPolicyResponse>

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

Id string

The unique resource identifier of the ARM resource.

Locations List<Pulumi.AzureNative.DocumentDB.Outputs.LocationResponse>

An array that contains all of the locations enabled for the Cosmos DB account.

Name string

The name of the ARM resource.

PrivateEndpointConnections List<Pulumi.AzureNative.DocumentDB.Outputs.PrivateEndpointConnectionResponse>

List of Private Endpoint Connections configured for the Cosmos DB account.

ProvisioningState string

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

ReadLocations List<Pulumi.AzureNative.DocumentDB.Outputs.LocationResponse>

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

Type string

The type of Azure resource.

WriteLocations List<Pulumi.AzureNative.DocumentDB.Outputs.LocationResponse>

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

ApiProperties Pulumi.AzureNative.DocumentDB.Outputs.ApiPropertiesResponse

API specific properties.

BackupPolicy Pulumi.AzureNative.DocumentDB.Outputs.ContinuousModeBackupPolicyResponse | Pulumi.AzureNative.DocumentDB.Outputs.PeriodicModeBackupPolicyResponse

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

Capabilities List<Pulumi.AzureNative.DocumentDB.Outputs.CapabilityResponse>

List of Cosmos DB capabilities for the account

ConnectorOffer string

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

ConsistencyPolicy Pulumi.AzureNative.DocumentDB.Outputs.ConsistencyPolicyResponse

The consistency policy for the Cosmos DB database account.

Cors List<Pulumi.AzureNative.DocumentDB.Outputs.CorsPolicyResponse>

The CORS policy for the Cosmos DB database account.

DefaultIdentity string

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

Disable write operations on metadata resources (databases, containers, throughput) via account keys

EnableAnalyticalStorage bool

Flag to indicate whether to enable storage analytics.

EnableAutomaticFailover bool

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

Enables the cassandra connector on the Cosmos DB C* account

EnableFreeTier bool

Flag to indicate whether Free Tier is enabled.

EnableMultipleWriteLocations bool

Enables the account to write in multiple locations

Identity Pulumi.AzureNative.DocumentDB.Outputs.ManagedServiceIdentityResponse

Identity for the resource.

IpRules List<Pulumi.AzureNative.DocumentDB.Outputs.IpAddressOrRangeResponse>

List of IpRules.

IsVirtualNetworkFilterEnabled bool

Flag to indicate whether to enable/disable Virtual Network ACL rules.

KeyVaultKeyUri string

The URI of the key vault

Kind string

Indicates the type of database account. This can only be set at database account creation.

Location string

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

NetworkAclBypass string

Indicates what services are allowed to bypass firewall checks.

NetworkAclBypassResourceIds List<string>

An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

PublicNetworkAccess string

Whether requests from Public Network are allowed

Tags Dictionary<string, string>

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

VirtualNetworkRules List<Pulumi.AzureNative.DocumentDB.Outputs.VirtualNetworkRuleResponse>

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

DatabaseAccountOfferType string

The offer type for the Cosmos DB database account. Default value: Standard.

DocumentEndpoint string

The connection endpoint for the Cosmos DB database account.

FailoverPolicies []FailoverPolicyResponse

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

Id string

The unique resource identifier of the ARM resource.

Locations []LocationResponse

An array that contains all of the locations enabled for the Cosmos DB account.

Name string

The name of the ARM resource.

PrivateEndpointConnections []PrivateEndpointConnectionResponse

List of Private Endpoint Connections configured for the Cosmos DB account.

ProvisioningState string

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

ReadLocations []LocationResponse

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

Type string

The type of Azure resource.

WriteLocations []LocationResponse

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

ApiProperties ApiPropertiesResponse

API specific properties.

BackupPolicy ContinuousModeBackupPolicyResponse | PeriodicModeBackupPolicyResponse

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

Capabilities []CapabilityResponse

List of Cosmos DB capabilities for the account

ConnectorOffer string

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

ConsistencyPolicy ConsistencyPolicyResponse

The consistency policy for the Cosmos DB database account.

Cors []CorsPolicyResponse

The CORS policy for the Cosmos DB database account.

DefaultIdentity string

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

Disable write operations on metadata resources (databases, containers, throughput) via account keys

EnableAnalyticalStorage bool

Flag to indicate whether to enable storage analytics.

EnableAutomaticFailover bool

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

Enables the cassandra connector on the Cosmos DB C* account

EnableFreeTier bool

Flag to indicate whether Free Tier is enabled.

EnableMultipleWriteLocations bool

Enables the account to write in multiple locations

Identity ManagedServiceIdentityResponse

Identity for the resource.

IpRules []IpAddressOrRangeResponse

List of IpRules.

IsVirtualNetworkFilterEnabled bool

Flag to indicate whether to enable/disable Virtual Network ACL rules.

KeyVaultKeyUri string

The URI of the key vault

Kind string

Indicates the type of database account. This can only be set at database account creation.

Location string

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

NetworkAclBypass string

Indicates what services are allowed to bypass firewall checks.

NetworkAclBypassResourceIds []string

An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

PublicNetworkAccess string

Whether requests from Public Network are allowed

Tags map[string]string

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

VirtualNetworkRules []VirtualNetworkRuleResponse

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

databaseAccountOfferType String

The offer type for the Cosmos DB database account. Default value: Standard.

documentEndpoint String

The connection endpoint for the Cosmos DB database account.

failoverPolicies ListPolicyResponse>

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

id String

The unique resource identifier of the ARM resource.

locations ListResponse>

An array that contains all of the locations enabled for the Cosmos DB account.

name String

The name of the ARM resource.

privateEndpointConnections ListEndpointConnectionResponse>

List of Private Endpoint Connections configured for the Cosmos DB account.

provisioningState String

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

readLocations ListResponse>

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

type String

The type of Azure resource.

writeLocations ListResponse>

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

apiProperties ApiPropertiesResponse

API specific properties.

backupPolicy ContinuousModeBackupPolicyResponse | PeriodicModeBackupPolicyResponse

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

capabilities ListResponse>

List of Cosmos DB capabilities for the account

connectorOffer String

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

consistencyPolicy ConsistencyPolicyResponse

The consistency policy for the Cosmos DB database account.

cors ListPolicyResponse>

The CORS policy for the Cosmos DB database account.

defaultIdentity String

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 Boolean

Disable write operations on metadata resources (databases, containers, throughput) via account keys

enableAnalyticalStorage Boolean

Flag to indicate whether to enable storage analytics.

enableAutomaticFailover Boolean

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 Boolean

Enables the cassandra connector on the Cosmos DB C* account

enableFreeTier Boolean

Flag to indicate whether Free Tier is enabled.

enableMultipleWriteLocations Boolean

Enables the account to write in multiple locations

identity ManagedServiceIdentityResponse

Identity for the resource.

ipRules ListAddressOrRangeResponse>

List of IpRules.

isVirtualNetworkFilterEnabled Boolean

Flag to indicate whether to enable/disable Virtual Network ACL rules.

keyVaultKeyUri String

The URI of the key vault

kind String

Indicates the type of database account. This can only be set at database account creation.

location String

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

networkAclBypass String

Indicates what services are allowed to bypass firewall checks.

networkAclBypassResourceIds List

An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

publicNetworkAccess String

Whether requests from Public Network are allowed

tags Map

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

virtualNetworkRules ListNetworkRuleResponse>

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

databaseAccountOfferType string

The offer type for the Cosmos DB database account. Default value: Standard.

documentEndpoint string

The connection endpoint for the Cosmos DB database account.

failoverPolicies FailoverPolicyResponse[]

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

id string

The unique resource identifier of the ARM resource.

locations LocationResponse[]

An array that contains all of the locations enabled for the Cosmos DB account.

name string

The name of the ARM resource.

privateEndpointConnections PrivateEndpointConnectionResponse[]

List of Private Endpoint Connections configured for the Cosmos DB account.

provisioningState string

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

readLocations LocationResponse[]

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

type string

The type of Azure resource.

writeLocations LocationResponse[]

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

apiProperties ApiPropertiesResponse

API specific properties.

backupPolicy ContinuousModeBackupPolicyResponse | PeriodicModeBackupPolicyResponse

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

capabilities CapabilityResponse[]

List of Cosmos DB capabilities for the account

connectorOffer string

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

consistencyPolicy ConsistencyPolicyResponse

The consistency policy for the Cosmos DB database account.

cors CorsPolicyResponse[]

The CORS policy for the Cosmos DB database account.

defaultIdentity string

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 boolean

Disable write operations on metadata resources (databases, containers, throughput) via account keys

enableAnalyticalStorage boolean

Flag to indicate whether to enable storage analytics.

enableAutomaticFailover boolean

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 boolean

Enables the cassandra connector on the Cosmos DB C* account

enableFreeTier boolean

Flag to indicate whether Free Tier is enabled.

enableMultipleWriteLocations boolean

Enables the account to write in multiple locations

identity ManagedServiceIdentityResponse

Identity for the resource.

ipRules IpAddressOrRangeResponse[]

List of IpRules.

isVirtualNetworkFilterEnabled boolean

Flag to indicate whether to enable/disable Virtual Network ACL rules.

keyVaultKeyUri string

The URI of the key vault

kind string

Indicates the type of database account. This can only be set at database account creation.

location string

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

networkAclBypass string

Indicates what services are allowed to bypass firewall checks.

networkAclBypassResourceIds string[]

An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

publicNetworkAccess string

Whether requests from Public Network are allowed

tags {[key: string]: string}

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

virtualNetworkRules VirtualNetworkRuleResponse[]

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

database_account_offer_type str

The offer type for the Cosmos DB database account. Default value: Standard.

document_endpoint str

The connection endpoint for the Cosmos DB database account.

failover_policies Sequence[FailoverPolicyResponse]

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

id str

The unique resource identifier of the ARM resource.

locations Sequence[LocationResponse]

An array that contains all of the locations enabled for the Cosmos DB account.

name str

The name of the ARM resource.

private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]

List of Private Endpoint Connections configured for the Cosmos DB account.

provisioning_state str

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

read_locations Sequence[LocationResponse]

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

type str

The type of Azure resource.

write_locations Sequence[LocationResponse]

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

api_properties ApiPropertiesResponse

API specific properties.

backup_policy ContinuousModeBackupPolicyResponse | PeriodicModeBackupPolicyResponse

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

capabilities Sequence[CapabilityResponse]

List of Cosmos DB capabilities for the account

connector_offer str

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

consistency_policy ConsistencyPolicyResponse

The consistency policy for the Cosmos DB database account.

cors Sequence[CorsPolicyResponse]

The CORS policy for the Cosmos DB database account.

default_identity str

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.

disable_key_based_metadata_write_access bool

Disable write operations on metadata resources (databases, containers, throughput) via account keys

enable_analytical_storage bool

Flag to indicate whether to enable storage analytics.

enable_automatic_failover bool

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.

enable_cassandra_connector bool

Enables the cassandra connector on the Cosmos DB C* account

enable_free_tier bool

Flag to indicate whether Free Tier is enabled.

enable_multiple_write_locations bool

Enables the account to write in multiple locations

identity ManagedServiceIdentityResponse

Identity for the resource.

ip_rules Sequence[IpAddressOrRangeResponse]

List of IpRules.

is_virtual_network_filter_enabled bool

Flag to indicate whether to enable/disable Virtual Network ACL rules.

key_vault_key_uri str

The URI of the key vault

kind str

Indicates the type of database account. This can only be set at database account creation.

location str

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

network_acl_bypass str

Indicates what services are allowed to bypass firewall checks.

network_acl_bypass_resource_ids Sequence[str]

An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

public_network_access str

Whether requests from Public Network are allowed

tags Mapping[str, str]

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

virtual_network_rules Sequence[VirtualNetworkRuleResponse]

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

databaseAccountOfferType String

The offer type for the Cosmos DB database account. Default value: Standard.

documentEndpoint String

The connection endpoint for the Cosmos DB database account.

failoverPolicies List

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

id String

The unique resource identifier of the ARM resource.

locations List

An array that contains all of the locations enabled for the Cosmos DB account.

name String

The name of the ARM resource.

privateEndpointConnections List

List of Private Endpoint Connections configured for the Cosmos DB account.

provisioningState String

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

readLocations List

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

type String

The type of Azure resource.

writeLocations List

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

apiProperties Property Map

API specific properties.

backupPolicy Property Map | Property Map

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

capabilities List

List of Cosmos DB capabilities for the account

connectorOffer String

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

consistencyPolicy Property Map

The consistency policy for the Cosmos DB database account.

cors List

The CORS policy for the Cosmos DB database account.

defaultIdentity String

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 Boolean

Disable write operations on metadata resources (databases, containers, throughput) via account keys

enableAnalyticalStorage Boolean

Flag to indicate whether to enable storage analytics.

enableAutomaticFailover Boolean

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 Boolean

Enables the cassandra connector on the Cosmos DB C* account

enableFreeTier Boolean

Flag to indicate whether Free Tier is enabled.

enableMultipleWriteLocations Boolean

Enables the account to write in multiple locations

identity Property Map

Identity for the resource.

ipRules List

List of IpRules.

isVirtualNetworkFilterEnabled Boolean

Flag to indicate whether to enable/disable Virtual Network ACL rules.

keyVaultKeyUri String

The URI of the key vault

kind String

Indicates the type of database account. This can only be set at database account creation.

location String

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

networkAclBypass String

Indicates what services are allowed to bypass firewall checks.

networkAclBypassResourceIds List

An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.

publicNetworkAccess String

Whether requests from Public Network are allowed

tags Map

Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".

virtualNetworkRules List

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

Supporting Types

ApiPropertiesResponse

ServerVersion string

Describes the ServerVersion of an a MongoDB account.

ServerVersion string

Describes the ServerVersion of an a MongoDB account.

serverVersion String

Describes the ServerVersion of an a MongoDB account.

serverVersion string

Describes the ServerVersion of an a MongoDB account.

server_version str

Describes the ServerVersion of an a MongoDB account.

serverVersion String

Describes the ServerVersion of an a MongoDB account.

CapabilityResponse

Name string

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

Name string

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

name String

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

name string

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

name str

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

name String

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

ConsistencyPolicyResponse

DefaultConsistencyLevel string

The default consistency level and configuration settings of the Cosmos DB account.

MaxIntervalInSeconds int

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 double

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

DefaultConsistencyLevel string

The default consistency level and configuration settings of the Cosmos DB account.

MaxIntervalInSeconds int

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 float64

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

defaultConsistencyLevel String

The default consistency level and configuration settings of the Cosmos DB account.

maxIntervalInSeconds Integer

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 Double

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

defaultConsistencyLevel string

The default consistency level and configuration settings of the Cosmos DB account.

maxIntervalInSeconds number

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 number

When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.

default_consistency_level str

The default consistency level and configuration settings of the Cosmos DB account.

max_interval_in_seconds int

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

max_staleness_prefix float

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

defaultConsistencyLevel String

The default consistency level and configuration settings of the Cosmos DB account.

maxIntervalInSeconds Number

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 Number

When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.

ContinuousModeBackupPolicyResponse

CorsPolicyResponse

AllowedOrigins string

The origin domains that are permitted to make a request against the service via CORS.

AllowedHeaders string

The request headers that the origin domain may specify on the CORS request.

AllowedMethods string

The methods (HTTP request verbs) that the origin domain may use for a CORS request.

ExposedHeaders string

The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

MaxAgeInSeconds double

The maximum amount time that a browser should cache the preflight OPTIONS request.

AllowedOrigins string

The origin domains that are permitted to make a request against the service via CORS.

AllowedHeaders string

The request headers that the origin domain may specify on the CORS request.

AllowedMethods string

The methods (HTTP request verbs) that the origin domain may use for a CORS request.

ExposedHeaders string

The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

MaxAgeInSeconds float64

The maximum amount time that a browser should cache the preflight OPTIONS request.

allowedOrigins String

The origin domains that are permitted to make a request against the service via CORS.

allowedHeaders String

The request headers that the origin domain may specify on the CORS request.

allowedMethods String

The methods (HTTP request verbs) that the origin domain may use for a CORS request.

exposedHeaders String

The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

maxAgeInSeconds Double

The maximum amount time that a browser should cache the preflight OPTIONS request.

allowedOrigins string

The origin domains that are permitted to make a request against the service via CORS.

allowedHeaders string

The request headers that the origin domain may specify on the CORS request.

allowedMethods string

The methods (HTTP request verbs) that the origin domain may use for a CORS request.

exposedHeaders string

The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

maxAgeInSeconds number

The maximum amount time that a browser should cache the preflight OPTIONS request.

allowed_origins str

The origin domains that are permitted to make a request against the service via CORS.

allowed_headers str

The request headers that the origin domain may specify on the CORS request.

allowed_methods str

The methods (HTTP request verbs) that the origin domain may use for a CORS request.

exposed_headers str

The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

max_age_in_seconds float

The maximum amount time that a browser should cache the preflight OPTIONS request.

allowedOrigins String

The origin domains that are permitted to make a request against the service via CORS.

allowedHeaders String

The request headers that the origin domain may specify on the CORS request.

allowedMethods String

The methods (HTTP request verbs) that the origin domain may use for a CORS request.

exposedHeaders String

The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

maxAgeInSeconds Number

The maximum amount time that a browser should cache the preflight OPTIONS request.

FailoverPolicyResponse

Id string

The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.

FailoverPriority int

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.

LocationName string

The name of the region in which the database account exists.

Id string

The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.

FailoverPriority int

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.

LocationName string

The name of the region in which the database account exists.

id String

The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.

failoverPriority Integer

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.

locationName String

The name of the region in which the database account exists.

id string

The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.

failoverPriority number

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.

locationName string

The name of the region in which the database account exists.

id str

The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.

failover_priority int

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.

location_name str

The name of the region in which the database account exists.

id String

The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>.

failoverPriority Number

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.

locationName String

The name of the region in which the database account exists.

IpAddressOrRangeResponse

IpAddressOrRange string

A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.

IpAddressOrRange string

A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.

ipAddressOrRange String

A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.

ipAddressOrRange string

A 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”.

ip_address_or_range str

A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”.

ipAddressOrRange String

A 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”.

LocationResponse

DocumentEndpoint string

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

Id string

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.

ProvisioningState string

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

FailoverPriority int

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

Flag to indicate whether or not this region is an AvailabilityZone region

LocationName string

The name of the region.

DocumentEndpoint string

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

Id string

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.

ProvisioningState string

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

FailoverPriority int

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

Flag to indicate whether or not this region is an AvailabilityZone region

LocationName string

The name of the region.

documentEndpoint String

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

id String

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.

provisioningState String

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

failoverPriority Integer

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 Boolean

Flag to indicate whether or not this region is an AvailabilityZone region

locationName String

The name of the region.

documentEndpoint string

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

id string

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.

provisioningState string

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

failoverPriority number

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 boolean

Flag to indicate whether or not this region is an AvailabilityZone region

locationName string

The name of the region.

document_endpoint str

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

id str

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.

provisioning_state str

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

failover_priority int

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.

is_zone_redundant bool

Flag to indicate whether or not this region is an AvailabilityZone region

location_name str

The name of the region.

documentEndpoint String

The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/

id String

The unique identifier of the region within the database account. Example: <accountName>-<locationName>.

provisioningState String

The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed.

failoverPriority Number

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 Boolean

Flag to indicate whether or not this region is an AvailabilityZone region

locationName String

The name of the region.

ManagedServiceIdentityResponse

PrincipalId string

The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

TenantId string

The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.

Type string

The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.DocumentDB.Inputs.ManagedServiceIdentityResponseUserAssignedIdentities>

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

PrincipalId string

The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

TenantId string

The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.

Type string

The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

UserAssignedIdentities map[string]ManagedServiceIdentityResponseUserAssignedIdentities

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

principalId String

The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

tenantId String

The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.

type String

The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

userAssignedIdentities MapServiceIdentityResponseUserAssignedIdentities>

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

principalId string

The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

tenantId string

The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.

type string

The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

userAssignedIdentities {[key: string]: ManagedServiceIdentityResponseUserAssignedIdentities}

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

principal_id str

The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

tenant_id str

The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.

type str

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.

user_assigned_identities Mapping[str, ManagedServiceIdentityResponseUserAssignedIdentities]

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

principalId String

The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

tenantId String

The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.

type String

The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.

userAssignedIdentities Map

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

ManagedServiceIdentityResponseUserAssignedIdentities

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

clientId string

The client id of user assigned identity.

principalId string

The principal id of user assigned identity.

client_id str

The client id of user assigned identity.

principal_id str

The principal id of user assigned identity.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

PeriodicModeBackupPolicyResponse

PeriodicModeProperties PeriodicModePropertiesResponse

Configuration values for periodic mode backup

periodicModeProperties PeriodicModePropertiesResponse

Configuration values for periodic mode backup

periodicModeProperties PeriodicModePropertiesResponse

Configuration values for periodic mode backup

periodic_mode_properties PeriodicModePropertiesResponse

Configuration values for periodic mode backup

periodicModeProperties Property Map

Configuration values for periodic mode backup

PeriodicModePropertiesResponse

BackupIntervalInMinutes int

An integer representing the interval in minutes between two backups

BackupRetentionIntervalInHours int

An integer representing the time (in hours) that each backup is retained

BackupIntervalInMinutes int

An integer representing the interval in minutes between two backups

BackupRetentionIntervalInHours int

An integer representing the time (in hours) that each backup is retained

backupIntervalInMinutes Integer

An integer representing the interval in minutes between two backups

backupRetentionIntervalInHours Integer

An integer representing the time (in hours) that each backup is retained

backupIntervalInMinutes number

An integer representing the interval in minutes between two backups

backupRetentionIntervalInHours number

An integer representing the time (in hours) that each backup is retained

backup_interval_in_minutes int

An integer representing the interval in minutes between two backups

backup_retention_interval_in_hours int

An integer representing the time (in hours) that each backup is retained

backupIntervalInMinutes Number

An integer representing the interval in minutes between two backups

backupRetentionIntervalInHours Number

An integer representing the time (in hours) that each backup is retained

PrivateEndpointConnectionResponse

Id string

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

Name string

The name of the resource

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

GroupId string

Group id of the private endpoint.

PrivateEndpoint Pulumi.AzureNative.DocumentDB.Inputs.PrivateEndpointPropertyResponse

Private endpoint which the connection belongs to.

PrivateLinkServiceConnectionState Pulumi.AzureNative.DocumentDB.Inputs.PrivateLinkServiceConnectionStatePropertyResponse

Connection State of the Private Endpoint Connection.

ProvisioningState string

Provisioning state of the private endpoint.

Id string

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

Name string

The name of the resource

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

GroupId string

Group id of the private endpoint.

PrivateEndpoint PrivateEndpointPropertyResponse

Private endpoint which the connection belongs to.

PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse

Connection State of the Private Endpoint Connection.

ProvisioningState string

Provisioning state of the private endpoint.

id String

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

name String

The name of the resource

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

groupId String

Group id of the private endpoint.

privateEndpoint PrivateEndpointPropertyResponse

Private endpoint which the connection belongs to.

privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse

Connection State of the Private Endpoint Connection.

provisioningState String

Provisioning state of the private endpoint.

id string

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

name string

The name of the resource

type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

groupId string

Group id of the private endpoint.

privateEndpoint PrivateEndpointPropertyResponse

Private endpoint which the connection belongs to.

privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse

Connection State of the Private Endpoint Connection.

provisioningState string

Provisioning state of the private endpoint.

id str

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

name str

The name of the resource

type str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

group_id str

Group id of the private endpoint.

private_endpoint PrivateEndpointPropertyResponse

Private endpoint which the connection belongs to.

private_link_service_connection_state PrivateLinkServiceConnectionStatePropertyResponse

Connection State of the Private Endpoint Connection.

provisioning_state str

Provisioning state of the private endpoint.

id String

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

name String

The name of the resource

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

groupId String

Group id of the private endpoint.

privateEndpoint Property Map

Private endpoint which the connection belongs to.

privateLinkServiceConnectionState Property Map

Connection State of the Private Endpoint Connection.

provisioningState String

Provisioning state of the private endpoint.

PrivateEndpointPropertyResponse

Id string

Resource id of the private endpoint.

Id string

Resource id of the private endpoint.

id String

Resource id of the private endpoint.

id string

Resource id of the private endpoint.

id str

Resource id of the private endpoint.

id String

Resource id of the private endpoint.

PrivateLinkServiceConnectionStatePropertyResponse

ActionsRequired string

Any action that is required beyond basic workflow (approve/ reject/ disconnect)

Description string

The private link service connection description.

Status string

The private link service connection status.

ActionsRequired string

Any action that is required beyond basic workflow (approve/ reject/ disconnect)

Description string

The private link service connection description.

Status string

The private link service connection status.

actionsRequired String

Any action that is required beyond basic workflow (approve/ reject/ disconnect)

description String

The private link service connection description.

status String

The private link service connection status.

actionsRequired string

Any action that is required beyond basic workflow (approve/ reject/ disconnect)

description string

The private link service connection description.

status string

The private link service connection status.

actions_required str

Any action that is required beyond basic workflow (approve/ reject/ disconnect)

description str

The private link service connection description.

status str

The private link service connection status.

actionsRequired String

Any action that is required beyond basic workflow (approve/ reject/ disconnect)

description String

The private link service connection description.

status String

The private link service connection status.

VirtualNetworkRuleResponse

Id string

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

IgnoreMissingVNetServiceEndpoint bool

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

Id string

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

IgnoreMissingVNetServiceEndpoint bool

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

id String

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

ignoreMissingVNetServiceEndpoint Boolean

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

id string

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

ignoreMissingVNetServiceEndpoint boolean

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

id str

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

ignore_missing_v_net_service_endpoint bool

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

id String

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

ignoreMissingVNetServiceEndpoint Boolean

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0