次の方法で共有

Update-AzEventGridClient

  • リファレンス
モジュール:
Az.EventGrid

指定したパラメーターを使用してクライアントを更新します。

構文

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
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Attribute

クライアントの属性。 サポートされる値は int、bool、string、string[] です。例:"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }

型:Hashtable
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-AuthenticationName

認証のためにクライアントによって提示される名前。 既定値はリソースの名前です。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-CertificateSubjectCommonName

サブジェクト名の共通名フィールド。 使用できる制限は 64 文字で、指定する必要があります。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-CertificateSubjectCountryCode

サブジェクト名の国コード フィールド。 存在する場合は、ISO 2166-1 (アルファ 2) で定義された 2 文字のコードで国コードを表す必要があります。 たとえば、"US" です。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-CertificateSubjectOrganization

サブジェクト名の組織フィールド。 存在する場合、許可される制限は 64 文字です。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-CertificateSubjectOrganizationUnit

サブジェクト名の組織単位フィールド。 存在する場合、許可される制限は 32 文字です。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-CertificateThumbprintPrimary

検証に使用される主な拇印。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-CertificateThumbprintSecondary

検証に使用されるセカンダリ拇印。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ClientCertificateAuthenticationAllowedThumbprint

クライアント認証中に許可される拇印の一覧。 このプロパティは、validationScheme が 'ThumbprintMatch' の場合にのみ必要です。

型:String[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ClientCertificateAuthenticationValidationScheme

クライアントの認証に使用される検証スキーム。 既定値は SubjectMatchesAuthenticationName です。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DefaultProfile

DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

型:PSObject
Aliases:AzureRMContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Description

クライアント リソースの説明。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InputObject

IDENTITY パラメーター

型:IEventGridIdentity
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

クライアント名。

型:String
Aliases:ClientName
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-NamespaceInputObject

IDENTITY パラメーター

型:IEventGridIdentity
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-NamespaceName

名前空間の名前。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-NoWait

コマンドを非同期的に実行する

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ResourceGroupName

ユーザーのサブスクリプション内のリソース グループの名前。

型:String
Aliases:ResourceGroup
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-State

クライアントが有効かどうかを示します。 既定値は [有効] です。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-SubscriptionId

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。

型:String
配置:Named
規定値:(Get-AzContext).Subscription.Id
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

IEventGridIdentity

出力

IClient