你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az orbital contact-profile

注意

此参考是 Azure CLI(版本 2.39.0 或更高版本)的轨道扩展的一部分。 该扩展将在首次运行 az orbital contact-profile 命令时自动安装。 详细了解扩展。

联系人配置文件是可重用的联系人配置。

命令

名称 说明 类型 状态
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

联系人的最小可行提升(以十进制度为单位)。 用于列出在给定地面站与航天器可用的接触。

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

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 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

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 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

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--links

联系人配置文件的链接。 介绍 RF 链接、调制解调器处理和 IP 终结点。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。

--location -l

资源所在的地理位置。

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

联系人的最小可行提升(以十进制度为单位)。 用于列出在给定地面站与航天器可用的接触。

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

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False
--exists

等待资源存在。

默认值: False
--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 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 获取完整的调试日志。