Udostępnij za pośrednictwem


Get-AzEventGridDomain

Pobiera szczegóły domeny usługi Event Grid lub pobiera listę wszystkich domen usługi Event Grid w bieżącej subskrypcji platformy Azure.

Składnia

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>]

Opis

Polecenie cmdlet Get-AzEventGridDomain pobiera szczegóły określonej domeny usługi Event Grid lub listę wszystkich domen usługi Event Grid w bieżącej subskrypcji platformy Azure. Jeśli podano nazwę domeny, zostaną zwrócone szczegóły pojedynczej domeny usługi Event Grid. Jeśli nazwa domeny nie zostanie podana, zostanie zwrócona lista domen. Liczba elementów zwracanych na tej liście jest kontrolowana przez parametr Top. Jeśli nie określono wartości Top lub $null, lista będzie zawierać wszystkie elementy domen zwrócone jednocześnie. W przeciwnym razie górna część będzie wskazywać maksymalną liczbę elementów, które mają być zwracane na liście. Jeśli więcej domen jest nadal dostępnych, wartość w aplikacji NextLink powinna być używana w następnym wywołaniu, aby uzyskać następną stronę domen. Na koniec parametr ODataQuery służy do filtrowania wyników wyszukiwania. Zapytanie filtrowania jest zgodne ze składnią OData tylko przy użyciu właściwości Name. Obsługiwane operacje obejmują: CONTAINS, eq (for equal), ne (for not equal), AND, OR i NOT.

Przykłady

Przykład 1

Pobiera szczegóły domeny usługi Event Grid "Domain1" w grupie zasobów "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]}

Przykład 2

Pobiera szczegóły domeny usługi Event Grid "Domain1" w grupie zasobów "MyResourceGroupName" przy użyciu opcji 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]}

Przykład 3

Wyświetl listę wszystkich domen usługi Event Grid w grupie zasobów "MyResourceGroupName" bez stronicowania (wszystkie domeny są zwracane w jednym zdjęciu)

$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              :

Przykład 4

Wyświetl listę domen usługi Event Grid (jeśli istnieje) w grupie zasobów "MyResourceGroupName", która spełnia $odataFilter zapytania 10 domen jednocześnie. Jeśli dostępnych jest więcej wyników, $result. Usługa NextLink nie będzie $null. Aby uzyskać kolejne strony domen, użytkownik powinien ponownie wywołać metodę Get-AzEventGridDomain i używa wyniku. NextLink uzyskany z poprzedniego wywołania. Obiekt wywołujący powinien zatrzymać się, gdy wynik. Polecenie NextLink staje się $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"

Przykład 5

Wyświetl listę wszystkich domen usługi Event Grid w subskrypcji platformy Azure bez stronicowania (wszystkie domeny są zwracane w jednym zdjęciu)

$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              :

Przykład 6

Wyświetl listę domen usługi Event Grid (jeśli istnieje) w subskrypcji platformy Azure, która spełnia $odataFilter zapytania o 20 domen jednocześnie. Jeśli dostępnych jest więcej wyników, $result. Usługa NextLink nie będzie $null. Aby uzyskać kolejne strony domen, użytkownik powinien ponownie wywołać metodę Get-AzEventGridDomain i używa wyniku. NextLink uzyskany z poprzedniego wywołania. Obiekt wywołujący powinien zatrzymać się, gdy wynik. Polecenie NextLink staje się $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"

Parametry

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

EventGrid nazwa domeny.

Type:String
Aliases:DomainName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Link do następnej strony zasobów, które mają zostać uzyskane. Ta wartość jest uzyskiwana przy użyciu pierwszego wywołania polecenia cmdlet Get-AzEventGrid, gdy więcej zasobów jest nadal dostępnych do odpytowania.

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

-ODataQuery

Zapytanie OData używane do filtrowania wyników listy. Filtrowanie jest obecnie dozwolone tylko dla właściwości Name. Obsługiwane operacje obejmują: CONTAINS, eq (for equal), ne (for not equal), AND, OR i NOT.

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

-ResourceGroupName

Nazwa grupy zasobów.

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

-ResourceId

Identyfikator zasobu reprezentujący domenę usługi Event Grid.

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

-Top

Maksymalna liczba zasobów do uzyskania. Prawidłowa wartość to od 1 do 100. Jeśli zostanie określona górna wartość, a więcej wyników będzie nadal dostępnych, wynik będzie zawierać link do następnej strony, do którego będzie odpytywane zapytanie w aplikacji NextLink. Jeśli nie określono wartości Top, pełna lista zasobów zostanie zwrócona jednocześnie.

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

Dane wejściowe

String

Dane wyjściowe

PSDomain

PSDomainListInstance