az eventhubs eventhub fabric-shortcut

Manage Fabric Shortcut.

Commands

Name	Description	Type	Status
az eventhubs eventhub fabric-shortcut approve	Approves a Microsoft Fabric shortcut.	Core	GA
az eventhubs eventhub fabric-shortcut create	Create a Microsoft Fabric shortcut.	Core	GA
az eventhubs eventhub fabric-shortcut delete	Delete a Microsoft Fabric shortcut.	Core	GA
az eventhubs eventhub fabric-shortcut list	List Microsoft Fabric shortcuts for an Event Hub.	Core	GA
az eventhubs eventhub fabric-shortcut reject	Rejects a Microsoft Fabric shortcut.	Core	GA
az eventhubs eventhub fabric-shortcut show	Get a Microsoft Fabric shortcut.	Core	GA
az eventhubs eventhub fabric-shortcut update	Update a Microsoft Fabric shortcut.	Core	GA

az eventhubs eventhub fabric-shortcut approve

Approves a Microsoft Fabric shortcut.

az eventhubs eventhub fabric-shortcut approve [--acquire-policy-token]
                                              [--change-reference]
                                              [--event-hub-name]
                                              [--fabric-shortcut-name]
                                              [--ids]
                                              [--namespace-name]
                                              [--resource-group]
                                              [--subscription]

Examples

Approve a Fabric shortcut

az eventhubs eventhub fabric-shortcut approve --resource-group contoso-rg --namespace-name contoso-eventhub --event-hub-name orders --fabric-shortcut-name orders-shortcut

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--event-hub-name

The Event Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--fabric-shortcut-name

The Microsoft Fabric shortcut name.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

The Namespace name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventhubs eventhub fabric-shortcut create

Create a Microsoft Fabric shortcut.

az eventhubs eventhub fabric-shortcut create --event-hub-name
                                             --fabric-shortcut-name --name
                                             --namespace-name
                                             --resource-group
                                             [--acquire-policy-token]
                                             [--change-reference]
                                             [--configuration]
                                             [--shortcut-status {Approved, Pending, Rejected}]
                                             [--shortcut-type {Entity, Network}]

Examples

Create or update a Fabric shortcut

az eventhubs eventhub fabric-shortcut create --resource-group contoso-rg --namespace-name contoso-eventhub --event-hub-name orders --fabric-shortcut-name orders-shortcut --configuration "{artifact-id:33333333-3333-3333-3333-333333333333,artifact-name:orders-eventstream,premium-capacity-id:44444444-4444-4444-4444-444444444444,tenant-id:11111111-1111-1111-1111-111111111111,workspace-id:22222222-2222-2222-2222-222222222222,workspace-name:contoso-workspace}" --shortcut-status Pending --shortcut-type Entity

Required Parameters

--event-hub-name

The Event Hub name.

--fabric-shortcut-name --name -n

The Microsoft Fabric shortcut name.

--namespace-name

The Namespace name.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--configuration

Microsoft Fabric workspace and artifact configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--shortcut-status

The current shortcut status. Only Pending can be supplied on create or update.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Approved, Pending, Rejected

--shortcut-type

The type of the shortcut.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Entity, Network

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az eventhubs eventhub fabric-shortcut delete

Delete a Microsoft Fabric shortcut.

az eventhubs eventhub fabric-shortcut delete [--acquire-policy-token]
                                             [--change-reference]
                                             [--event-hub-name]
                                             [--fabric-shortcut-name --name]
                                             [--ids]
                                             [--namespace-name]
                                             [--resource-group]
                                             [--subscription]
                                             [--yes]

Examples

Delete a Fabric shortcut

az eventhubs eventhub fabric-shortcut delete --resource-group contoso-rg --namespace-name contoso-eventhub --event-hub-name orders --fabric-shortcut-name orders-shortcut

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--event-hub-name

The Event Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--fabric-shortcut-name --name -n

The Microsoft Fabric shortcut name.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

The Namespace name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventhubs eventhub fabric-shortcut list

List Microsoft Fabric shortcuts for an Event Hub.

az eventhubs eventhub fabric-shortcut list --event-hub-name
                                           --namespace-name
                                           --resource-group
                                           [--max-items]
                                           [--next-token]

Examples

List Fabric shortcuts for an Event Hub

az eventhubs eventhub fabric-shortcut list --resource-group contoso-rg --namespace-name contoso-eventhub --event-hub-name orders

Required Parameters

--event-hub-name

The Event Hub name.

--namespace-name

The Namespace name.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az eventhubs eventhub fabric-shortcut reject

Rejects a Microsoft Fabric shortcut.

az eventhubs eventhub fabric-shortcut reject [--acquire-policy-token]
                                             [--change-reference]
                                             [--event-hub-name]
                                             [--fabric-shortcut-name]
                                             [--ids]
                                             [--namespace-name]
                                             [--resource-group]
                                             [--subscription]

Examples

Reject a Fabric shortcut

az eventhubs eventhub fabric-shortcut reject --resource-group contoso-rg --namespace-name contoso-eventhub --event-hub-name orders --fabric-shortcut-name orders-shortcut

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--event-hub-name

The Event Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--fabric-shortcut-name

The Microsoft Fabric shortcut name.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

The Namespace name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventhubs eventhub fabric-shortcut show

Get a Microsoft Fabric shortcut.

az eventhubs eventhub fabric-shortcut show [--event-hub-name]
                                           [--fabric-shortcut-name --name]
                                           [--ids]
                                           [--namespace-name]
                                           [--resource-group]
                                           [--subscription]

Examples

Get a Fabric shortcut

az eventhubs eventhub fabric-shortcut show --resource-group contoso-rg --namespace-name contoso-eventhub --event-hub-name orders --fabric-shortcut-name orders-shortcut

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--event-hub-name

The Event Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--fabric-shortcut-name --name -n

The Microsoft Fabric shortcut name.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

The Namespace name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az eventhubs eventhub fabric-shortcut update

Update a Microsoft Fabric shortcut.

az eventhubs eventhub fabric-shortcut update [--acquire-policy-token]
                                             [--add]
                                             [--change-reference]
                                             [--configuration]
                                             [--event-hub-name]
                                             [--fabric-shortcut-name --name]
                                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--ids]
                                             [--namespace-name]
                                             [--remove]
                                             [--resource-group]
                                             [--set]
                                             [--shortcut-status {Approved, Pending, Rejected}]
                                             [--shortcut-type {Entity, Network}]
                                             [--subscription]

Examples

Create or update a Fabric shortcut

az eventhubs eventhub fabric-shortcut update --resource-group contoso-rg --namespace-name contoso-eventhub --event-hub-name orders --fabric-shortcut-name orders-shortcut

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--configuration

Microsoft Fabric workspace and artifact configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--event-hub-name

The Event Hub name.

Property	Value
Parameter group:	Resource Id Arguments

--fabric-shortcut-name --name -n

The Microsoft Fabric shortcut name.

Property	Value
Parameter group:	Resource Id Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

Property	Value
Parameter group:	Resource Id Arguments

--namespace-name

The Namespace name.

Property	Value
Parameter group:	Resource Id Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--shortcut-status

The current shortcut status. Only Pending can be supplied on create or update.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Approved, Pending, Rejected

--shortcut-type

The type of the shortcut.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Entity, Network

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False