Get-AzEventGridSubscription
イベント サブスクリプションの詳細を取得するか、現在の Azure サブスクリプション内のすべてのイベント サブスクリプションの一覧を取得します。
構文
Get-AzEventGridSubscription
[-EventSubscriptionName <String>]
[-ResourceGroupName <String>]
[-TopicName <String>]
[-IncludeFullEndpointUrl]
[-ODataQuery <String>]
[-Top <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzEventGridSubscription
[-EventSubscriptionName <String>]
[-ResourceId] <String>
[-IncludeFullEndpointUrl]
[-ODataQuery <String>]
[-Top <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzEventGridSubscription
[-EventSubscriptionName <String>]
[-ResourceGroupName <String>]
[-DomainName <String>]
[-DomainTopicName <String>]
[-IncludeFullEndpointUrl]
[-ODataQuery <String>]
[-Top <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzEventGridSubscription
[-ResourceGroupName <String>]
[-TopicTypeName <String>]
[-Location <String>]
[-IncludeFullEndpointUrl]
[-ODataQuery <String>]
[-Top <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzEventGridSubscription
[-InputObject] <PSTopic>
[-ODataQuery <String>]
[-Top <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzEventGridSubscription
[-DomainInputObject] <PSDomain>
[-ODataQuery <String>]
[-Top <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzEventGridSubscription
[-DomainTopicInputObject] <PSDomainTopic>
[-ODataQuery <String>]
[-Top <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzEventGridSubscription
[-NextLink <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Get-AzEventGridSubscription コマンドレットは、指定された Event Grid サブスクリプションの詳細、または現在の Azure サブスクリプションまたはリソース グループ内のすべての Event Grid サブスクリプションの一覧を取得します。 イベント サブスクリプション名が指定されている場合は、1 つの Event Grid サブスクリプションの詳細が返されます。 イベント サブスクリプション名が指定されていない場合は、すべてのイベント サブスクリプションの一覧が返されます。 このリストで返される要素の数は、Top パラメーターによって制御されます。 Top 値が指定されていないか、$null場合、リストにはすべてのイベント サブスクリプション 項目が含まれます。 それ以外の場合、Top は、リストで返される要素の最大数を示します。 さらに多くのイベント サブスクリプションが使用可能な場合は、次の呼び出しで NextLink の値を使用して、イベント サブスクリプションの次のページを取得する必要があります。 最後に、ODataQuery パラメーターを使用して検索結果のフィルター処理を実行します。 フィルター 処理クエリは、Name プロパティのみを使用する OData 構文に従います。 サポートされる操作には、CONTAINS、eq (等しい)、ne (等しくない場合)、AND、OR、NOT が含まれます。
例
例 1
Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 -EventSubscriptionName EventSubscription1
リソース グループ 'MyResourceGroupName' のトピック 'Topic1' に対して作成されたイベント サブスクリプション 'EventSubscription1' の詳細を取得します。
例 2
Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 -EventSubscriptionName EventSubscription1 -IncludeFullEndpointUrl
リソース グループ 'MyResourceGroupName' のトピック 'Topic1' に対して作成されたイベント サブスクリプション 'EventSubscription1' の詳細を取得します。Webhook ベースのイベント サブスクリプションの場合は、完全なエンドポイント URL も含まれます。
例 3
Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1
リソース グループ 'MyResourceGroupName' のトピック 'Topic1' に対して作成されたすべてのイベント サブスクリプションの一覧を、改ページなしで取得します。
例 4
$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 -Top 10 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink
$odataFilter クエリを満たすリソース グループ 'MyResourceGroupName' のトピック 'Topic1' に対して作成された最初の 10 個のイベント サブスクリプション (存在する場合) を一覧表示します。 さらに多くの結果が得られている場合は、$result。NextLink は$nullされません。 イベント サブスクリプションの次のページを取得するために、ユーザーは Get-AzEventGridSubscription を再呼び出しし、結果を使用する必要があります。前の呼び出しから取得した NextLink。 呼び出し元は、結果が返されたときに停止する必要があります。NextLink が$nullになります。
例 5
Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -EventSubscriptionName EventSubscription1
リソース グループ 'MyResourceGroupName' に対して作成されたイベント サブスクリプション 'EventSubscription1' の詳細を取得します。
例 6
Get-AzEventGridSubscription -EventSubscriptionName EventSubscription1
現在選択されている Azure サブスクリプションに対して作成されたイベント サブスクリプション 'EventSubscription1' の詳細を取得します。
例 7
Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName
改ページなしでリソース グループ 'MyResourceGroupName' の下に作成されたすべてのグローバル イベント サブスクリプションの一覧を取得します。
例 8
$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -Top 5 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink
$odataFilter クエリを満たすリソース グループ 'MyResourceGroupName' の下に作成された最初の 5 つのイベント サブスクリプション (存在する場合) を一覧表示します。 さらに多くの結果が得られている場合は、$result。NextLink は$nullされません。 イベント サブスクリプションの次のページを取得するために、ユーザーは Get-AzEventGridSubscription を再呼び出しし、結果を使用する必要があります。前の呼び出しから取得した NextLink。 呼び出し元は、結果が返されたときに停止する必要があります。NextLink が$nullになります。
例 9
Get-AzEventGridSubscription
現在選択されている Azure サブスクリプションの下に作成されたすべてのグローバル イベント サブスクリプションの一覧を、改ページなしで取得します。
例 10
$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -Top 15 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink
$odataFilter クエリを満たす、現在選択されている Azure サブスクリプションの下に作成された最初の 15 個のグローバル イベント サブスクリプション (存在する場合) を一覧表示します。 さらに多くの結果が得られている場合は、$result。NextLink は$nullされません。 イベント サブスクリプションの次のページを取得するために、ユーザーは Get-AzEventGridSubscription を再呼び出しし、結果を使用する必要があります。前の呼び出しから取得した NextLink。 呼び出し元は、結果が返されたときに停止する必要があります。NextLink が$nullになります。
例 11
Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -Location westus2
指定した場所 'westus2' のリソース グループ 'MyResourceGroupName' の下に作成されたすべてのリージョン イベント サブスクリプションの一覧を、改ページなしで取得します。
例 12
$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -Location westus2 -Top 15 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink
指定した場所 'westus2' のリソース グループ 'MyResourceGroupName' の下に作成された最初の 15 個のリージョン イベント サブスクリプション (存在する場合) を一覧表示$odataFilterクエリを満たします。 さらに多くの結果が得られている場合は、$result。NextLink は$nullされません。 イベント サブスクリプションの次のページを取得するために、ユーザーは Get-AzEventGridSubscription を再呼び出しし、結果を使用する必要があります。前の呼び出しから取得した NextLink。 呼び出し元は、結果が返されたときに停止する必要があります。NextLink が$nullになります。
例 13
Get-AzEventGridSubscription -ResourceId "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.EventHub/namespaces/$namespaceName"
指定した EventHub 名前空間に対して作成されたすべてのイベント サブスクリプションの一覧を、改ページなしで取得します。
例 14
$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -ResourceId "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.EventHub/namespaces/$namespaceName" -Top 25 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink
$odataFilter クエリを満たす、指定した EventHub 名前空間用に作成された最初の 25 個のイベント サブスクリプション (存在する場合) を一覧表示します。 さらに多くの結果が得られている場合は、$result。NextLink は$nullされません。 イベント サブスクリプションの次のページを取得するために、ユーザーは Get-AzEventGridSubscription を再呼び出しし、結果を使用する必要があります。前の呼び出しから取得した NextLink。 呼び出し元は、結果が返されたときに停止する必要があります。NextLink が$nullになります。
例 15
Get-AzEventGridSubscription -TopicTypeName "Microsoft.EventHub.Namespaces" -Location $location
指定した場所にある指定したトピックの種類 (EventHub 名前空間) に対して作成されたすべてのイベント サブスクリプションの一覧を、改ページなしで取得します。
例 16
$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -TopicTypeName "Microsoft.EventHub.Namespaces" -Location $location -Top 15 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink
指定したトピックの種類 (EventHub 名前空間) に対して作成された最初の 15 個のイベント サブスクリプション (存在する場合) を、$odataFilterクエリを満たす指定した場所に一覧表示します。 さらに多くの結果が得られている場合は、$result。NextLink は$nullされません。 イベント サブスクリプションの次のページを取得するために、ユーザーは Get-AzEventGridSubscription を再呼び出しし、結果を使用する必要があります。前の呼び出しから取得した NextLink。 呼び出し元は、結果が返されたときに停止する必要があります。NextLink が$nullになります。
例 17
Get-AzEventGridSubscription -TopicTypeName "Microsoft.Resources.ResourceGroups" -ResourceGroupName MyResourceGroupName
改ページなしで特定のリソース グループに対して作成されたすべてのイベント サブスクリプションの一覧を取得します。
例 18
$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -TopicTypeName "Microsoft.Resources.ResourceGroups" -ResourceGroupName MyResourceGroupName -Top 100 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink
$odataFilter クエリを満たす特定のリソース グループに対して作成された最初の 100 個のイベント サブスクリプション (存在する場合) を一覧表示します。 さらに多くの結果が得られている場合は、$result。NextLink は$nullされません。 イベント サブスクリプションの次のページを取得するために、ユーザーは Get-AzEventGridSubscription を再呼び出しし、結果を使用する必要があります。前の呼び出しから取得した NextLink。 呼び出し元は、結果が返されたときに停止する必要があります。NextLink が$nullになります。
パラメーター
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DomainInputObject
EventGrid Doメイン オブジェクト。
Type: | PSDomain |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DomainName
EventGrid doメイン name。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DomainTopicInputObject
EventGrid Doメイン Topic オブジェクト。
Type: | PSDomainTopic |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DomainTopicName
EventGrid のトピック名メインします。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-EventSubscriptionName
イベント サブスクリプションの名前
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-IncludeFullEndpointUrl
イベント サブスクリプションの宛先の完全なエンドポイント URL を含めます。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
EventGrid Topic オブジェクト。
Type: | PSTopic |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Location
場所
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NextLink
取得するリソースの次のページのリンク。 この値は、さらに多くのリソースを照会できる場合に、最初の Get-AzEventGrid コマンドレット呼び出しで取得されます。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ODataQuery
リストの結果をフィルター処理するために使用される OData クエリ。 現在、フィルター処理は Name プロパティでのみ許可されています。サポートされる操作には、CONTAINS、eq (等しい)、ne (等しくない場合)、AND、OR、NOT が含まれます。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
リソース グループ名。
Type: | String |
Aliases: | ResourceGroup |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceId
イベント サブスクリプションが作成されたリソースの識別子。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Top
リストの結果をフィルター処理するために使用される OData クエリ。 現在、フィルター処理は Name プロパティでのみ許可されています。サポートされる操作には、CONTAINS、eq (等しい)、ne (等しくない場合)、AND、OR、NOT が含まれます。
Type: | Nullable<T>[Int32] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TopicName
EventGrid トピック名。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TopicTypeName
TopicType 名
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
入力
Nullable<T>[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]