你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

New-AzCosmosDBAccount

创建新的 CosmosDB 帐户。

语法

Default (默认值)

New-AzCosmosDBAccount
    [-EnableAutomaticFailover]
    [-EnableMultipleWriteLocations]
    [-EnableVirtualNetwork]
    [-FromPointInTimeBackup]
    [-ApiKind <String>]
    [-DisableKeyBasedMetadataWriteAccess]
    [-EnableFreeTier <Boolean>]
    [-Location <String[]>]
    [-LocationObject <PSLocation[]>]
    [-Capabilities <String[]>]
    -ResourceGroupName <String>
    -Name <String>
    [-DefaultConsistencyLevel <String>]
    [-IpRule <String[]>]
    [-MaxStalenessIntervalInSeconds <Int32>]
    [-MaxStalenessPrefix <Int32>]
    [-Tag <Hashtable>]
    [-VirtualNetworkRule <String[]>]
    [-VirtualNetworkRuleObject <PSVirtualNetworkRule[]>]
    [-PublicNetworkAccess <String>]
    [-KeyVaultKeyUri <String>]
    [-EnableAnalyticalStorage <Boolean>]
    [-EnablePartitionMerge <Boolean>]
    [-EnableBurstCapacity <Boolean>]
    [-EnablePriorityBasedExecution <Boolean>]
    [-DefaultPriorityLevel <String>]
    [-AsJob]
    [-NetworkAclBypass <String>]
    [-NetworkAclBypassResourceId <String[]>]
    [-ServerVersion <String>]
    [-BackupIntervalInMinutes <Int32>]
    [-BackupRetentionIntervalInHours <Int32>]
    [-BackupStorageRedundancy <String>]
    [-BackupPolicyType <String>]
    [-ContinuousTier <String>]
    [-AnalyticalStorageSchemaType <String>]
    [-MinimalTlsVersion <String>]
    [-EnablePerRegionPerPartitionAutoscale <Boolean>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

在给定的 ResourceGroup 中创建新的 CosmosDB 帐户。

示例

示例 1

New-AzCosmosDBAccount -ResourceGroupName resourceGroupName -Name databaseAccountName -Location "East US"
Kind                          : GlobalDocumentDB
ProvisioningState             : Initializing
DocumentEndpoint              :
DatabaseAccountOfferType      : Standard
IpRangeFilter                 :
IsVirtualNetworkFilterEnabled : False
EnableAutomaticFailover       : False
ConsistencyPolicy             : Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy
Capabilities                  : {}
WriteLocations                : {databaseAccountName-eastus}
ReadLocations                 : {databaseAccountName-eastus}
FailoverPolicies              : {databaseAccountName-eastus}
VirtualNetworkRules           : {}
EnableMultipleWriteLocations  : False
Location                      : East US
Tags                          : {}
Id                            : /subscriptions/{subscriptionid}/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/databaseAccountName
Name                          : databaseAccountName
Type                          : Microsoft.DocumentDB/databaseAccounts
NetworkAclBypass              : None
NetworkAclBypassResourceIds   : {}

在 ResourceGroup resourceGroupName 中创建名为 databaseAccountName 的新 CosmosDB 帐户。

参数

-AnalyticalStorageSchemaType

分析存储的架构类型。 有效值包括:“WellDefined”和“FullFidelity”。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ApiKind

要创建的 Cosmos DB 数据库帐户的类型。 接受的值:GlobalDocumentDB、MongoDB、Gremlin、Table、Cassandra。 默认值:GlobalDocumentDB

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-AsJob

在后台运行 cmdlet

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-BackupIntervalInMinutes

备份的间隔(以分钟为单位)(仅适用于定期模式备份的帐户)

参数属性

类型:

Nullable<T>[Int32]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-BackupPolicyType

Cosmos DB 帐户上的备份类型。 接受的值:定期、连续

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-BackupRetentionIntervalInHours

保留每个备份的时间(以小时为单位)(仅适用于定期模式备份的帐户)

参数属性

类型:

Nullable<T>[Int32]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-BackupStorageRedundancy

备份存储帐户的冗余类型

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Capabilities

将位置添加到 Cosmos DB 数据库帐户。 字符串数组,按故障转移优先级排序。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Confirm

在运行 cmdlet 之前,提示你进行确认。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ContinuousTier

Cosmos DB 帐户上的连续备份模式层。 接受的值:Continuous7Days、Continuous30Days

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultConsistencyLevel

Cosmos DB 数据库帐户的默认一致性级别。 接受的值:BoundedStaleness、ConsistentPrefix、Eventual、Session、Strong

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultPriorityLevel

Cosmos DB 数据库帐户的默认优先级请求级别。 接受的值:高、低

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DisableKeyBasedMetadataWriteAccess

通过帐户密钥对元数据资源(数据库、容器、吞吐量)禁用写入操作

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-EnableAnalyticalStorage

用于指示是否在帐户上启用了分析Storage 的布尔值。

参数属性

类型:

Nullable<T>[Boolean]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-EnableAutomaticFailover

在极少数情况下启用写入区域的自动故障转移,因为服务中断导致该区域不可用。 自动故障转移将导致帐户的新写入区域,并根据为帐户配置的故障转移优先级进行选择。 接受的值:false、true

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-EnableBurstCapacity

用于指示是否在帐户上启用了突发容量的布尔值。

参数属性

类型:

Nullable<T>[Boolean]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-EnableFreeTier

用于指示是否在帐户上启用了 FreeTier 的布尔值。

参数属性

类型:

Nullable<T>[Boolean]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-EnableMultipleWriteLocations

启用多个写入位置。 接受的值:false、true

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-EnablePartitionMerge

用于指示是否在帐户上启用了 PartitionMerge 的布尔值。 接受的值:false、true

参数属性

类型:

Nullable<T>[Boolean]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-EnablePerRegionPerPartitionAutoscale

布尔值,指示是否在帐户上启用了动态缩放(按区域按分区自动缩放)。

参数属性

类型:

Nullable<T>[Boolean]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-EnablePriorityBasedExecution

用于指示是否在帐户上启用了基于优先级的执行的布尔值。

参数属性

类型:

Nullable<T>[Boolean]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-EnableVirtualNetwork

在 Cosmos DB 数据库帐户上启用虚拟网络。 接受的值:false、true

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-FromPointInTimeBackup

指示新的 Cosmos DB 帐户请求是还原请求。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-IpRule

防火墙支持。 以 CIDR 形式指定要作为给定数据库帐户的客户端 IP 允许列表包含的 IP 地址或 IP 地址范围集。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-KeyVaultKeyUri

KeyVault 的 URI

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Location

将位置添加到 Cosmos DB 数据库帐户。 字符串数组,按故障转移优先级排序。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-LocationObject

将位置添加到 Cosmos DB 数据库帐户。 PSLocation 对象的数组。

参数属性

类型:

PSLocation[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-MaxStalenessIntervalInSeconds

与有限过期一致性一起使用时,此值表示容忍的过期时间量(以时间跨度为单位)。 此值的接受范围为 5-86400。

参数属性

类型:

Nullable<T>[Int32]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-MaxStalenessPrefix

与有限过期一致性一起使用时,此值表示允许的过时请求数。 此值的接受范围为 1 - 2,147,483,647。

参数属性

类型:

Nullable<T>[Int32]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-MinimalTlsVersion

指示允许的最低 Tls 版本。 默认值为 Tls 1.2。 Cassandra 和 Mongo API 仅适用于 Tls 1.2。 可能的值包括:“Tls”、“Tls11”、“Tls12”。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Name

Cosmos DB 数据库帐户的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-NetworkAclBypass

是否为此帐户启用了 Synapse Link 的网络 Acl 旁路。 可能的值包括:“None”、“AzureServices”。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-NetworkAclBypassResourceId

允许 Synapse Link 的网络 Acl 绕过的资源 ID 列表。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PublicNetworkAccess

是否允许对此服务器使用公共终结点访问。 可能的值包括:“Enabled”、“Disabled”

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ResourceGroupName

资源组的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ServerVersion

ServerVersion 仅在 MongoDB 帐户的情况下有效。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Tag

标记的哈希表作为键值对。 使用空字符串清除现有标记。

参数属性

类型:Hashtable
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-VirtualNetworkRule

ACL 用于虚拟网络的字符串值的数组。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-VirtualNetworkRuleObject

虚拟网络的 PSVirtualNetworkRuleObjects 数组。

参数属性

类型:

PSVirtualNetworkRule[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

None

输出

PSDatabaseAccountGetResults