az eventgrid domain

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage event domains.

Commands

Name	Description	Type	Status
az eventgrid domain create	Create a domain.	Core	GA
az eventgrid domain create (eventgrid extension)	Create a domain.	Extension	Preview
az eventgrid domain delete	Delete a domain.	Core	GA
az eventgrid domain delete (eventgrid extension)	Delete a domain.	Extension	Preview
az eventgrid domain event-subscription	Manage event subscriptions of domain.	Core	GA
az eventgrid domain event-subscription create	Create a new event subscription for a domain.	Core	GA
az eventgrid domain event-subscription delete	Delete an event subscription of a domain.	Core	GA
az eventgrid domain event-subscription list	List event subscriptions of a specific domain.	Core	GA
az eventgrid domain event-subscription show	Get the details of an event subscription of a domain.	Core	GA
az eventgrid domain event-subscription update	Update an event subscription of a domain.	Core	GA
az eventgrid domain key	Manage shared access keys of a domain.	Core and Extension	GA
az eventgrid domain key list	List shared access keys of a domain.	Core	GA
az eventgrid domain key list (eventgrid extension)	List shared access keys of a domain.	Extension	Preview
az eventgrid domain key regenerate	Regenerate a shared access key of a domain.	Core	GA
az eventgrid domain key regenerate (eventgrid extension)	Regenerate a shared access key of a domain.	Extension	Preview
az eventgrid domain list	List available domains.	Core	GA
az eventgrid domain list (eventgrid extension)	List available domains.	Extension	Preview
az eventgrid domain private-endpoint-connection	Manage private endpoint connection resources of a domain.	Extension	Preview
az eventgrid domain private-endpoint-connection approve	Approve a private endpoint connection request for a domain.	Extension	Preview
az eventgrid domain private-endpoint-connection delete	Delete a private endpoint connection for a domain.	Extension	Preview
az eventgrid domain private-endpoint-connection list	List the properties of all the private endpoint connections for a domain.	Extension	Preview
az eventgrid domain private-endpoint-connection reject	Reject a private endpoint connection request for a domain.	Extension	Preview
az eventgrid domain private-endpoint-connection show	Display the properties of a private endpoint connection for a domain.	Extension	Preview
az eventgrid domain private-link-resource	Manage private link resource of a domain.	Extension	Preview
az eventgrid domain private-link-resource list	List the properties of all the private link resources for a domain.	Extension	Preview
az eventgrid domain private-link-resource show	Display the properties of a private link resource for a domain.	Extension	Preview
az eventgrid domain show	Get the details of a domain.	Core	GA
az eventgrid domain show (eventgrid extension)	Get the details of a domain.	Extension	Preview
az eventgrid domain topic	Manage event domain topics.	Core and Extension	GA
az eventgrid domain topic create	Create a domain topic under a domain.	Core	GA
az eventgrid domain topic create (eventgrid extension)	Create a domain topic under a domain.	Extension	Preview
az eventgrid domain topic delete	Delete a domain topic under a domain.	Core	GA
az eventgrid domain topic delete (eventgrid extension)	Delete a domain topic under a domain.	Extension	Preview
az eventgrid domain topic event-subscription	Manage event subscriptions of a domain topic.	Core	GA
az eventgrid domain topic event-subscription create	Create a new event subscription for a domain topic.	Core	GA
az eventgrid domain topic event-subscription delete	Delete an event subscription of a domain topic.	Core	GA
az eventgrid domain topic event-subscription list	List event subscriptions of a specific domain topic.	Core	GA
az eventgrid domain topic event-subscription show	Get the details of an event subscription of a domain topic.	Core	GA
az eventgrid domain topic event-subscription update	Update an event subscription of a domain topic.	Core	GA
az eventgrid domain topic list	List available topics in a domain.	Core	GA
az eventgrid domain topic list (eventgrid extension)	List available topics in a domain.	Extension	Preview
az eventgrid domain topic show	Get the details of a domain topic.	Core	GA
az eventgrid domain topic show (eventgrid extension)	Get the details of a domain topic.	Extension	Preview
az eventgrid domain update	Update a domain.	Core	GA
az eventgrid domain update (eventgrid extension)	Update a domain.	Extension	Preview

az eventgrid domain create

Create a domain.

az eventgrid domain create --name
                           --resource-group
                           [--identity {noidentity, systemassigned}]
                           [--inbound-ip-rules]
                           [--input-mapping-default-values]
                           [--input-mapping-fields]
                           [--input-schema {cloudeventschemav1_0, customeventschema, eventgridschema}]
                           [--location]
                           [--mi-system-assigned]
                           [--mi-user-assigned]
                           [--public-network-access {disabled, enabled}]
                           [--sku {basic, premium}]
                           [--tags]

Examples

Create a new domain.

az eventgrid domain create -g rg1 --name domain1 -l westus2

Create a new domain with custom input mappings.

az eventgrid domain create -g rg1 --name domain1 -l westus2 --input-schema customeventschema --input-mapping-fields topic=mytopicField eventType=myEventTypeField --input-mapping-default-values subject=DefaultSubject dataVersion=1.0

Create a new domain that accepts events published in CloudEvents V1.0 schema and maps a property mytopicfield to the topic name.

az eventgrid domain create -g rg1 --name domain1 -l westus2 --input-schema cloudeventschemav1_0 --input-mapping-fields topic=mytopicfield

Create a new domain which allows specific inbound ip rules.

az eventgrid domain create -g rg1 --name domain1 -l westus2 --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --sku basic

Required Parameters

--name -n

Name of the domain.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--identity

Preview Deprecated

Argument 'identity' has been deprecated and will be removed in a future release.

The managed identity type for the resource. Will be deprecated and replaced by --mi-system-assigned-identity in future.

Accepted values: noidentity, systemassigned

--inbound-ip-rules

List of inbound IP rules.

List of inbound IP rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.

--input-mapping-default-values

When input-schema is specified as customeventschema, this parameter can be used to specify input mappings based on default values. You can use this parameter when your custom schema does not include a field that corresponds to one of the three fields supported by this parameter. Specify space separated mappings in 'key=value' format. Allowed key names are 'subject', 'eventtype', 'dataversion'. The corresponding value names should specify the default values to be used for the mapping and they will be used only when the published event doesn't have a valid mapping for a particular field.

--input-mapping-fields

When input-schema is specified as customeventschema, this parameter is used to specify input mappings based on field names. Specify space separated mappings in 'key=value' format. Allowed key names are 'id', 'topic', 'eventtime', 'subject', 'eventtype', 'dataversion'. The corresponding value names should specify the names of the fields in the custom input schema. If a mapping for either 'id' or 'eventtime' is not provided, Event Grid will auto-generate a default value for these two fields.

--input-schema

Schema in which incoming events will be published to this topic/domain. If you specify customeventschema as the value for this parameter, you must also provide values for at least one of --input_mapping_default_values / --input_mapping_fields.

Accepted values: cloudeventschemav1_0, customeventschema, eventgridschema

Default value: eventgridschema

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--mi-system-assigned

Presence of this param indicates that SystemAssigned managed identity will be used.

--mi-user-assigned

Preview

Add user assigned identities when identityType is user or mixed. This attribute is valid for all destination types except StorageQueue. Multiple attributes can be specified by using more than one --mi-user-assigned argument.

--public-network-access

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring.

Accepted values: disabled, enabled

--sku

Preview

The Sku name of the resource.

Accepted values: basic, premium

Default value: Basic

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventgrid domain create (eventgrid extension)

Preview

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a domain.

az eventgrid domain create --location
                           --name
                           --resource-group
                           [--identity {noidentity, systemassigned}]
                           [--inbound-ip-rules]
                           [--input-mapping-default-values]
                           [--input-mapping-fields]
                           [--input-schema {cloudeventschemav1_0, customeventschema, eventgridschema}]
                           [--public-network-access {disabled, enabled}]
                           [--sku {basic, premium}]
                           [--tags]

Examples

Create a new domain.

az eventgrid domain create -g rg1 --name domain1 -l westus2

Create a new domain with custom input mappings.

az eventgrid domain create -g rg1 --name domain1 -l westus2 --input-schema customeventschema --input-mapping-fields topic=mytopicField eventType=myEventTypeField --input-mapping-default-values subject=DefaultSubject dataVersion=1.0

Create a new domain that accepts events published in CloudEvents V1.0 schema and maps a property mytopicfield to the topic name.

az eventgrid domain create -g rg1 --name domain1 -l westus2 --input-schema cloudeventschemav1_0 --input-mapping-fields topic=mytopicfield

Create a new domain which allows specific inbound ip rules.

az eventgrid domain create -g rg1 --name domain1 -l westus2 --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --sku basic

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

Name of the domain.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--identity

The identity type of the resource (e.g., topic or domain).

Accepted values: noidentity, systemassigned

--inbound-ip-rules

List of inbound IP rules.

List of inbound IP rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.

--input-mapping-default-values

When input-schema is specified as customeventschema, this parameter can be used to specify input mappings based on default values. You can use this parameter when your custom schema does not include a field that corresponds to one of the three fields supported by this parameter. Specify space separated mappings in 'key=value' format. Allowed key names are 'subject', 'eventtype', 'dataversion'. The corresponding value names should specify the default values to be used for the mapping and they will be used only when the published event doesn't have a valid mapping for a particular field.

--input-mapping-fields

When input-schema is specified as customeventschema, this parameter is used to specify input mappings based on field names. Specify space separated mappings in 'key=value' format. Allowed key names are 'id', 'topic', 'eventtime', 'subject', 'eventtype', 'dataversion'. The corresponding value names should specify the names of the fields in the custom input schema. If a mapping for either 'id' or 'eventtime' is not provided, Event Grid will auto-generate a default value for these two fields.

--input-schema

Schema in which incoming events will be published to this topic/domain. If you specify customeventschema as the value for this parameter, you must also provide values for at least one of --input_mapping_default_values / --input_mapping_fields.

Accepted values: cloudeventschemav1_0, customeventschema, eventgridschema

Default value: eventgridschema

--public-network-access

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring.

Accepted values: disabled, enabled

--sku

The Sku name of the resource.

Accepted values: basic, premium

Default value: Basic

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventgrid domain delete

Delete a domain.

az eventgrid domain delete [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

Examples

Delete a domain.

az eventgrid domain delete -g rg1 --name domain1

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the domain.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventgrid domain delete (eventgrid extension)

Preview

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a domain.

az eventgrid domain delete [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

Examples

Delete a domain.

az eventgrid domain delete -g rg1 --name domain1

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the domain.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventgrid domain list

List available domains.

az eventgrid domain list [--odata-query]
                         [--resource-group]

Examples

List all domains in the current Azure subscription.

az eventgrid domain list

List all domains in a resource group.

az eventgrid domain list -g rg1

List all domains in a resource group whose name contains the pattern "XYZ"

az eventgrid domain list -g rg1 --odata-query "Contains(name, 'XYZ')"

List all domains in a resource group except the domain with name "name1"

az eventgrid domain list -g rg1 --odata-query "NOT (name eq 'name1')"

Optional Parameters

--odata-query

The OData query used for filtering the list results. Filtering is currently allowed on the Name property only. The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventgrid domain list (eventgrid extension)

Preview

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List available domains.

az eventgrid domain list [--odata-query]
                         [--resource-group]

Examples

List all domains in the current Azure subscription.

az eventgrid domain list

List all domains in a resource group.

az eventgrid domain list -g rg1

List all domains in a resource group whose name contains the pattern "XYZ"

az eventgrid domain list -g rg1 --odata-query "Contains(name, 'XYZ')"

List all domains in a resource group except the domain with name "name1"

az eventgrid domain list -g rg1 --odata-query "NOT (name eq 'name1')"

Optional Parameters

--odata-query

The query used to filter the results using OData syntax.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventgrid domain show

Get the details of a domain.

az eventgrid domain show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

Examples

Show the details of a domain.

az eventgrid domain show -g rg1 -n domain1

Show the details of a domain based on resource ID.

az eventgrid domain show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/domains/domain1

Get the details of a domain (autogenerated)

az eventgrid domain show --name domain1 --resource-group rg1 --subscription MySubscription

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the domain.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventgrid domain show (eventgrid extension)

Preview

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the details of a domain.

az eventgrid domain show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

Examples

Show the details of a domain.

az eventgrid domain show -g rg1 -n domain1

Show the details of a domain based on resource ID.

az eventgrid domain show --ids /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.EventGrid/domains/domain1

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the domain.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventgrid domain update

Update a domain.

az eventgrid domain update [--identity {noidentity, systemassigned}]
                           [--ids]
                           [--inbound-ip-rules]
                           [--mi-system-assigned]
                           [--mi-user-assigned]
                           [--name]
                           [--public-network-access {disabled, enabled}]
                           [--resource-group]
                           [--sku {basic, premium}]
                           [--subscription]
                           [--tags]

Examples

Update the properties of an existing domain.

az eventgrid domain update -g rg1 --name domain1 --sku Basic --identity noidentity --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --tags Dept=IT --sku basic

Optional Parameters

--identity

Preview Deprecated

Argument 'identity' has been deprecated and will be removed in a future release.

The managed identity type for the resource. Will be deprecated and replaced by --mi-system-assigned-identity in future.

Accepted values: noidentity, systemassigned

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--inbound-ip-rules

List of inbound IP rules.

List of inbound IP rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.

--mi-system-assigned

Presence of this param indicates that SystemAssigned managed identity will be used.

--mi-user-assigned

Preview

Add user assigned identities when identityType is user or mixed. This attribute is valid for all destination types except StorageQueue. Multiple attributes can be specified by using more than one --mi-user-assigned argument.

--name -n

Name of the domain.

--public-network-access

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring.

Accepted values: disabled, enabled

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--sku

Preview

The Sku name of the resource.

Accepted values: basic, premium

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az eventgrid domain update (eventgrid extension)

Preview

Command group 'az eventgrid' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a domain.

az eventgrid domain update [--identity {noidentity, systemassigned}]
                           [--ids]
                           [--inbound-ip-rules]
                           [--name]
                           [--public-network-access {disabled, enabled}]
                           [--resource-group]
                           [--sku {basic, premium}]
                           [--subscription]
                           [--tags]

Examples

Update the properties of an existing domain.

az eventgrid domain update -g rg1 --name domain1 --sku Basic --identity noidentity --public-network-access enabled --inbound-ip-rules 10.0.0.0/8 Allow --inbound-ip-rules 10.2.0.0/8 Allow --tags Dept=IT --sku basic

Optional Parameters

--identity

The identity type of the resource (e.g., topic or domain).

Accepted values: noidentity, systemassigned

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--inbound-ip-rules

List of inbound IP rules.

List of inbound IP rules specifying IP Address in CIDR notation e.g., 10.0.0.0/8 along with corresponding Action to perform based on the match or no match of the IpMask. Possible values include - Allow.

--name -n

Name of the domain.

--public-network-access

This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring.

Accepted values: disabled, enabled

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--sku

The Sku name of the resource.

Accepted values: basic, premium

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.