az eventgrid event-subscription
Správa odběrů událostí
Umožňuje spravovat odběry událostí pro téma event Gridu, doménu, téma domény, Azure odběr, skupinu prostředků nebo jakýkoli jiný prostředek Azure, který podporuje oznámení událostí.
Příkazy
| Name | Description | Typ | Stav |
|---|---|---|---|
| az eventgrid event-subscription create |
Vytvořte nové odběry událostí. |
Core | GA |
| az eventgrid event-subscription delete |
Odstranění odběru událostí |
Core | GA |
| az eventgrid event-subscription list |
Výpis odběrů událostí |
Core | GA |
| az eventgrid event-subscription show |
Získejte podrobnosti o odběru událostí. |
Core | GA |
| az eventgrid event-subscription update |
Aktualizace odběru událostí |
Core | GA |
az eventgrid event-subscription create
Vytvořte nové odběry událostí.
az eventgrid event-subscription create --name
[--aad-tenant-id --azure-active-directory-tenant-id]
[--acquire-policy-token]
[--advanced-filter]
[--azure-active-directory-application-id-or-uri]
[--change-reference]
[--deadletter-endpoint]
[--deadletter-identity {systemassigned}]
[--deadletter-identity-endpoint]
[--delivery-attribute-mapping]
[--delivery-identity {systemassigned}]
[--delivery-identity-endpoint]
[--delivery-identity-endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
[--enable-advanced-filtering-on-arrays --enable-af-arr {false, true}]
[--endpoint]
[--endpoint-type]
[--event-delivery-schema {cloudeventschemav1_0, custominputschema, eventgridschema}]
[--event-ttl]
[--expiration-date]
[--included-event-types]
[--labels]
[--max-delivery-attempts]
[--max-events-per-batch]
[--preferred-batch-size-in-kilobytes]
[--qttl --storage-queue-msg-ttl]
[--source-resource-id]
[--subject-begins-with]
[--subject-case-sensitive {false, true}]
[--subject-ends-with]
Příklady
Vytvořte nové odběry událostí pro téma Event Gridu pomocí výchozích filtrů.
az eventgrid event-subscription create --name es1 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
Vytvořte nové odběry událostí pro předplatné Azure pomocí výchozích filtrů.
az eventgrid event-subscription create --name es2 \
--source-resource-id /subscriptions/{SubID} \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
Vytvořte nové odběry událostí pro skupinu prostředků pomocí výchozích filtrů.
az eventgrid event-subscription create --name es3 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG} \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
Vytvořte nové odběry událostí pro účet úložiště pomocí výchozích filtrů.
az eventgrid event-subscription create --name es3 \
--source-resource-id "/subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Storage/storageaccounts/s1" \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
Vytvořte nové odběry událostí pro účet úložiště pomocí rozšířených filtrů.
az eventgrid event-subscription create --name es3 \
--source-resource-id "/subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Storage/storageaccounts/s1" \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
--advanced-filter data.blobType StringIn BlockBlob
--advanced-filter data.url StringBeginsWith https://myaccount.blob.core.windows.net
Vytvořte nové odběry událostí pro Azure předplatné s filtrem určujícím předponu předmětu.
az eventgrid event-subscription create --name es4 \
--source-resource-id /subscriptions/{SubID} \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \
--subject-begins-with mysubject_prefix
Vytvořte nové odběry událostí pro skupinu prostředků s filtrem určujícím příponu předmětu.
az eventgrid event-subscription create --name es5 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG} \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \
--subject-ends-with mysubject_suffix
Vytvořte nové odběry událostí pro Azure předplatné, použijte výchozí filtry a jako cíl EventHub.
az eventgrid event-subscription create --name es2 \
--source-resource-id /subscriptions/{SubID} \
--endpoint-type eventhub \
--endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/n1/eventhubs/EH1
Vytvořte nové odběry událostí pro Azure předplatné, použijte výchozí filtry a frontu Azure Storage jako cíl.
az eventgrid event-subscription create --name es2 \
--source-resource-id /subscriptions/{SubID} \
--endpoint-type storagequeue \
--endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1
Vytvořte nové odběry událostí pro Azure předplatné, použijte výchozí filtry a jako cíl Azure ServiceBusQueue.
az eventgrid event-subscription create --name es2 \
--source-resource-id /subscriptions/{SubID} \
--endpoint-type servicebusqueue \
--endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ns1/queues/queue1
Vytvořte nové odběry událostí pro doménu Event Gridu s použitím výchozích filtrů a cloudEvent verze 1.0 jako schématu doručení.
az eventgrid event-subscription create --name es2 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/domains/d1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \
--event-delivery-schema cloudeventschemav1_0
Vytvořte nové odběry událostí pro účet úložiště s cílem deadletteru a vlastní zásadou opakování s maximálním počtem 10 pokusů o doručení a 2 hodinovou hodnotu TTL události (podle toho, co nastane dříve).
az eventgrid event-subscription create --name es2 \
--source-resource-id "/subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Storage/storageaccounts/s1" \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \
--deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/s2/blobServices/default/containers/blobcontainer1 \
--max-delivery-attempts 10 --event-ttl 120
Vytvořte nové odběry událostí pro téma domény.
az eventgrid event-subscription create --name es2 \
--source-resource-id "/subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/domains/domain1/topics/t1" \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
Vytvořte nové předplatné události (pro účet úložiště) s datem vypršení platnosti.
az eventgrid event-subscription create --name es2 \
--source-resource-id "/subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Storage/storageaccounts/sa1" \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
--expiration-date "2018-10-31"
Vytvoření nového odběru událostí pro téma Event Gridu pomocí Azure Active Directory povoleno Webhook jako cíl .
az eventgrid event-subscription create --name es1 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
--azure-active-directory-tenant-id azureactivedirectorytenantid
--azure-active-directory-application-id-or-uri azureactivedirectoryapplicationidoruri
Vytvořte nové odběry událostí pro téma Event Gridu pomocí funkce Azure jako cíle.
az eventgrid event-subscription create --name es1 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1 \
--endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction
Vytvoření nového odběru událostí pro téma Event Gridu s využitím EventHubu s identitou MSI přiřazenou systémem jako cílem a deadletterem s identitou MSI
az eventgrid event-subscription create --source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1 \
--delivery-identity-endpoint-type eventhub --delivery-identity systemassigned --delivery-identity-endpoint /subscriptions/{SubId2|}/resourceGroups/{RG2}/providers/Microsoft.eventhub/namespaces/{EventHubNamespace}/eventhubs/{EventhubName} \
--deadletter-identity-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/s2/blobServices/default/containers/blobcontainer1 --deadletter-identity systemassigned -n {EventSubscriptionName}
Vytvoření nového odběru událostí pro téma Event Gridu s využitím fronty úložiště jako cíle se zprávou ttl během 5 minut
az eventgrid event-subscription create -n es1 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1
--endpoint-type storagequeue \
--endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1 \
--storage-queue-msg-ttl 300
Vytvoření nového odběru událostí pro téma Event Gridue s využitím služby StorageQueue s identitou MSI přiřazenou systémem jako cílem
az eventgrid event-subscription create -n {EventSubscriptionName} --source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1 \
--delivery-identity-endpoint-type StorageQueue --delivery-identity systemassigned --delivery-identity-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1 \
--storage-queue-msg-ttl 300
Vytvoření nového odběru událostí pro téma Event Gridu s povoleným rozšířeným filtrováním u polí
az eventgrid event-subscription create -n es1 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1
--endpoint-type storagequeue \
--endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1 \
--enable-advanced-filtering-on-arrays true
Povinné parametry
Název odběru události.
Volitelné parametry
Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.
ID tenanta Azure Active Directory k získání přístupového tokenu, který bude zahrnut jako nosný token v žádostech o doručení. Platí pouze pro webhook jako cíl.
Získání tokenu Azure Policy automaticky pro tuto operaci prostředku
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
Rozšířený filtr umožňuje filtrování událostí na základě konkrétní vlastnosti události.
Použití: --advanced-filter KEY[. INNERKEY] FILTEROPERATOR VALUE [VALUE ...] StringIn: --advanced-filter data. Color StringIn Blue Red Orange Yellow StringNotIn: --advanced-filter data. Color StringNotIn Blue Orange Yellow StringContains: --advanced-filter subject StringContains Blue Red StringNotContains: --advanced-filter subject StringNotContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringNotBeginssWith: --advanced-filter subject StringNotBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg StringNotEndsWith: --advanced-filter subject StringNotEndsWith img png numberIn: --advanced-filter data.property1 NumberIn 5 10 20 NumberInRange --advanced-filter data.property1 NumberInRange 5,10 20,30 40,50 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 NumberNotInRange: --advanced-filter data.property2 ČísloNotInRange 100 110 200 210 300 310 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --advanced-filter data.property3 NumberGreaterThan 100 NumberGreaterThanOrEquals: --advanced-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --advanced-filter data.property3 BoolEquals true IsNullOrUndefined: --advanced-filter data.property3 IsNullOrUndefined IsNotNull: --advanced-filter data.property3 IsNotNull Více rozšířených filtrů lze zadat pomocí více než jednoho argumentu --advanced-filter.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Filtering Arguments |
Id aplikace Azure Active Directory nebo identifikátor URI pro získání přístupového tokenu, který bude zahrnut jako nosný token v žádostech o doručení. Platí pouze pro webhook jako cíl.
Související referenční ID odkazu na změnu pro tuto operaci prostředku.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
ID prostředku Azure cíle kontejneru objektů blob Azure Storage, kde by EventGrid měl pro toto odběr událostí zrušit nedoručitelné události.
Příklad: --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. Storage/storageAccounts/sa1/blobServices/default/containers/containerName.
Typ identity cílového prostředku deadletter.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | systemassigned |
ID Azure prostředku cílového kontejneru objektů blob Azure Storage s identitou, ve které by EventGrid měla zrušit nedoručitelné události pro toto odběry událostí.
Přidání mapování atributů doručení pro odesílání dalších informací prostřednictvím hlaviček HTTP při doručování událostí. Tento atribut je platný pro všechny cílové typy s výjimkou StorageQueue. Více atributů lze zadat pomocí více než jednoho --delivery-attribute-mapping argumentu.
Použití: --delivery-attribute-mapping attribute-name attribute-type attribute-value [attribute-is-secret] Statické mapování atributů: --delivery-attribute-mapping somename static somevalue Static Attribute Mapping: --delivery-attribute-mapping somename static somename false Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue true Dynamic Attribute Mapping: --delivery-attribute-mapping somename dynamic somevalue Static and Dynamic: -- delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue.
Typ identity cílového prostředku doručení (např. fronta úložiště nebo eventhub).
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | systemassigned |
Koncový bod s identitou, ve které má EventGrid doručovat události odpovídající tomuto odběru událostí. U typu koncového bodu webhooku by to měla být odpovídající adresa URL webhooku. U jiných typů koncových bodů by to měl být identifikátor prostředku Azure koncového bodu.
Typ cílového koncového bodu s identitou prostředku.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook |
Umožňuje, aby se rozšířené filtry vyhodnocovaly proti poli hodnot místo toho, aby nečekaly hodnotu v jednotném čísle.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Filtering Arguments |
| Přípustné hodnoty: | false, true |
Koncový bod, kde eventGrid by měl doručovat události odpovídající tomuto odběru událostí. U typu koncového bodu webhooku by to měla být odpovídající adresa URL webhooku. U jiných typů koncových bodů by to měl být identifikátor prostředku Azure koncového bodu. Před spuštěním jakéhokoli příkazu Event Gridu se očekává, že cílový koncový bod už je vytvořený a dostupný pro použití.
Typ cílového koncového bodu.
| Vlastnost | Hodnota |
|---|---|
| Default value: | webhook |
Schéma, ve kterém se mají události doručovat pro toto odběry událostí. Ve výchozím nastavení se události doručí ve stejném schématu, ve kterém jsou publikovány (na základě vstupního schématu odpovídajícího tématu).
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | cloudeventschemav1_0, custominputschema, eventgridschema |
Doba živé události (v minutách). Musí to být číslo od 1 do 1440.
| Vlastnost | Hodnota |
|---|---|
| Default value: | 1440 |
Datum nebo datum a čas (v UTC, např. 2018-11-30T11:59:59+00:00 nebo 2018-11-30), po kterém vyprší platnost odběru události. Ve výchozím nastavení neexistuje žádné vypršení platnosti odběru událostí.
Seznam typů událostí oddělených mezerami (např. Microsoft. Storage.BlobCreated a Microsoft. Storage.BlobDeleted). Chcete-li se přihlásit k odběru všech výchozích typů událostí, nezadávejte pro tento argument žádnou hodnotu. U témat event gridu jsou typy událostí definované zákazníkem. Pro Azure události, například účty úložiště, IoT Hub atd., můžete jejich typy událostí dotazovat pomocí tohoto příkazu rozhraní příkazového řádku az eventgrid topic-type list-event-types.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Filtering Arguments |
Seznam popisků oddělených mezerami, které se mají přidružit k tomuto odběru událostí.
Maximální počet pokusů o doručení Musí to být číslo od 1 do 30.
| Vlastnost | Hodnota |
|---|---|
| Default value: | 30 |
Maximální počet událostí v dávce Musí to být číslo od 1 do 5000.
Upřednostňovaná velikost dávky v kilobajtech. Musí to být číslo v rozsahu 1 až 1024.
Doba živé zprávy fronty úložiště v sekundách
Plně kvalifikovaný identifikátor prostředku Azure, pro který je potřeba vytvořit odběr události.
Použití: --source-resource-id Azure-Resource-ID pro Azure předplatné: --source-resource-id /subscriptions/{SubID} pro skupinu prostředků: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1 Pro téma EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/topics/t1 Pro účet úložiště: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. Storage/storageaccounts/sa1 pro doménu EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/domains/d1 Pro téma domény EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/domains/d1/topics/t1.
Volitelný řetězec pro filtrování událostí odběru událostí na základě předpony. Zástupné znaky nejsou podporovány.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Filtering Arguments |
Určete, zda se pole předmětu mají porovnávat citlivým způsobem na malá a velká písmena. True if flag present.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Filtering Arguments |
| Default value: | False |
| Přípustné hodnoty: | false, true |
Volitelný řetězec pro filtrování událostí odběru událostí na základě přípony. Zástupné znaky nejsou podporovány.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Filtering Arguments |
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
az eventgrid event-subscription delete
Odstranění odběru událostí
az eventgrid event-subscription delete --name
[--acquire-policy-token]
[--change-reference]
[--source-resource-id]
Příklady
Odstranění odběru událostí pro téma Event Gridu
az eventgrid event-subscription delete --name es1 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1
Odstranění odběru událostí pro téma domény Event Gridu
az eventgrid event-subscription delete --name es1 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/domains/domain1/topics/topic1
Odstranění odběru událostí pro doménu Event Gridu
az eventgrid event-subscription delete --name es1 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/domains/domain1
Odstranění odběru událostí pro předplatné Azure
az eventgrid event-subscription delete --name es2 \
--source-resource-id /subscriptions/{SubID}
Odstranění odběru událostí pro skupinu prostředků
az eventgrid event-subscription delete --name es3 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}
Odstranění odběru události pro účet úložiště
az eventgrid event-subscription delete --name es3 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/microsoft.storage/storageaccounts/kalsegblob
Povinné parametry
Název odběru události.
Volitelné parametry
Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.
Získání tokenu Azure Policy automaticky pro tuto operaci prostředku
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
Související referenční ID odkazu na změnu pro tuto operaci prostředku.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
Plně kvalifikovaný identifikátor prostředku Azure, jehož odběr událostí je potřeba odstranit.
Použití: --source-resource-id Azure-Resource-ID pro Azure předplatné: --source-resource-id /subscriptions/{SubID} pro skupinu prostředků: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1 Pro téma EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/topics/t1 Pro účet úložiště: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. Storage/storageaccounts/sa1 pro doménu EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/domains/d1 Pro téma domény EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/domains/d1/topics/t1.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
az eventgrid event-subscription list
Výpis odběrů událostí
Event Grid podporuje regionální i globální odběry událostí: Odběry událostí v regionálních prostředcích (například účty úložiště nebo témata Event Gridu) jsou regionální, zatímco odběry událostí globálních prostředků (například předplatné Azure nebo skupina prostředků) jsou globální. Odběry událostí tedy můžete vypsat několika různými způsoby:
- Pokud chcete zobrazit seznam podle ID prostředku prostředku, jehož odběry událostí chcete vypsat, zadejte parametr --source-resource-id. Není nutné zadat žádné další parametry.
- Pokud chcete zobrazit seznam podle typu tématu (např. účtů úložiště), zadejte parametr --topic-type spolu s parametrem --location (např. westus2). Pro globální typy témat (např. "Microsoft. Resources.Subscriptions"), zadejte hodnotu umístění jako "global".
- Pokud chcete zobrazit seznam všech odběrů událostí v oblasti (napříč všemi typy témat), zadejte pouze parametr --location.
- Pokud chcete filtrovat jenom podle skupiny prostředků, můžete u výše uvedených #2 i #3 zadat parametr --resource-group.
az eventgrid event-subscription list [--location]
[--odata-query]
[--resource-group]
[--source-resource-id]
[--topic-type-name]
Příklady
Zobrazí seznam všech odběrů událostí vytvořených pro téma Event Gridu.
az eventgrid event-subscription list --source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1
Zobrazí seznam všech odběrů událostí vytvořených pro účet úložiště.
az eventgrid event-subscription list --source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Storage/storageaccounts/kalsegblob
Zobrazí seznam všech odběrů událostí vytvořených pro Azure předplatné.
az eventgrid event-subscription list --source-resource-id /subscriptions/{SubID}
Zobrazí seznam všech odběrů událostí vytvořených pro skupinu prostředků.
az eventgrid event-subscription list --source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}
Zobrazí seznam všech odběrů událostí pro doménu Event Gridu.
az eventgrid event-subscription list --source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/domains/d1
Zobrazí seznam všech odběrů událostí pro téma domény Event Gridu.
az eventgrid event-subscription list --source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/domains/d1/topics/topic1
Zobrazí seznam všech odběrů událostí úložiště (v aktuálně vybraném předplatném Azure) v oblasti westus2.
az eventgrid event-subscription list --topic-type Microsoft.Storage.StorageAccounts --location westus2
Vypište všechna předplatná událostí úložiště (pod danou skupinou prostředků) v oblasti westus2.
az eventgrid event-subscription list --topic-type Microsoft.Storage.StorageAccounts --location westus2 --resource-group {RG}
Zobrazí seznam všech odběrů místních nebo globálních událostí (v aktuálně vybraném předplatném Azure).
az eventgrid event-subscription list --location westus2
az eventgrid event-subscription list --location global
Vypíše všechna odběry místních nebo globálních událostí v zadané skupině prostředků.
az eventgrid event-subscription list --location westus2 --resource-group {RG}
az eventgrid event-subscription list --location global --resource-group {RG}
Výpis všech odběrů událostí pro doménu Event Gridu, jejíž název obsahuje vzor XYZ
az eventgrid event-subscription list --source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/domains/d1 --odata-query "Contains(name, 'XYZ')"
Výpis všech odběrů událostí pro doménu Event Gridu s výjimkou odběru událostí s názvem "name1"
az eventgrid event-subscription list --source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/domains/d1 --odata-query "NOT (name eq 'name1')"
Volitelné parametry
Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.
Location. Hodnoty z: az account list-locations. Výchozí umístění můžete nakonfigurovat pomocí .az configure --defaults location=<location>
Dotaz OData použitý k filtrování výsledků seznamu. Filtrování je aktuálně povoleno pouze u vlastnosti Name. Mezi podporované operace patří: CONTAINS, eq (pro rovná se), ne (ne rovno), AND, OR a NOT.
Název skupiny prostředků Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.
Plně kvalifikovaný identifikátor prostředku Azure, jehož odběr událostí je potřeba uvést.
Použití: --source-resource-id Azure-Resource-ID pro Azure předplatné: --source-resource-id /subscriptions/{SubID} pro skupinu prostředků: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1 Pro téma EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/topics/t1 Pro účet úložiště: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. Storage/storageaccounts/sa1 pro doménu EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/domains/d1 Pro téma domény EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/domains/d1/topics/t1.
Název typu tématu, jehož odběry událostí je potřeba uvést. Při zadání je nutné zadat také parametr --location.
Příklad 1: Výpis všech odběrů událostí úložiště v westUS2 --resource-group TestRG --topic-type-name Microsoft. Storage.StorageAccounts --location westus2 Example 2: Výpis všech odběrů událostí u předplatných Azure předplatných --topic-type-name Microsoft. Resources.Subscriptions --location global.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
az eventgrid event-subscription show
Získejte podrobnosti o odběru událostí.
az eventgrid event-subscription show --name
[--include-attrib-secret --include-static-delivery-attribute-secret {false, true}]
[--include-full-endpoint-url {false, true}]
[--source-resource-id]
Příklady
Zobrazí podrobnosti odběru událostí pro téma Event Gridu.
az eventgrid event-subscription show --name es1 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft.EventGrid/topics/topic1
Zobrazí podrobnosti odběru událostí pro předplatné Azure.
az eventgrid event-subscription show --name es2 \
--source-resource-id /subscriptions/{SubID}
Zobrazí podrobnosti odběru událostí pro skupinu prostředků.
az eventgrid event-subscription show --name es3 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/rg1
Zobrazí podrobnosti odběru událostí pro účet úložiště.
az eventgrid event-subscription show --name es3 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/microsoft.storage/storageaccounts/kalsegblob
Zobrazí podrobnosti odběru událostí pro skupinu prostředků včetně všech tajných kódů atributů statického doručování.
az eventgrid event-subscription show --name es3 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/rg1 \
--include-static-delivery-attribute-secret
Povinné parametry
Název odběru události.
Volitelné parametry
Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.
Určete, jestli se mají vrátit nějaké tajné kódy atributů statického doručení. True if flag present.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
| Přípustné hodnoty: | false, true |
Zadejte, zda má být vrácena úplná adresa URL koncového bodu. True if flag present.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
| Přípustné hodnoty: | false, true |
Plně kvalifikovaný identifikátor prostředku Azure, jehož odběr událostí je potřeba zobrazit.
Použití: --source-resource-id Azure-Resource-ID pro Azure předplatné: --source-resource-id /subscriptions/{SubID} pro skupinu prostředků: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1 Pro téma EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/topics/t1 Pro účet úložiště: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. Storage/storageaccounts/sa1 pro doménu EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/domains/d1 Pro téma domény EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/domains/d1/topics/t1.
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
az eventgrid event-subscription update
Aktualizace odběru událostí
az eventgrid event-subscription update --name
[--acquire-policy-token]
[--add]
[--advanced-filter]
[--change-reference]
[--deadletter-endpoint]
[--deadletter-identity {systemassigned}]
[--deadletter-identity-endpoint]
[--delivery-attribute-mapping]
[--delivery-identity {systemassigned}]
[--delivery-identity-endpoint]
[--delivery-identity-endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
[--enable-advanced-filtering-on-arrays --enable-af-arr {false, true}]
[--endpoint]
[--endpoint-type]
[--force-string]
[--included-event-types]
[--labels]
[--qttl --storage-queue-msg-ttl]
[--remove]
[--set]
[--source-resource-id]
[--subject-begins-with]
[--subject-ends-with]
Příklady
Aktualizujte odběr událostí pro téma Event Gridu a zadejte nový koncový bod.
az eventgrid event-subscription update --name es1 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/topics/topic1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
Aktualizujte odběr událostí pro odběr Azure a zadejte nový filtr končících předmětem.
az eventgrid event-subscription update --name es2 \
--source-resource-id /subscriptions/{SubID} \
--subject-ends-with .jpg
Aktualizujte odběr událostí pro skupinu prostředků, aby určil nový koncový bod a nový filtr končící předmětem.
az eventgrid event-subscription update --name es3 \
--source-resource-id /subscriptions/{SubID}/resourceGroups/{RG} \
--subject-ends-with .png \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
Aktualizujte odběr událostí pro účet úložiště a zadejte nový seznam zahrnutých typů událostí.
az eventgrid event-subscription update --name es3 \
--source-resource-id "/subscriptions/{SubID}/resourceGroups/{RG}/providers/microsoft.storage/storageaccounts/kalsegblob" \
--included-event-types Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted
Aktualizujte odběr události pro účet úložiště, aby zahrnoval cíl deadletteru.
az eventgrid event-subscription update --name es2 \
--source-resource-id "/subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Storage/storageaccounts/kalsegblob" \
--deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/blobcontainer1
Aktualizujte odběr událostí pro účet úložiště pomocí rozšířených filtrů.
az eventgrid event-subscription update --name es3 \
--source-resource-id "/subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Storage/storageaccounts/s1" \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
--advanced-filter data.blobType StringIn BlockBlob
--advanced-filter data.url StringBeginsWith https://myaccount.blob.core.windows.net
Aktualizujte odběr událostí pro účet úložiště tak, aby zahrnoval hodnotu ttl zprávy nastavenou na 5 minut.
az eventgrid event-subscription update --name es2 \
--source-resource-id "/subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Storage/storageaccounts/kalsegblob" \
--storage-queue-msg-ttl 300
Aktualizace odběru událostí s povoleným rozšířeným filtrováním u polí
az eventgrid event-subscription update --name es2 \
--source-resource-id "/subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Storage/storageaccounts/kalsegblob" \
--enable-advanced-filtering-on-arrays true
Povinné parametry
Název odběru události.
Volitelné parametry
Následující parametry jsou volitelné, ale v závislosti na kontextu se může stát, že se jeden nebo více vyžaduje, aby se příkaz úspěšně spustil.
Získání tokenu Azure Policy automaticky pro tuto operaci prostředku
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
Přidejte objekt do seznamu objektů zadáním párů cest a klíč-hodnota. Příklad: --add property.listProperty <key=value, string or JSON string>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Generic Update Arguments |
| Default value: | [] |
Rozšířený filtr umožňuje filtrování událostí na základě konkrétní vlastnosti události.
Použití: --advanced-filter KEY[. INNERKEY] FILTEROPERATOR VALUE [VALUE ...] StringIn: --advanced-filter data. Color StringIn Blue Red Orange Yellow StringNotIn: --advanced-filter data. Color StringNotIn Blue Orange Yellow StringContains: --advanced-filter subject StringContains Blue Red StringNotContains: --advanced-filter subject StringNotContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWith Blue Red StringNotBeginssWith: --advanced-filter subject StringNotBeginsWith Blue Red StringEndsWith: --advanced-filter subject StringEndsWith img png jpg StringNotEndsWith: --advanced-filter subject StringNotEndsWith img png numberIn: --advanced-filter data.property1 NumberIn 5 10 20 NumberInRange --advanced-filter data.property1 NumberInRange 5,10 20,30 40,50 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 NumberNotInRange: --advanced-filter data.property2 ČísloNotInRange 100 110 200 210 300 310 NumberLessThan: --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals: --advanced-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThan: --advanced-filter data.property3 NumberGreaterThan 100 NumberGreaterThanOrEquals: --advanced-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --advanced-filter data.property3 BoolEquals true IsNullOrUndefined: --advanced-filter data.property3 IsNullOrUndefined IsNotNull: --advanced-filter data.property3 IsNotNull Více rozšířených filtrů lze zadat pomocí více než jednoho argumentu --advanced-filter.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Filtering Arguments |
Související referenční ID odkazu na změnu pro tuto operaci prostředku.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Global Policy Arguments |
ID prostředku Azure cíle kontejneru objektů blob Azure Storage, kde by EventGrid měl pro toto odběr událostí zrušit nedoručitelné události.
Typ identity cílového prostředku deadletter.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | systemassigned |
ID Azure prostředku cílového kontejneru objektů blob Azure Storage s identitou, ve které by EventGrid měla zrušit nedoručitelné události pro toto odběry událostí.
Přidání mapování atributů doručení pro odesílání dalších informací prostřednictvím hlaviček HTTP při doručování událostí. Tento atribut je platný pro všechny cílové typy s výjimkou StorageQueue. Více atributů lze zadat pomocí více než jednoho --delivery-attribute-mapping argumentu.
Použití: --delivery-attribute-mapping attribute-name attribute-type attribute-value [attribute-is-secret] Statické mapování atributů: --delivery-attribute-mapping somename static somevalue Static Attribute Mapping: --delivery-attribute-mapping somename static somename false Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue true Dynamic Attribute Mapping: --delivery-attribute-mapping somename dynamic somevalue Static and Dynamic: -- delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue.
Typ identity cílového prostředku doručení (např. fronta úložiště nebo eventhub).
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | systemassigned |
Koncový bod s identitou, ve které má EventGrid doručovat události odpovídající tomuto odběru událostí. U typu koncového bodu webhooku by to měla být odpovídající adresa URL webhooku. U jiných typů koncových bodů by to měl být identifikátor prostředku Azure koncového bodu.
Typ cílového koncového bodu s identitou prostředku.
| Vlastnost | Hodnota |
|---|---|
| Přípustné hodnoty: | azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook |
Umožňuje, aby se rozšířené filtry vyhodnocovaly proti poli hodnot místo toho, aby nečekaly hodnotu v jednotném čísle.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Filtering Arguments |
| Přípustné hodnoty: | false, true |
Koncový bod, kde eventGrid by měl doručovat události odpovídající tomuto odběru událostí. U typu koncového bodu webhooku by to měla být odpovídající adresa URL webhooku. U jiných typů koncových bodů by to měl být identifikátor prostředku Azure koncového bodu. Před spuštěním jakéhokoli příkazu Event Gridu se očekává, že cílový koncový bod už je vytvořený a dostupný pro použití.
Typ cílového koncového bodu.
| Vlastnost | Hodnota |
|---|---|
| Default value: | webhook |
Při použití set nebo add zachovávejte řetězcové literály místo pokusu o převod na JSON.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Generic Update Arguments |
| Default value: | False |
Seznam typů událostí oddělených mezerami (např. Microsoft. Storage.BlobCreated a Microsoft. Storage.BlobDeleted). Chcete-li se přihlásit k odběru všech výchozích typů událostí, nezadávejte pro tento argument žádnou hodnotu. U témat event gridu jsou typy událostí definované zákazníkem. Pro Azure události, například účty úložiště, IoT Hub atd., můžete jejich typy událostí dotazovat pomocí tohoto příkazu rozhraní příkazového řádku az eventgrid topic-type list-event-types.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Filtering Arguments |
Seznam popisků oddělených mezerami, které se mají přidružit k tomuto odběru událostí.
Doba živé zprávy fronty úložiště v sekundách
Odeberte vlastnost nebo prvek ze seznamu. Příklad: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Generic Update Arguments |
| Default value: | [] |
Aktualizujte objekt zadáním cesty vlastnosti a hodnoty, která se má nastavit. Příklad: --set property1.property2=<value>.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Generic Update Arguments |
| Default value: | [] |
Plně kvalifikovaný identifikátor prostředku Azure, jehož odběr událostí je potřeba aktualizovat.
Použití: --source-resource-id Azure-Resource-ID pro Azure předplatné: --source-resource-id /subscriptions/{SubID} pro skupinu prostředků: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1 Pro téma EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/topics/t1 Pro účet úložiště: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. Storage/storageaccounts/sa1 pro doménu EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/domains/d1 Pro téma domény EventGrid: --source-resource-id /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. EventGrid/domains/d1/topics/t1.
Volitelný řetězec pro filtrování událostí odběru událostí na základě předpony. Zástupné znaky nejsou podporovány.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Filtering Arguments |
Volitelný řetězec pro filtrování událostí odběru událostí na základě přípony. Zástupné znaky nejsou podporovány.
| Vlastnost | Hodnota |
|---|---|
| Skupina parametrů: | Filtering Arguments |
Globální parametry
Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Zobrazte tuto zprávu nápovědy a ukončete ji.
Zobrazit pouze chyby, potlačit upozornění.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |
Výstupní formát
| Vlastnost | Hodnota |
|---|---|
| Default value: | json |
| Přípustné hodnoty: | json, jsonc, none, table, tsv, yaml, yamlc |
Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.
Název nebo ID předplatného Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.
Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.
| Vlastnost | Hodnota |
|---|---|
| Default value: | False |