次の方法で共有

az orbital contact-profile

  • リファレンス

Note

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

連絡先プロファイルは、再利用可能な連絡先構成です。

コマンド

名前 説明 型 Status
az orbital contact-profile create

連絡先プロファイルを作成します。

 拡張 GA
az orbital contact-profile delete

指定した連絡先プロファイル リソースを削除します。

 拡張 GA
az orbital contact-profile list

連絡先プロファイルを一覧表示します。

 拡張 GA
az orbital contact-profile show

指定したリソース グループ内の指定した連絡先プロファイルを取得します。

 拡張 GA
az orbital contact-profile update

連絡先プロファイルを更新します。

 拡張 GA
az orbital contact-profile wait

条件が満たされるまで CLI を待機状態にします。

 拡張 GA

az orbital contact-profile create

連絡先プロファイルを作成します。

az orbital contact-profile create --contact-profile-name
                                  --resource-group
                                  [--auto-tracking {disabled, sBand, xBand}]
                                  [--event-hub-uri]
                                  [--links]
                                  [--location]
                                  [--min-elevation]
                                  [--min-viable-duration]
                                  [--network-configuration]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--tags]

例

コンタクト プロファイルを作成する

az orbital contact-profile create --resource-group <resource-group> --name <contact-profile-name> --location "westus2" --auto-tracking-configuration "disabled" --event-hub-uri <event-hub-resource-identifier> --network-configuration "{subnet-id:<subnet-id>}" --links "[{name:Link1,polarization:RHCP,direction:Downlink,channels:[{name:channel1,center-frequency-m-hz:8160,bandwidth-m-hz:15,end-point:{end-point-name:AQUA_directplayback,ip-address:10.0.0.4,port:50000,protocol:TCP}}]}]"

必須のパラメーター

--contact-profile-name --name -n

連絡先プロファイル名。

--resource-group -g

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

省略可能のパラメーター

--auto-tracking --auto-tracking-configuration

自動追跡の構成。

承認された値: disabled, sBand, xBand
--event-hub-uri

テレメトリに使用されるイベント ハブの ARM リソース識別子。 利用統計情報をハブに送信する権限を、Orbital リソース プロバイダーに付与する必要があります。

--links

連絡先プロファイルのリンク。 RF リンク、モデム処理、および IP エンドポイントについて説明します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--location -l

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

--min-elevation --minimum-elevation-degrees

接触の実行可能な最小標高 (10 進度)。 特定の地上局で宇宙船で使用可能な連絡先を一覧表示するために使用されます。

--min-viable-duration --minimum-viable-contact-duration

ISO 8601 形式の実行可能な最小連絡先期間。 特定の地上局で宇宙船で使用可能な連絡先を一覧表示するために使用されます。

--network-configuration

顧客仮想ネットワークのネットワーク構成。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--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 orbital contact-profile delete

指定した連絡先プロファイル リソースを削除します。

az orbital contact-profile delete [--contact-profile-name]
                                  [--ids]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--resource-group]
                                  [--subscription]
                                  [--yes]

例

連絡先プロファイルの削除

az orbital contact-profile delete -g <resource-group> -n <contact-profile-name>

省略可能のパラメーター

--contact-profile-name --name -n

連絡先プロファイル名。

--ids

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

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--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 orbital contact-profile list

連絡先プロファイルを一覧表示します。

az orbital contact-profile list [--resource-group]
                                [--skiptoken]

例

サブスクリプション別に連絡先プロファイルを一覧表示する

az orbital contact-profile list

リソース グループ別に連絡先プロファイルを一覧表示する

az orbital contact-profile list -g <resource-group>

省略可能のパラメーター

--resource-group -g

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

--skiptoken

リソース プロバイダーが以前に返された結果をスキップするために使用する不透明な文字列。 これは、前のリスト操作の呼び出しで部分的な結果が返されたときに使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定する skiptoken パラメーターが含まれます。

グローバル パラメーター
--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 orbital contact-profile show

指定したリソース グループ内の指定した連絡先プロファイルを取得します。

az orbital contact-profile show [--contact-profile-name]
                                [--ids]
                                [--resource-group]
                                [--subscription]

例

連絡先プロファイルを取得する

az orbital contact-profile show -g <resource-group> --name <contact-profile-name>

省略可能のパラメーター

--contact-profile-name --name -n

連絡先プロファイル名。

--ids

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

--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 orbital contact-profile update

連絡先プロファイルを更新します。

az orbital contact-profile update [--add]
                                  [--auto-tracking {disabled, sBand, xBand}]
                                  [--contact-profile-name]
                                  [--event-hub-uri]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--ids]
                                  [--links]
                                  [--location]
                                  [--min-elevation]
                                  [--min-viable-duration]
                                  [--network-configuration]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--remove]
                                  [--resource-group]
                                  [--set]
                                  [--subscription]
                                  [--tags]

例

連絡先プロファイル タグを更新する

az orbital contact-profile update --name <contact-profile-name> --resource-group <resource-group> --tags "{tag1:value1,tag2:value2}"

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value、string、または JSON 文字列>。

--auto-tracking --auto-tracking-configuration

自動追跡の構成。

承認された値: disabled, sBand, xBand
--contact-profile-name --name -n

連絡先プロファイル名。

--event-hub-uri

テレメトリに使用されるイベント ハブの ARM リソース識別子。 利用統計情報をハブに送信する権限を、Orbital リソース プロバイダーに付与する必要があります。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--ids

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

--links

連絡先プロファイルのリンク。 RF リンク、モデム処理、および IP エンドポイントについて説明します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--location -l

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

--min-elevation --minimum-elevation-degrees

接触の実行可能な最小標高 (10 進度)。 特定の地上局で宇宙船で使用可能な連絡先を一覧表示するために使用されます。

--min-viable-duration --minimum-viable-contact-duration

ISO 8601 形式の実行可能な最小連絡先期間。 特定の地上局で宇宙船で使用可能な連絡先を一覧表示するために使用されます。

--network-configuration

顧客仮想ネットワークのネットワーク構成。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。

--resource-group -g

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

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。

--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 orbital contact-profile wait

条件が満たされるまで CLI を待機状態にします。

az orbital contact-profile wait [--contact-profile-name]
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--ids]
                                [--interval]
                                [--resource-group]
                                [--subscription]
                                [--timeout]
                                [--updated]

省略可能のパラメーター

--contact-profile-name --name -n

連絡先プロファイル名。

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False
--exists

リソースが存在するまで待ちます。

既定値: False
--ids

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

--interval

ポーリング間隔 (秒単位)。

既定値: 30
--resource-group -g

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

--subscription

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

--timeout

最大待機時間 (秒単位)。

既定値: 3600
--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: 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 を使います。