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

Get-AzCosmosDBAccountKey

获取给定 CosmosDB 帐户的密钥{“ConnectionKeys”、“PrimaryReadOnly”或“keys”}。

语法

ByNameParameterSet (默认值)

Get-AzCosmosDBAccountKey
    -ResourceGroupName <String>
    -Name <String>
    [-Type <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByResourceIdParameterSet

Get-AzCosmosDBAccountKey
    -ResourceId <String>
    [-Type <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByObjectParameterSet

Get-AzCosmosDBAccountKey
    -InputObject <PSDatabaseAccountGetResults>
    [-Type <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

说明

获取连接密钥的列表。

示例

示例 1

Get-AzCosmosDBAccountKey -ResourceGroupName rg1 -Name dbname -Type "ReadOnlyKeys"
Name                           Value
----                           -----
PrimaryReadonlyMasterKey       ********************************
SecondaryReadonlyMasterKey     ********************************

列出 CosmosDB 帐户的密钥。 键类型可以是 :ConnectionStrings、Keys 和 ReadOnlyKeys 的值。 默认值为密钥。

参数

-DefaultProfile

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

参数属性

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

参数集

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

-InputObject

CosmosDB Account 对象

参数属性

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

参数集

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

-Name

Cosmos DB 数据库帐户的名称。

参数属性

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

参数集

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

-ResourceGroupName

资源组的名称。

参数属性

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

参数集

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

-ResourceId

资源的 ResourceId。

参数属性

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

参数集

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

-Type

值来源:{ConnectionStrings、Keys、ReadOnlyKeys}。 默认值为密钥。

参数属性

类型:String
默认值: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

输出

Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountListConnectionStrings

Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountListKeysResult

Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountListReadOnlyKeysResult