Partilhar via


az fluid-relay server

Note

Essa referência faz parte da extensão fluid-relay para a CLI do Azure (versão 2.39.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az fluid-relay server. Saiba mais sobre extensões.

Gerencie o Fluid Relay Server.

Comandos

Name Description Tipo Status
az fluid-relay server create

Crie um servidor Fluid Relay.

Extension disponibilidade geral
az fluid-relay server delete

Exclua um servidor Fluid Relay.

Extension disponibilidade geral
az fluid-relay server list

Liste todos os servidores Fluid Relay.

Extension disponibilidade geral
az fluid-relay server list-key

Obtenha a chave primária e secundária para este servidor.

Extension disponibilidade geral
az fluid-relay server regenerate-key

Regenere a chave primária ou secundária para este servidor.

Extension disponibilidade geral
az fluid-relay server show

Obtenha um servidor Fluid Relay.

Extension disponibilidade geral
az fluid-relay server update

Atualize um servidor Fluid Relay.

Extension disponibilidade geral

az fluid-relay server create

Crie um servidor Fluid Relay.

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]

Exemplos

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

Parâmetros Obrigatórios

--name --server-name -n

O nome do recurso do servidor Fluid Relay.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--identity

O tipo de identidade usado para o recurso. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Resource Arguments
--key-identity

Toda a configuração de identidade para configurações de chave gerenciadas pelo cliente definindo qual identidade deve ser usada para autenticação no Cofre de Chaves. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: CustomerManagedKeyEncryption Arguments
--key-url

URL da chave de encriptação da chave, com ou sem uma versão. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 ou https://contosovault.vault.azure.net/keys/contosokek. A rotação automática de chaves é ativada fornecendo um uri de chave sem versão. Caso contrário, o cliente é responsável por girar a chave. A keyEncryptionKeyIdentity(SystemAssigned ou UserAssigned) deve ter permissão para acessar essa url de chave.

Propriedade Valor
Grupo de parâmetros: CustomerManagedKeyEncryption Arguments
--location -l

A localização geográfica onde o recurso reside Quando não especificada, a localização do grupo de recursos será usada.

Propriedade Valor
Grupo de parâmetros: Resource Arguments
--provisioning-state

Estados de provisão para FluidRelay RP.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceites: Canceled, Failed, Succeeded
--sku

Sku do armazenamento associado ao recurso.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceites: basic, standard
--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Resource Arguments
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az fluid-relay server delete

Exclua um servidor Fluid Relay.

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

Exemplos

FluidRelayServer_Delete

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name --server-name -n

O nome do recurso do servidor Fluid Relay.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az fluid-relay server list

Liste todos os servidores Fluid Relay.

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

Exemplos

FluidRelayServer_List

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--resource-group -g

O grupo de recursos que contém o recurso.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az fluid-relay server list-key

Obtenha a chave primária e secundária para este servidor.

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

Exemplos

FluidRelayServer_List-key

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

Parâmetros Obrigatórios

--resource-group -g

O grupo de recursos que contém o recurso.

--server-name -n

O nome do recurso do servidor Fluid Relay.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az fluid-relay server regenerate-key

Regenere a chave primária ou secundária para este servidor.

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

Exemplos

FluidRelayServer_Regenerate-key

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

Parâmetros Obrigatórios

--key-name

A chave para regenerar.

Propriedade Valor
Grupo de parâmetros: Parameters Arguments
Valores aceites: key1, key2
--resource-group -g

O grupo de recursos que contém o recurso.

--server-name -n

O nome do recurso do servidor Fluid Relay.

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az fluid-relay server show

Obtenha um servidor Fluid Relay.

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

Exemplos

FluidRelayServer_Show

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name --server-name -n

O nome do recurso do servidor Fluid Relay.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az fluid-relay server update

Atualize um servidor Fluid Relay.

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

Exemplos

FluidRelayServer_Update

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--identity

O tipo de identidade usado para o recurso. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Resource Arguments
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo que contenha todas as informações dos argumentos do 'ID de recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--key-identity

Toda a configuração de identidade para configurações de chave gerenciadas pelo cliente definindo qual identidade deve ser usada para autenticação no Cofre de Chaves. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: CustomerManagedKeyEncryption Arguments
--key-url

URL da chave de encriptação da chave, com ou sem uma versão. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 ou https://contosovault.vault.azure.net/keys/contosokek. A rotação automática de chaves é ativada fornecendo um uri de chave sem versão. Caso contrário, o cliente é responsável por girar a chave. A keyEncryptionKeyIdentity(SystemAssigned ou UserAssigned) deve ter permissão para acessar essa url de chave.

Propriedade Valor
Grupo de parâmetros: CustomerManagedKeyEncryption Arguments
--location

A geolocalização onde o recurso vive.

Propriedade Valor
Grupo de parâmetros: Resource Arguments
--name --server-name -n

O nome do recurso do servidor Fluid Relay.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Resource Arguments
Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False