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

Update-AzEventGridClient

使用指定的参数更新客户端。

语法

Update-AzEventGridClient
      -Name <String>
      -NamespaceName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-Attribute <Hashtable>]
      [-AuthenticationName <String>]
      [-CertificateSubjectCommonName <String>]
      [-CertificateSubjectCountryCode <String>]
      [-CertificateSubjectOrganization <String>]
      [-CertificateSubjectOrganizationUnit <String>]
      [-CertificateThumbprintPrimary <String>]
      [-CertificateThumbprintSecondary <String>]
      [-ClientCertificateAuthenticationAllowedThumbprint <String[]>]
      [-ClientCertificateAuthenticationValidationScheme <String>]
      [-Description <String>]
      [-State <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridClient
      -Name <String>
      -NamespaceInputObject <IEventGridIdentity>
      [-Attribute <Hashtable>]
      [-AuthenticationName <String>]
      [-CertificateSubjectCommonName <String>]
      [-CertificateSubjectCountryCode <String>]
      [-CertificateSubjectOrganization <String>]
      [-CertificateSubjectOrganizationUnit <String>]
      [-CertificateThumbprintPrimary <String>]
      [-CertificateThumbprintSecondary <String>]
      [-ClientCertificateAuthenticationAllowedThumbprint <String[]>]
      [-ClientCertificateAuthenticationValidationScheme <String>]
      [-Description <String>]
      [-State <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzEventGridClient
      -InputObject <IEventGridIdentity>
      [-Attribute <Hashtable>]
      [-AuthenticationName <String>]
      [-CertificateSubjectCommonName <String>]
      [-CertificateSubjectCountryCode <String>]
      [-CertificateSubjectOrganization <String>]
      [-CertificateSubjectOrganizationUnit <String>]
      [-CertificateThumbprintPrimary <String>]
      [-CertificateThumbprintSecondary <String>]
      [-ClientCertificateAuthenticationAllowedThumbprint <String[]>]
      [-ClientCertificateAuthenticationValidationScheme <String>]
      [-Description <String>]
      [-State <String>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

使用指定的参数更新客户端。

示例

示例 1:创建具有指定参数的客户端。

$attribute = @{"room"="345";"floor"="3";"deviceTypes"="AC"}
Update-AzEventGridClient -Name azps-client -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid -Attribute $attribute -Description "This is a test client"

Name        ResourceGroupName
----        -----------------
azps-client azps_test_group_eventgrid

使用指定的参数创建客户端。

示例 2:使用指定的参数创建客户端。

$attribute = @{"room"="345";"floor"="3";"deviceTypes"="AC"}
$client = Get-AzEventGridClient -Name azps-client -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid
Update-AzEventGridClient -InputObject $client -Attribute $attribute -Description "This is a test client"

Name        ResourceGroupName
----        -----------------
azps-client azps_test_group_eventgrid

使用指定的参数创建客户端。

示例 3:创建具有指定参数的客户端。

$attribute = @{"room"="345";"floor"="3";"deviceTypes"="AC"}
$namespace = Get-AzEventGridNamespace -ResourceGroupName azps_test_group_eventgrid -Name azps-eventgridnamespace
Update-AzEventGridClient -Name azps-client -NamespaceInputObject $namespace -Attribute $attribute -Description "This is a test client"

Name        ResourceGroupName
----        -----------------
azps-client azps_test_group_eventgrid

使用指定的参数创建客户端。

参数

-AsJob

以作业身份运行命令

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Attribute

客户端的属性。 支持的值为 int、bool、string、string[]。示例:“attributes”: { “room”: “345”, “floor”: 12, “deviceTypes”: [“Fan”, “Light”] }

类型:Hashtable
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-AuthenticationName

客户端提供用于身份验证的名称。 默认值为资源的名称。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CertificateSubjectCommonName

主题名称中的公用名字段。 允许的限制为 64 个字符,应指定。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CertificateSubjectCountryCode

主题名称中的国家/地区代码字段。 如果存在,则国家/地区代码应由 ISO 2166-1(alpha-2)中定义的双字母代码表示。 例如:“US”。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CertificateSubjectOrganization

主题名称中的组织字段。 如果存在,则允许的限制为 64 个字符。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CertificateSubjectOrganizationUnit

主题名称中的组织单位字段。 如果存在,则允许的限制为 32 个字符。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CertificateThumbprintPrimary

用于验证的主要指纹。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-CertificateThumbprintSecondary

用于验证的辅助指纹。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ClientCertificateAuthenticationAllowedThumbprint

客户端身份验证期间允许的指纹列表。 仅当 validationScheme 为“ThumbprintMatch”时,才需要此属性。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ClientCertificateAuthenticationValidationScheme

用于对客户端进行身份验证的验证方案。 默认值为 SubjectMatchesAuthenticationName。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Confirm

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

类型:SwitchParameter
别名:cf
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DefaultProfile

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

类型:PSObject
别名:AzureRMContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Description

客户端资源的说明。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-InputObject

标识参数

类型:IEventGridIdentity
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-Name

客户端名称。

类型:String
别名:ClientName
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-NamespaceInputObject

标识参数

类型:IEventGridIdentity
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-NamespaceName

命名空间的名称。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-NoWait

异步运行命令

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ResourceGroupName

用户订阅中的资源组的名称。

类型:String
别名:ResourceGroup
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-State

指示客户端是否处于启用状态。 默认值为“已启用”。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SubscriptionId

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

类型:String
Position:Named
默认值:(Get-AzContext).Subscription.Id
必需:False
接受管道输入:False
接受通配符:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

IEventGridIdentity

输出

IClient