Update-AzEventGridDomain

モジュール:

Az.EventGrid

指定したパラメーターを使用して新しいドメインを非同期に更新します。

構文

Update-AzEventGridDomain
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-AutoCreateTopicWithFirstSubscription]
      [-AutoDeleteTopicWithLastSubscription]
      [-DataResidencyBoundary <String>]
      [-DisableLocalAuth]
      [-EnableSystemAssignedIdentity <Boolean>]
      [-EventTypeInfoInlineEventType <Hashtable>]
      [-EventTypeInfoKind <String>]
      [-IdentityPrincipalId <String>]
      [-IdentityTenantId <String>]
      [-InboundIPRule <IInboundIPRule[]>]
      [-InputSchema <String>]
      [-Location <String>]
      [-MinimumTlsVersionAllowed <String>]
      [-PublicNetworkAccess <String>]
      [-SkuName <String>]
      [-Tag <Hashtable>]
      [-UserAssignedIdentity <String[]>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzEventGridDomain
      -InputObject <IEventGridIdentity>
      [-AutoCreateTopicWithFirstSubscription]
      [-AutoDeleteTopicWithLastSubscription]
      [-DataResidencyBoundary <String>]
      [-DisableLocalAuth]
      [-EnableSystemAssignedIdentity <Boolean>]
      [-EventTypeInfoInlineEventType <Hashtable>]
      [-EventTypeInfoKind <String>]
      [-IdentityPrincipalId <String>]
      [-IdentityTenantId <String>]
      [-InboundIPRule <IInboundIPRule[]>]
      [-InputSchema <String>]
      [-Location <String>]
      [-MinimumTlsVersionAllowed <String>]
      [-PublicNetworkAccess <String>]
      [-SkuName <String>]
      [-Tag <Hashtable>]
      [-UserAssignedIdentity <String[]>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

指定したパラメーターを使用して新しいドメインを非同期に更新します。

例

例 1: 指定されたパラメーターを使用してドメインを非同期に更新します。

$inboundIpRule = New-AzEventGridInboundIPRuleObject -Action Allow -IPMask "12.18.176.1"
Update-AzEventGridDomain -Name azps-domain -ResourceGroupName azps_test_group_eventgrid -PublicNetworkAccess Enabled -InboundIPRule $inboundIpRule

Location Name        ResourceGroupName
-------- ----        -----------------
westus2  azps-domain azps_test_group_eventgrid

指定したパラメーターを使用してドメインを非同期的に更新します。

パラメーター

-AsJob

コマンドをジョブとして実行する

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

-AutoCreateTopicWithFirstSubscription

このブール値は、この Event Grid ドメイン リソースに関連付けられている Event Grid ドメイン トピックの作成メカニズムを 'all' に指定するために使用されます。このコンテキストでは、ドメイン トピックの作成は、自動管理 (true の場合) または自己管理 (false の場合) にすることができます。 このプロパティの既定値は true です。このプロパティが null または true に設定されている場合、Event Grid は、ドメイン トピックのスコープで最初のイベント サブスクリプションが作成されたときに、ドメイン トピックを自動的に作成します。 このプロパティが false に設定されている場合、最初のイベント サブスクリプションを作成するには、ユーザーによるドメイン トピックを作成する必要があります。 自己管理モードは、ユーザーがドメイン トピックの作成時を完全に制御する必要がある場合に使用できます。一方、自動管理モードでは、より少ない操作を実行し、ユーザーが管理するリソースを減らすことができる柔軟性が提供されます。 また、自動管理作成モードでは、ユーザーは必要に応じてオンデマンドで thedomain トピックを作成できます。

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

-AutoDeleteTopicWithLastSubscription

このブール値は、この Event Grid ドメイン リソースに関連付けられている Event Grid ドメイン トピックの削除メカニズムを 'all' に指定するために使用されます。このコンテキストでは、ドメイン トピックの削除は、自動管理 (true の場合) または自己管理 (false の場合) にすることができます。 このプロパティの既定値は true です。このプロパティが true に設定されている場合、Event Grid は、ドメイン トピックのスコープにある最後のイベント サブスクリプションが削除されたときに、ドメイン トピックを自動的に削除します。 このプロパティが false に設定されている場合、ユーザーは必要なくなったドメイン トピックを手動で削除する必要があります (たとえば、最後のイベント サブスクリプションが削除され、リソースをクリーンアップする必要がある場合)。 自己管理モードは、ユーザーがドメイン トピックを削除する必要があるタイミングを完全に制御する必要がある場合に使用できます。一方、自動管理モードでは、より少ない操作を実行し、ユーザーが管理するリソースを減らすことができる柔軟性が提供されます。

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

-Confirm

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

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

-DataResidencyBoundary

リソースのデータ所在地の境界。

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

-DefaultProfile

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

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

-DisableLocalAuth

このブール値は、ローカル認証を有効または無効にするために使用されます。既定値は false です。 プロパティが true に設定されている場合、ユーザーがドメインへの発行を許可されている場合は、AAD トークンのみが認証に使用されます。

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

-EnableSystemAssignedIdentity

リソースに対してシステム割り当て ID を有効にするかどうかを決定します。

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

-EventTypeInfoInlineEventType

リソースのインライン イベントの種類のコレクション。 インライン イベント型キーは、イベントの名前を表す文字列型です。有効なインライン イベント名の例として、"Contoso.OrderCreated" があります。インライン イベント型の値は InlineEventProperties 型であり、すべてのインライン イベントの種類に関する追加情報が含まれます。

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

-EventTypeInfoKind

使用されるイベントの種類。

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

-IdentityPrincipalId

リソース ID のプリンシパル ID。

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

-IdentityTenantId

リソースのテナント ID。

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

-InboundIPRule

これは、すべての IP ではなく、特定の IP からのトラフィックを制限するために使用できます。 注: これらは、PublicNetworkAccess が有効になっている場合にのみ考慮されます。

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

-InputObject

IDENTITY パラメーター

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

-InputSchema

これにより、Event Grid ドメイン リソースに発行された受信イベントに対して Event Grid で想定される形式が決まります。

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

-Location

リソースの場所。

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

-MinimumTlsVersionAllowed

このドメインへの発行が許可されている発行元の最小 TLS バージョン

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

-Name

ドメインの名前。

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

-NoWait

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

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

-PassThru

コマンドが成功したときに true を返します。

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

-PublicNetworkAccess

これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />

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

-ResourceGroupName

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

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

-SkuName

リソースの SKU 名。 使用できる値は Basic または Premium です。

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

-SubscriptionId

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

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

-Tag

リソースのタグ。

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

-UserAssignedIdentity

リソースに関連付けられているユーザー割り当て ID の配列。 配列内の要素は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

入力

IEventGridIdentity

出力

IDomain