Update-AzEventGridClient
指定したパラメーターを使用してクライアントを更新します。
構文
UpdateExpanded (既定)
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>]
UpdateViaIdentityNamespaceExpanded
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>]
UpdateViaIdentityExpanded
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
コマンドをジョブとして実行する
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Attribute
クライアントの属性。
サポートされる値は int、bool、string、string[] です。例:"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }
パラメーターのプロパティ
| 型: | Hashtable
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-AuthenticationName
認証のためにクライアントによって提示される名前。
既定値はリソースの名前です。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CertificateSubjectCommonName
サブジェクト名の共通名フィールド。
使用できる制限は 64 文字で、指定する必要があります。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CertificateSubjectCountryCode
サブジェクト名の国コード フィールド。
存在する場合は、ISO 2166-1 (アルファ 2) で定義された 2 文字のコードで国コードを表す必要があります。
たとえば、"US" です。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CertificateSubjectOrganization
サブジェクト名の組織フィールド。
存在する場合、許可される制限は 64 文字です。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CertificateSubjectOrganizationUnit
サブジェクト名の組織単位フィールド。
存在する場合、許可される制限は 32 文字です。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CertificateThumbprintPrimary
検証に使用される主な拇印。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-CertificateThumbprintSecondary
検証に使用されるセカンダリ拇印。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ClientCertificateAuthenticationAllowedThumbprint
クライアント認証中に許可される拇印の一覧。
このプロパティは、validationScheme が 'ThumbprintMatch' の場合にのみ必要です。
パラメーターのプロパティ
| 型: | String[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ClientCertificateAuthenticationValidationScheme
クライアントの認証に使用される検証スキーム。
既定値は SubjectMatchesAuthenticationName です。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DefaultProfile
DefaultProfile パラメーターは機能しません。
別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。
パラメーターのプロパティ
| 型: | PSObject
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Description
クライアント リソースの説明。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
IDENTITY パラメーター
UpdateViaIdentityExpanded
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
クライアント名。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | クライアント名 |
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
UpdateViaIdentityNamespaceExpanded
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
IDENTITY パラメーター
UpdateViaIdentityNamespaceExpanded
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-NamespaceName
名前空間の名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-NoWait
コマンドを非同期的に実行する
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
ユーザーのサブスクリプション内のリソース グループの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | リソースグループ （ResourceGroup） |
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-State
クライアントが有効かどうかを示します。
既定値は [有効] です。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SubscriptionId
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。
サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | (Get-AzContext).Subscription.Id |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UpdateExpanded
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。
コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
出力
