az fluid-relay server

リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.39.0 以降) の流体リレー拡張機能の一部です。拡張機能は、az fluid-relay サーバー コマンドを初めて実行するときに自動的にインストールされます。拡張機能の詳細をご覧ください。

流体リレーサーバを管理します。

コマンド

名前	説明	型	状態
az fluid-relay server create	Fluid Relay サーバーを作成します。	拡張	GA
az fluid-relay server delete	Fluid Relay サーバーを削除します。	拡張	GA
az fluid-relay server list	すべての流体リレーサーバを一覧表示します。	拡張	GA
az fluid-relay server list-key	このサーバーのプライマリキーとセカンダリキーを取得します。	拡張	GA
az fluid-relay server regenerate-key	このサーバーのプライマリキーまたはセカンダリキーを再生成します。	拡張	GA
az fluid-relay server show	Fluid Relay サーバーを取得します。	拡張	GA
az fluid-relay server update	Fluid Relay サーバーを更新します。	拡張	GA

az fluid-relay server create

Fluid Relay サーバーを作成します。

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

例

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

必須のパラメーター

--name --server-name -n

Fluid Relay サーバーリソース名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

省略可能のパラメーター

--identity

リソースに使用される ID の種類。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--key-identity

Key Vault への認証に使用する ID を定義するカスタマーマネージドキー設定のすべての ID 構成。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--key-url

バージョンの有無にかかわらず、キー暗号化キーの URL。例: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 または https://contosovault.vault.azure.net/keys/contosokek. キーの自動ローテーションは、バージョンのないキー URI を指定することで有効になります。それ以外の場合、お客様はキーを交換する責任を負います。 keyEncryptionKeyIdentity (SystemAssigned または UserAssigned) には、このキー URL にアクセスするためのアクセス許可が必要です。

--location -l

リソースが存在する地理的な場所を指定しない場合は、リソースグループの場所が使用されます。

--provisioning-state

FluidRelay RP の状態をプロビジョニングします。

指定可能な値: Canceled, Failed, Succeeded

--sku

リソースに関連付けられているストレージの SKU。

指定可能な値: basic, standard

--tags

リソースタグ。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az fluid-relay server delete

Fluid Relay サーバーを削除します。

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

例

FluidRelayServer_Delete

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

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name --server-name -n

Fluid Relay サーバーリソース名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--yes -y

確認のダイアログを表示しません。

規定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az fluid-relay server list

すべての流体リレーサーバを一覧表示します。

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

例

FluidRelayServer_List

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

省略可能のパラメーター

--resource-group -g

リソースを含むリソースグループ。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az fluid-relay server list-key

このサーバーのプライマリキーとセカンダリキーを取得します。

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

例

FluidRelayServer_List-key

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

必須のパラメーター

--resource-group -g

リソースを含むリソースグループ。

--server-name -n

Fluid Relay サーバーリソース名。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az fluid-relay server regenerate-key

このサーバーのプライマリキーまたはセカンダリキーを再生成します。

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

例

FluidRelayServer_Regenerate-key

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

必須のパラメーター

--key-name

再生成するキー。

指定可能な値: key1, key2

--resource-group -g

リソースを含むリソースグループ。

--server-name -n

Fluid Relay サーバーリソース名。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az fluid-relay server show

Fluid Relay サーバーを取得します。

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

例

FluidRelayServer_Show

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

省略可能のパラメーター

--ids

--name --server-name -n

Fluid Relay サーバーリソース名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az fluid-relay server update

Fluid Relay サーバーを更新します。

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

例

FluidRelayServer_Update

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

省略可能のパラメーター

--identity

リソースに使用される ID の種類。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--ids

--key-identity

--key-url

--location

リソースが存在する地理的な場所。

--name --server-name -n

Fluid Relay サーバーリソース名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--tags

リソースタグ。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

次の方法で共有

az fluid-relay server

コマンド

az fluid-relay server create

例

必須のパラメーター

省略可能のパラメーター

az fluid-relay server delete

例

省略可能のパラメーター

az fluid-relay server list

例

省略可能のパラメーター

az fluid-relay server list-key

例

必須のパラメーター

az fluid-relay server regenerate-key

例

必須のパラメーター

az fluid-relay server show

例

省略可能のパラメーター

az fluid-relay server update

例

省略可能のパラメーター

その他のリソース