az fluid-relay server

Note

This reference is part of the fluid-relay extension for the Azure CLI (version 2.39.0 or higher). The extension will automatically install the first time you run an az fluid-relay server command. Learn more about extensions.

Manage Fluid Relay Server.

Commands

Name	Description	Type	Status
az fluid-relay server create	Create a Fluid Relay server.	Extension	GA
az fluid-relay server delete	Delete a Fluid Relay server.	Extension	GA
az fluid-relay server list	List all Fluid Relay servers.	Extension	GA
az fluid-relay server list-key	Get primary and secondary key for this server.	Extension	GA
az fluid-relay server regenerate-key	Regenerate the primary or secondary key for this server.	Extension	GA
az fluid-relay server show	Get a Fluid Relay server.	Extension	GA
az fluid-relay server update	Update a Fluid Relay server.	Extension	GA

az fluid-relay server create

Create a Fluid Relay server.

az fluid-relay server create --name --server-name
                             --resource-group
                             [--identity]
                             [--key-identity]
                             [--key-url]
                             [--location]
                             [--provisioning-state {Canceled, Failed, Succeeded}]
                             [--sku {basic, standard}]
                             [--tags]

Examples

FluidRelayServer_Create

az fluid-relay server create -n TestFluidRelay -l westus2 -g MyResourceGroup --sku standard --tags category=sales --identity type="SystemAssigned"
az fluid-relay server create -n TestFluidRelay -l westus2 -g MyResourceGroup --sku standard --tags category=sales --identity type="SystemAssigned, UserAssigned" user-assigned-identities={"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1","/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2"}

Required Parameters

--name --server-name -n

The Fluid Relay server resource 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.

--identity

The type of identity used for the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

--key-identity

All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	CustomerManagedKeyEncryption Arguments

--key-url

Key encryption key Url, with or without a version. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. Key auto rotation is enabled by providing a key uri without version. Otherwise, customer is responsible for rotating the key. The keyEncryptionKeyIdentity(either SystemAssigned or UserAssigned) should have permission to access this key url.

Property	Value
Parameter group:	CustomerManagedKeyEncryption Arguments

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Resource Arguments

--provisioning-state

Provision states for FluidRelay RP.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Canceled, Failed, Succeeded

--sku

Sku of the storage associated with the resource.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	basic, standard

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource 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 fluid-relay server delete

Delete a Fluid Relay server.

az fluid-relay server delete [--ids]
                             [--name --server-name]
                             [--resource-group]
                             [--subscription]
                             [--yes]

Examples

FluidRelayServer_Delete

az fluid-relay server delete -n testFluidRelay -g MyResourceGroup -y

Optional Parameters

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

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

--name --server-name -n

The Fluid Relay server resource 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 fluid-relay server list

List all Fluid Relay servers.

az fluid-relay server list [--resource-group]

Examples

FluidRelayServer_List

az fluid-relay server list --subscription 00000000-0000-0000-0000-000000000000
az fluid-relay server list -g MyResourceGroup

Optional Parameters

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

--resource-group -g

The resource group containing the resource.

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 fluid-relay server list-key

Get primary and secondary key for this server.

az fluid-relay server list-key --resource-group
                               --server-name

Examples

FluidRelayServer_List-key

az fluid-relay server list-key -g MyResourceGroup --server-name MyServerName

Required Parameters

--resource-group -g

The resource group containing the resource.

--server-name -n

The Fluid Relay server resource name.

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 fluid-relay server regenerate-key

Regenerate the primary or secondary key for this server.

az fluid-relay server regenerate-key --key-name {key1, key2}
                                     --resource-group
                                     --server-name

Examples

FluidRelayServer_Regenerate-key

az fluid-relay server regenerate-key -g MyResourceGroup --server-name MyServerName --key-name key1

Required Parameters

--key-name

The key to regenerate.

Property	Value
Parameter group:	Parameters Arguments
Accepted values:	key1, key2

--resource-group -g

The resource group containing the resource.

--server-name -n

The Fluid Relay server resource name.

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 fluid-relay server show

Get a Fluid Relay server.

az fluid-relay server show [--ids]
                           [--name --server-name]
                           [--resource-group]
                           [--subscription]

Examples

FluidRelayServer_Show

az fluid-relay server show -g MyResourceGroup -n MyFluidRelay

Optional Parameters

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

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

--name --server-name -n

The Fluid Relay server resource 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 fluid-relay server update

Update a Fluid Relay server.

az fluid-relay server update [--identity]
                             [--ids]
                             [--key-identity]
                             [--key-url]
                             [--location]
                             [--name --server-name]
                             [--resource-group]
                             [--subscription]
                             [--tags]

Examples

FluidRelayServer_Update

az fluid-relay server update -n MyFluidRelay -l westus2 -g MyResourceGroup --tags category=sale

Optional Parameters

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

--identity

The type of identity used for the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource 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

--key-identity

All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	CustomerManagedKeyEncryption Arguments

--key-url

Key encryption key Url, with or without a version. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. Key auto rotation is enabled by providing a key uri without version. Otherwise, customer is responsible for rotating the key. The keyEncryptionKeyIdentity(either SystemAssigned or UserAssigned) should have permission to access this key url.

Property	Value
Parameter group:	CustomerManagedKeyEncryption Arguments

--location

The geo-location where the resource lives.

Property	Value
Parameter group:	Resource Arguments

--name --server-name -n

The Fluid Relay server resource 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

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource 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