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

Test-AzKeyVaultManagedHsmNameAvailability

检查托管 hsm 名称是否有效且尚未使用。

语法

CheckExpanded (默认值)

Test-AzKeyVaultManagedHsmNameAvailability
    -Name <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [-Break]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CheckViaJsonFilePath

Test-AzKeyVaultManagedHsmNameAvailability
    -JsonFilePath <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [-Break]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CheckViaJsonString

Test-AzKeyVaultManagedHsmNameAvailability
    -JsonString <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [-Break]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

检查托管 hsm 名称是否有效且尚未使用。

示例

示例 1:测试未使用的 HSM 名称的可用性

Test-AzKeyVaultManagedHsmNameAvailability -Name testmhsm0818
Message NameAvailable Reason
------- ------------- ------
                 True

此命令测试保管库名称 testmhsm0818的可用性。 结果显示 testmhsm0818 未占用。

示例 2:测试已用 HSM 名称的可用性

Test-AzKeyVaultNameAvailability -Name testmhsm
Message                               NameAvailable Reason
-------                               ------------- ------
The name 'testmhsm' is already in use.         False AlreadyExists

此命令测试 HSM 名称 testmhsm的可用性。 结果显示 testmhsm 已在使用中。

参数

-Break

等待 .NET 调试器附加

参数属性

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

参数集

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

-Confirm

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

参数属性

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

参数集

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

-DefaultProfile

DefaultProfile 参数不起作用。 如果对其他订阅执行 cmdlet,请使用 SubscriptionId 参数。

参数属性

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

参数集

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

-HttpPipelineAppend

要追加到管道前面的 SendAsync 管道步骤

参数属性

类型:

SendAsyncStep[]

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

参数集

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

-HttpPipelinePrepend

要追加到管道前面的 SendAsync 管道步骤

参数属性

类型:

SendAsyncStep[]

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

参数集

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

-JsonFilePath

提供给检查操作的 Json 文件的路径

参数属性

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

参数集

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

-JsonString

提供给检查操作的 Json 字符串

参数属性

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

参数集

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

-Name

托管 hsm 名称。

参数属性

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

参数集

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

-Proxy

要使用的代理服务器的 URI

参数属性

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

参数集

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

-ProxyCredential

用于远程调用的代理服务器的凭据

参数属性

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

参数集

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

-ProxyUseDefaultCredentials

使用代理的默认凭据

参数属性

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

参数集

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

-SubscriptionId

唯一标识 azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。

参数属性

类型:String
默认值:(Get-AzContext).Subscription.Id
支持通配符: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

输出

ICheckMhsmNameAvailabilityResult