Get-AzEventGridDomain

Ссылка

Модуль:: Az.EventGrid

Возвращает сведения о домене сетки событий или получает список всех доменов сетки событий в текущей подписке Azure.

Синтаксис

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

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

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

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

Описание

Командлет Get-AzEventGridDomain получает сведения о указанном домене сетки событий или список всех доменов сетки событий в текущей подписке Azure. Если указано доменное имя, возвращаются сведения о одном домене сетки событий. Если доменное имя не указано, возвращается список доменов. Количество элементов, возвращаемых в этом списке, управляется параметром Top. Если первое значение не указано или $null, список будет содержать все элементы доменов, возвращаемые одновременно. В противном случае в списке будет указано максимальное количество элементов, возвращаемых в списке. Если все еще доступно больше доменов, значение в NextLink должно использоваться в следующем вызове, чтобы получить следующую страницу доменов. Наконец, параметр ODataQuery используется для фильтрации результатов поиска. Запрос фильтрации следует синтаксису OData, используя только свойство Name. Поддерживаемые операции включают: CONTAINS, eq (for equal), ne (for not equal), AND, OR и NOT.

Примеры

Пример 1

Возвращает сведения о домене сетки событий Domain1 в группе ресурсов MyResourceGroupName.

Get-AzEventGridDomain -ResourceGroup MyResourceGroupName -Name Domain1

ResourceGroupName : MyResourceGroupName
DomainName        : Domain1
Id                : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname/providers/Microsoft.EventGrid/domains/domain1
Type              : Microsoft.EventGrid/domains
Location          : westus2
Endpoint          : https://domain1.westus2-1.eventgrid.azure.net/api/events
ProvisioningState : Succeeded
Tags              : {[Tag1, Value1], [Tag2, Value2]}

Пример 2

Возвращает сведения о домене сетки событий Domain1 в группе ресурсов MyResourceGroupName с помощью параметра ResourceId.

Get-AzEventGridDomain -ResourceId "/subscriptions/$subscriptionId/resourceGroups/MyResourceGroupName/providers/Microsoft.EventGrid/domains/Domain1"

ResourceGroupName : MyResourceGroupName
DomainName        : Domain1
Id                : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname/providers/Microsoft.EventGrid/domains/domain1
Type              : Microsoft.EventGrid/domains
Location          : westus2
Endpoint          : https://domain1.westus2-1.eventgrid.azure.net/api/events
ProvisioningState : Succeeded
Tags              : {[Tag1, Value1], [Tag2, Value2]}

Пример 3

Список всех доменов сетки событий в группе ресурсов MyResourceGroupName без разбиения на страницы (все домены возвращаются в одном снимке).

$result=Get-AzEventGridDomain -ResourceGroup MyResourceGroupName
Write-Output $result.PsDomainsList

ResourceGroupName : MyResourceGroupName
DomainName        : Domain1
Id                : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname/providers/Microsoft.EventGrid/domains/domain1
Type              : Microsoft.EventGrid/domains
Location          : westus2
Endpoint          : https://domain1.westus2-1.eventgrid.azure.net/api/events
ProvisioningState : Succeeded
Tags              : {[Tag1, Value1], [Tag2, Value2]}

ResourceGroupName : MyResourceGroupName
DomainName        : Domain2
Id                : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname/providers/Microsoft.EventGrid/domains/domain2
Type              : Microsoft.EventGrid/domains
Location          : westus2
Endpoint          : https://domain2.westus2-1.eventgrid.azure.net/api/events
ProvisioningState : Succeeded
Tags              :

ResourceGroupName : MyResourceGroupName
DomainName        : Domain3
Id                : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname/providers/Microsoft.EventGrid/domains/domain3
Type              : Microsoft.EventGrid/domains
Location          : westus2
Endpoint          : https://domain3.westus2-1.eventgrid.azure.net/api/events
ProvisioningState : Succeeded
Tags              : {[Tag3, Value3], [Tag4, Value4]}

ResourceGroupName : MyResourceGroupName
DomainName        : Domain4
Id                : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname/providers/Microsoft.EventGrid/domains/domain4
Type              : Microsoft.EventGrid/domains
Location          : westus2
Endpoint          : https://domain4.westus2-1.eventgrid.azure.net/api/events
ProvisioningState : Succeeded
Tags              :

Пример 4

Выведите список доменов сетки событий (если таковые) в группе ресурсов MyResourceGroupName, которая удовлетворяет $odataFilter доменам запроса 10 за раз. Если доступны дополнительные результаты, $result. NextLink не будет $null. Чтобы получить следующие страницы доменов, пользователь должен повторно вызвать Get-AzEventGridDomain и использовать результат. NextLink, полученный из предыдущего вызова. Вызывающий объект должен остановиться, когда результат. NextLink становится $null.

$total = 0
$odataFilter = "Name ne 'ABCD'"
$result = Get-AzEventGridDomain -ResourceGroup MyResourceGroupName -Top 10 -ODataQuery $odataFilter
$total += $result.Count
while ($null -ne $result.NextLink)
    {
        $result = Get-AzEventGridDomain -NextLink $result.NextLink
        $total += $result.Count
    }

Write-Output "Total number of domains is $Total"

Пример 5

Список всех доменов сетки событий в подписке Azure без разбиения на страницы (все домены возвращаются в одном снимке).

$result=Get-AzEventGridDomain
Write-Output $result.PsDomainsList

ResourceGroupName : MyResourceGroupName
DomainName        : Domain1
Id                : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname1/providers/Microsoft.EventGrid/domains/domain1
Type              : Microsoft.EventGrid/domains
Location          : westus2
Endpoint          : https://domain1.westus2-1.eventgrid.azure.net/api/events
ProvisioningState : Succeeded
Tags              : {[Tag1, Value1], [Tag2, Value2]}

ResourceGroupName : MyResourceGroupName
DomainName        : Domain2
Id                : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname1/providers/Microsoft.EventGrid/domains/domain2
Type              : Microsoft.EventGrid/domains
Location          : westus2
Endpoint          : https://domain2.westus2-1.eventgrid.azure.net/api/events
ProvisioningState : Succeeded
Tags              :

ResourceGroupName : MyResourceGroupName
DomainName        : Domain3
Id                : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname2/providers/Microsoft.EventGrid/domains/domain3
Type              : Microsoft.EventGrid/domains
Location          : westus2
Endpoint          : https://domain3.westus2-1.eventgrid.azure.net/api/events
ProvisioningState : Succeeded
Tags              : {[Tag3, Value3], [Tag4, Value4]}

ResourceGroupName : MyResourceGroupName
DomainName        : Domain4
Id                : /subscriptions/<Azure Subscription Id>/resourceGroups/myresourcegroupname3/providers/Microsoft.EventGrid/domains/domain4
Type              : Microsoft.EventGrid/domains
Location          : westus2
Endpoint          : https://domain4.westus2-1.eventgrid.azure.net/api/events
ProvisioningState : Succeeded
Tags              :

Пример 6

Перечислить домены сетки событий (если таковые есть) в подписке Azure, которая удовлетворяет $odataFilter запросам 20 доменов одновременно. Если доступны дополнительные результаты, $result. NextLink не будет $null. Чтобы получить следующие страницы доменов, пользователь должен повторно вызвать Get-AzEventGridDomain и использовать результат. NextLink, полученный из предыдущего вызова. Вызывающий объект должен остановиться, когда результат. NextLink становится $null.

$total = 0
$odataFilter = "Contains(Name, 'ABCD')"
$result = Get-AzEventGridDomain -Top 20 -ODataQuery $odataFilter
$total += $result.Count
while ($null -ne $result.NextLink)
    {
        $result = Get-AzEventGridDomain -NextLink $result.NextLink
        $total += $result.Count
    }
Write-Output "Total number of domains is $Total"

Параметры

-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:	DomainName
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 (for equal), ne (for not equal), 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

Идентификатор ресурса, представляющий домен сетки событий.

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

-Top

Максимальное количество полученных ресурсов. Допустимое значение составляет от 1 до 100. Если указано первое значение и все еще доступны дополнительные результаты, результат будет содержать ссылку на следующую страницу, чтобы запросить в NextLink. Если значение верхнего значения не указано, полный список ресурсов будет возвращен одновременно.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

Входные данные

String

Выходные данные

PSDomain

PSDomainListInstance