Get-AzEventGridTopic

リファレンス

モジュール:: Az.EventGrid

Event Grid トピックの詳細を取得するか、現在の Azure サブスクリプションのすべての Event Grid トピックの一覧を取得します。

構文

Get-AzEventGridTopic
   [[-ResourceGroupName] <String>]
   [-ODataQuery <String>]
   [-Top <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzEventGridTopic
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-ODataQuery <String>]
   [-Top <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzEventGridTopic
   [-ResourceId] <String>
   [-ODataQuery <String>]
   [-Top <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzEventGridTopic
   [-NextLink <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Get-AzEventGridTopic コマンドレットは、指定された Event Grid トピックの詳細、または現在の Azure サブスクリプション内のすべての Event Grid トピックの一覧を取得します。トピック名が指定されている場合は、1 つの Event Grid トピックの詳細が返されます。トピック名が指定されていない場合は、トピックの一覧が返されます。このリストで返される要素の数は、Top パラメーターによって制御されます。 Top 値が指定されていないか、$null場合、リストにはすべてのトピック項目が含まれます。それ以外の場合、Top は、リストで返される要素の最大数を示します。さらに多くのトピックを使用できる場合は、次の呼び出しで NextLink の値を使用して、トピックの次のページを取得する必要があります。最後に、ODataQuery パラメーターを使用して検索結果のフィルター処理を実行します。フィルター処理クエリは、Name プロパティのみを使用する OData 構文に従います。サポートされる操作には、CONTAINS、eq (等しい)、ne (等しくない場合)、AND、OR、NOT が含まれます。

例

例 1

Get-AzEventGridTopic -ResourceGroup MyResourceGroupName -Name Topic1

リソースグループ 'MyResourceGroupName' の Event Grid トピック 'Topic1' の詳細を取得します。

例 2

Get-AzEventGridTopic -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/topics/Topic1"

リソースグループ 'MyResourceGroupName' の Event Grid トピック 'Topic1' の詳細を取得します。

例 3

Get-AzEventGridTopic -ResourceGroup MyResourceGroupName

リソースグループ 'MyResourceGroupName' のすべての Event Grid トピックを改ページなしで一覧表示します。

例 4

$odataFilter = "Name ne 'ABCD'"
$result = Get-AzEventGridTopic -ResourceGroup MyResourceGroupName -Top 10 -ODataQuery $odataFilter
Get-AzEventGridTopic $result.NextLink

$odataFilter クエリを満たすリソースグループ 'MyResourceGroupName' の最初の 10 個の Event Grid トピック (存在する場合) を一覧表示します。さらに多くの結果が得られている場合は、$result。NextLink は$nullされません。トピックの次のページを取得するために、ユーザーは Get-AzEventGridTopic を再呼び出しし、結果を使用する必要があります。前の呼び出しから取得した NextLink。呼び出し元は、結果が返されたときに停止する必要があります。NextLink が$nullになります。

例 5

Get-AzEventGridTopic

改ページせずに、サブスクリプション内のすべての Event Grid トピックを一覧表示します。

例 6

$odataFilter = "Name ne 'ABCD'"
$result = Get-AzEventGridTopic -Top 10 -ODataQuery $odataFilter
Get-AzEventGridTopic $result.NextLink

$odataFilter クエリを満たすサブスクリプション内の最初の 10 個の Event Grid トピック (存在する場合) を一覧表示します。さらに多くの結果が得られている場合は、$result。NextLink は$nullされません。トピックの次のページを取得するために、ユーザーは Get-AzEventGridTopic を再呼び出しし、結果を使用する必要があります。前の呼び出しから取得した 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

-Name

EventGrid トピック名。

Type:	String
Aliases:	TopicName
Position:	1
Default value:	None
Required:	True
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:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceId

Event Grid トピックを表すリソース識別子。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Top

取得するリソースの最大数。有効な値は 1 ~ 100 です。上位の値が指定され、さらに多くの結果が使用できる場合、結果には NextLink でクエリを実行する次のページへのリンクが含まれます。 Top 値が指定されていない場合、リソースの完全な一覧が一度に返されます。

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

入力

String

Nullable<T>[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

出力

PSTopic

PSTopicListInstance