az eventgrid namespace client
Note
Bu başvuru, Azure CLI (sürüm 2.51.0 veya üzeri) için eventgrid uzantısının bir parçasıdır. Uzantı, az eventgrid namespace client komutu ilk kez çalıştırdığınızda otomatik olarak yüklenir. Uzantılar hakkında daha fazla bilgi edinin.
'az eventgrid' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus
eventgrid ad alanı istemcilerini yönetin.
Komutlar
| Name | Description | Tür | Durum |
|---|---|---|---|
| az eventgrid namespace client create |
İstemci oluşturma. |
Extension | Preview |
| az eventgrid namespace client delete |
Var olan bir istemciyi silin. |
Extension | Preview |
| az eventgrid namespace client list |
Ad alanı altındaki tüm istemciyi listeleyin. |
Extension | Preview |
| az eventgrid namespace client show |
Bir istemciyi gösterin. |
Extension | Preview |
| az eventgrid namespace client update |
İstemciyi güncelleştirme. |
Extension | Preview |
| az eventgrid namespace client wait |
Bir koşul karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin. |
Extension | Preview |
az eventgrid namespace client create
'az eventgrid namespace client' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus
İstemci oluşturma.
az eventgrid namespace client create --client-name --name
--namespace-name
--resource-group
[--acquire-policy-token]
[--attributes]
[--authentication]
[--authentication-name]
[--change-reference]
[--client-certificate-authentication]
[--description]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--state {Disabled, Enabled}]
Örnekler
İstemci oluşturma
az eventgrid namespace client create -g rg --namespace-name name -n client-name --attributes "{'room':'345','floor':5}" --client-certificate-authentication "{validationScheme:SubjectMatchesAuthenticationName}"
Gerekli Parametreler
İstemci adı.
Ad alanının adı.
Kaynak grubunun adı.
az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.
İsteğe Bağlı Parametreler
Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.
Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Global Policy Arguments |
İstemcinin öznitelikleri. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Properties Arguments |
İstemci için kimlik doğrulama bilgileri. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Properties Arguments |
İstemci tarafından kimlik doğrulaması için sunulan ad. Varsayılan değer kaynağın adıdır.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Properties Arguments |
Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Global Policy Arguments |
İstemci sertifikası kimlik doğrulama bilgileri. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Properties Arguments |
İstemci kaynağının açıklaması.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Properties Arguments |
Uzun süre çalışan işlemin bitmesini beklemeyin.
| Özellik | Değer |
|---|---|
| Kabul edilen değerler: | 0, 1, f, false, n, no, t, true, y, yes |
İstemcinin etkin olup olmadığını gösterir. Varsayılan değer Etkin'dir.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Properties Arguments |
| Default value: | Enabled |
| Kabul edilen değerler: | Disabled, Enabled |
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
| Özellik | Değer |
|---|---|
| Default value: | False |
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
| Özellik | Değer |
|---|---|
| Default value: | False |
Çıkış biçimi.
| Özellik | Değer |
|---|---|
| Default value: | json |
| Kabul edilen değerler: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.
Aboneliğin adı veya kimliği.
az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.
Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.
| Özellik | Değer |
|---|---|
| Default value: | False |
az eventgrid namespace client delete
'az eventgrid namespace client' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus
Var olan bir istemciyi silin.
az eventgrid namespace client delete [--acquire-policy-token]
[--change-reference]
[--client-name --name]
[--ids]
[--namespace-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Örnekler
İstemciyi silme
az eventgrid namespace client delete -g rg --namespace-name name -n client-name
İsteğe Bağlı Parametreler
Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.
Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Global Policy Arguments |
Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Global Policy Arguments |
İstemcinin adı.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Bir veya daha fazla kaynak kimliği (boşlukla ayrılmış). 'Kaynak Kimliği' bağımsız değişkenlerinin tüm bilgilerini içeren eksiksiz bir kaynak kimliği olmalıdır. --ids veya diğer 'Kaynak Kimliği' parametrelerini vermelisiniz.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Ad alanının adı.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Uzun süre çalışan işlemin bitmesini beklemeyin.
| Özellik | Değer |
|---|---|
| Kabul edilen değerler: | 0, 1, f, false, n, no, t, true, y, yes |
Kaynak grubunun adı.
az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Aboneliğin adı veya kimliği.
az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Onay istemde bulunmayın.
| Özellik | Değer |
|---|---|
| Default value: | False |
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
| Özellik | Değer |
|---|---|
| Default value: | False |
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
| Özellik | Değer |
|---|---|
| Default value: | False |
Çıkış biçimi.
| Özellik | Değer |
|---|---|
| Default value: | json |
| Kabul edilen değerler: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.
Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.
| Özellik | Değer |
|---|---|
| Default value: | False |
az eventgrid namespace client list
'az eventgrid namespace client' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus
Ad alanı altındaki tüm istemciyi listeleyin.
az eventgrid namespace client list --namespace-name
--resource-group
[--filter]
[--max-items]
[--next-token]
[--top]
Örnekler
Liste istemcisi
az eventgrid namespace client list -g rg --namespace-name name
Gerekli Parametreler
Ad alanının adı.
Kaynak grubunun adı.
az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.
İsteğe Bağlı Parametreler
Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.
OData söz dizimini kullanarak arama sonuçlarını filtrelemek için kullanılan sorgu. Yalnızca 'name' özelliğinde ve sınırlı sayıda OData işlemiyle filtrelemeye izin verilir. Bu işlemler şunlardır: 'contains' işlevinin yanı sıra aşağıdaki mantıksal işlemler: not, and, or, eq (eşit için) ve ne (eşit değildir). Hiçbir aritmetik işlem desteklenmez. Geçerli bir filtre örneği aşağıda verilmiştir: $filter=contains(namE, 'PATTERN') ve ne 'PATTERN-1' adı. Aşağıdaki geçerli bir filtre örneği değildir: $filter=konum eq 'westus'.
Komutun çıkışında döndürülecek toplam öğe sayısı. Kullanılabilir öğelerin toplam sayısı belirtilen değerden fazlaysa, komutun çıkışında bir belirteç sağlanır. Sayfalandırmayı sürdürmek için sonraki bir komutun --next-token bağımsız değişkeninde belirteç değerini sağlayın.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Pagination Arguments |
Sayfalandırmanın nereden başlatılacağını belirtmek için belirteç. Bu, daha önce kesilmiş bir yanıttan alınan belirteç değeridir.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Pagination Arguments |
Liste işlemi için sayfa başına döndürülecek sonuç sayısı. En iyi parametre için geçerli aralık 1 ile 100 arasındadır. Belirtilmezse, döndürülecek varsayılan sonuç sayısı sayfa başına 20 öğedir.
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
| Özellik | Değer |
|---|---|
| Default value: | False |
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
| Özellik | Değer |
|---|---|
| Default value: | False |
Çıkış biçimi.
| Özellik | Değer |
|---|---|
| Default value: | json |
| Kabul edilen değerler: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.
Aboneliğin adı veya kimliği.
az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.
Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.
| Özellik | Değer |
|---|---|
| Default value: | False |
az eventgrid namespace client show
'az eventgrid namespace client' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus
Bir istemciyi gösterin.
az eventgrid namespace client show [--client-name --name]
[--ids]
[--namespace-name]
[--resource-group]
[--subscription]
Örnekler
İstemciyi göster
az eventgrid namespace client show -g rg --namespace-name name -n client-name
İsteğe Bağlı Parametreler
Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.
İstemcinin adı.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Bir veya daha fazla kaynak kimliği (boşlukla ayrılmış). 'Kaynak Kimliği' bağımsız değişkenlerinin tüm bilgilerini içeren eksiksiz bir kaynak kimliği olmalıdır. --ids veya diğer 'Kaynak Kimliği' parametrelerini vermelisiniz.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Ad alanının adı.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Kaynak grubunun adı.
az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Aboneliğin adı veya kimliği.
az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
| Özellik | Değer |
|---|---|
| Default value: | False |
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
| Özellik | Değer |
|---|---|
| Default value: | False |
Çıkış biçimi.
| Özellik | Değer |
|---|---|
| Default value: | json |
| Kabul edilen değerler: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.
Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.
| Özellik | Değer |
|---|---|
| Default value: | False |
az eventgrid namespace client update
'az eventgrid namespace client' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus
İstemciyi güncelleştirme.
az eventgrid namespace client update [--acquire-policy-token]
[--add]
[--attributes]
[--authentication]
[--change-reference]
[--client-certificate-authentication]
[--client-name --name]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--namespace-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--state {Disabled, Enabled}]
[--subscription]
Örnekler
İstemciyi güncelleştirme
az eventgrid namespace client update -g rg --namespace-name name -n client-name --description test
İsteğe Bağlı Parametreler
Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.
Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Global Policy Arguments |
Bir yol ve anahtar değer çiftleri belirterek nesne listesine nesne ekleyin. Örnek: --add property.listProperty <key=value, string or JSON string>.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Generic Update Arguments |
İstemcinin öznitelikleri. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Properties Arguments |
İstemci için kimlik doğrulama bilgileri. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Properties Arguments |
Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Global Policy Arguments |
İstemci sertifikası kimlik doğrulama bilgileri. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Properties Arguments |
İstemcinin adı.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
İstemci kaynağının açıklaması.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Properties Arguments |
'set' veya 'add' kullanırken, JSON'a dönüştürmeye çalışmak yerine dize değişmez değerlerini koruyun.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Generic Update Arguments |
| Kabul edilen değerler: | 0, 1, f, false, n, no, t, true, y, yes |
Bir veya daha fazla kaynak kimliği (boşlukla ayrılmış). 'Kaynak Kimliği' bağımsız değişkenlerinin tüm bilgilerini içeren eksiksiz bir kaynak kimliği olmalıdır. --ids veya diğer 'Kaynak Kimliği' parametrelerini vermelisiniz.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Ad alanının adı.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Uzun süre çalışan işlemin bitmesini beklemeyin.
| Özellik | Değer |
|---|---|
| Kabul edilen değerler: | 0, 1, f, false, n, no, t, true, y, yes |
Bir özelliği veya öğeyi listeden kaldırın. Örnek: --remove property.list <indexToRemove> OR --remove propertyToRemove.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Generic Update Arguments |
Kaynak grubunun adı.
az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Ayarlanacağı özellik yolunu ve değerini belirterek nesneyi güncelleştirin. Örnek: --set property1.property2=<value>.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Generic Update Arguments |
İstemcinin etkin olup olmadığını gösterir. Varsayılan değer Etkin'dir.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Properties Arguments |
| Kabul edilen değerler: | Disabled, Enabled |
Aboneliğin adı veya kimliği.
az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
| Özellik | Değer |
|---|---|
| Default value: | False |
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
| Özellik | Değer |
|---|---|
| Default value: | False |
Çıkış biçimi.
| Özellik | Değer |
|---|---|
| Default value: | json |
| Kabul edilen değerler: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.
Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.
| Özellik | Değer |
|---|---|
| Default value: | False |
az eventgrid namespace client wait
'az eventgrid namespace client' komut grubu önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus
Bir koşul karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin.
az eventgrid namespace client wait [--acquire-policy-token]
[--change-reference]
[--client-name --name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--namespace-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
İsteğe Bağlı Parametreler
Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.
Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Global Policy Arguments |
Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Global Policy Arguments |
İstemcinin adı.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
'ProvisioningState' ile 'Succeeded' konumunda oluşturulana kadar bekleyin.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Wait Condition Arguments |
| Default value: | False |
Koşul özel bir JMESPath sorgusunu karşılayana kadar bekleyin. Örneğin provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
| Özellik | Değer |
|---|---|
| Parametre grubu: | Wait Condition Arguments |
Silinene kadar bekleyin.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Wait Condition Arguments |
| Default value: | False |
Kaynak var olana kadar bekleyin.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Wait Condition Arguments |
| Default value: | False |
Bir veya daha fazla kaynak kimliği (boşlukla ayrılmış). 'Kaynak Kimliği' bağımsız değişkenlerinin tüm bilgilerini içeren eksiksiz bir kaynak kimliği olmalıdır. --ids veya diğer 'Kaynak Kimliği' parametrelerini vermelisiniz.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Saniye cinsinden yoklama aralığı.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Wait Condition Arguments |
| Default value: | 30 |
Ad alanının adı.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Kaynak grubunun adı.
az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Aboneliğin adı veya kimliği.
az account set -s NAME_OR_IDkullanarak varsayılan aboneliği yapılandırabilirsiniz.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Resource Id Arguments |
Saniye cinsinden en fazla bekleme.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Wait Condition Arguments |
| Default value: | 3600 |
'Başarılı' konumunda provisioningState ile güncelleştirilene kadar bekleyin.
| Özellik | Değer |
|---|---|
| Parametre grubu: | Wait Condition Arguments |
| Default value: | False |
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
| Özellik | Değer |
|---|---|
| Default value: | False |
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
| Özellik | Değer |
|---|---|
| Default value: | False |
Çıkış biçimi.
| Özellik | Değer |
|---|---|
| Default value: | json |
| Kabul edilen değerler: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz. http://jmespath.org/.
Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.
| Özellik | Değer |
|---|---|
| Default value: | False |