你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Spacecrafts - List Available Contacts
返回可用联系人的列表。 如果航天器在地面站中可见的接触持续时间超过联系人配置文件中提供的最小可行接触持续时间,则联系人可用。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/listAvailableContacts?api-version=2022-11-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 名称不区分大小写。 |
spacecraft
|
path | True |
string |
航天器 ID。 |
subscription
|
path | True |
string minLength: 1 |
目标订阅的 ID。 |
api-version
|
query | True |
string minLength: 1 |
用于此作的 API 版本。 |
请求正文
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
contactProfile | True |
对联系人配置文件资源的引用。 |
|
endTime | True |
string (date-time) |
联系人的结束时间(ISO 8601 UTC 标准)。 |
groundStationName | True |
string |
Azure 地面站的名称。 |
startTime | True |
string (date-time) |
联系人开始时间(ISO 8601 UTC 标准)。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
请求成功。 该作返回可用联系人资源的列表。 |
|
202 Accepted |
接受且作将以异步方式完成。 标头 Location: string |
|
Other Status Codes |
描述作失败的原因的错误响应。 如果资源组不存在,将返回 404 (NotFound)。 |
示例
List of Contact
示例请求
POST https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/listAvailableContacts?api-version=2022-11-01
{
"contactProfile": {
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"
},
"groundStationName": "EASTUS2_0",
"startTime": "2022-11-01T11:30:00Z",
"endTime": "2022-11-02T11:30:00Z"
}
示例响应
Location: https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01
{
"value": [
{
"spacecraft": {
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"
},
"groundStationName": "EASTUS2_0",
"properties": {
"maximumElevationDegrees": 26.617297,
"txStartTime": "2022-11-01T11:55:01Z",
"txEndTime": "2022-11-01T12:05:25Z",
"rxStartTime": "2022-11-01T11:55:01Z",
"rxEndTime": "2022-11-01T12:05:25Z",
"startAzimuthDegrees": 201.340472,
"endAzimuthDegrees": 330.489627,
"startElevationDegrees": 5,
"endElevationDegrees": 5.040625
}
},
{
"spacecraft": {
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"
},
"groundStationName": "EASTUS2_0",
"properties": {
"maximumElevationDegrees": 85.9796,
"txStartTime": "2022-11-02T10:58:30Z",
"txEndTime": "2022-11-02T11:10:45Z",
"rxStartTime": "2022-11-02T10:58:30Z",
"rxEndTime": "2022-11-02T11:10:45Z",
"startAzimuthDegrees": 165.758896,
"endAzimuthDegrees": 345.848482,
"startElevationDegrees": 5,
"endElevationDegrees": 5.048656
}
}
],
"nextLink": "https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/listAvailableContacts?api-version=2022-11-01&$skiptoken=opaqueString"
}
定义
名称 | 说明 |
---|---|
Authorized |
授权地面站。 |
Auto |
自动跟踪配置。 |
Available |
客户检索航天器资源的可用联系人列表。 稍后可以选择其中一个可用联系人来创建联系人。 |
Available |
ListAvailableContacts API 服务调用的响应。 |
Contact |
定义联系人资源的参数。 |
Contact |
对联系人配置文件资源的引用。 |
Contact |
客户创建联系人配置文件资源,其中包含安排联系人所需的所有配置。 |
Contact |
联系人配置文件链接。 |
Contact |
联系人配置文件链接通道。 |
Contact |
资源的创建、删除或修改的当前状态。 |
Contact |
联系配置文件第三方合作伙伴配置。 |
created |
创建资源的标识的类型。 |
direction |
方向(上行或下行)。 |
End |
客户终结点在与航天器接触期间存储和检索数据。 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Network |
客户虚拟网络的网络配置。 |
polarization |
极化。 例如(RHCP、LHCP)。 |
protocol |
协议 UDP 或 TCP。 |
Provisioning |
资源的创建、删除或修改的当前状态。 |
Spacecraft |
客户创建航天器资源来安排联系人。 |
Spacecraft |
每个地面站的授权航天器链接列表和授权的到期日期。 |
system |
与创建和上次修改资源相关的元数据。 |
AuthorizedGroundstation
授权地面站。
名称 | 类型 | 说明 |
---|---|---|
expirationDate |
string (date) |
授权到期日期。 |
groundStation |
string |
地面站名称。 |
AutoTrackingConfiguration
自动跟踪配置。
值 | 说明 |
---|---|
disabled | |
sBand | |
xBand |
AvailableContacts
客户检索航天器资源的可用联系人列表。 稍后可以选择其中一个可用联系人来创建联系人。
名称 | 类型 | 说明 |
---|---|---|
groundStationName |
string |
Azure 地面站的名称。 |
properties.endAzimuthDegrees |
number |
在接触结束时的天线的阿齐穆特(以十进制度为单位)。 |
properties.endElevationDegrees |
number |
接触端地平线上的航天器高程。 |
properties.maximumElevationDegrees |
number |
在接触期间天线的最大高程(以十进制度为单位)。 |
properties.rxEndTime |
string (date-time) |
丢失接收信号的时间(ISO 8601 UTC 标准)。 |
properties.rxStartTime |
string (date-time) |
最早接收信号的时间(ISO 8601 UTC 标准)。 |
properties.startAzimuthDegrees |
number |
天线在小数度接触开始时的阿齐穆特。 |
properties.startElevationDegrees |
number |
在接触开始时,航天器在地平线上方的海拔高度。 |
properties.txEndTime |
string (date-time) |
天线传输将禁用的时间(ISO 8601 UTC 标准)。 |
properties.txStartTime |
string (date-time) |
将启用天线传输的时间(ISO 8601 UTC 标准)。 |
spacecraft |
对航天器资源的引用。 |
AvailableContactsListResult
ListAvailableContacts API 服务调用的响应。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
用于获取下一组结果的 URL。 |
value |
可用联系人的列表。 |
ContactParameters
定义联系人资源的参数。
名称 | 类型 | 说明 |
---|---|---|
contactProfile |
对联系人配置文件资源的引用。 |
|
endTime |
string (date-time) |
联系人的结束时间(ISO 8601 UTC 标准)。 |
groundStationName |
string |
Azure 地面站的名称。 |
startTime |
string (date-time) |
联系人开始时间(ISO 8601 UTC 标准)。 |
ContactParameters.ContactProfile
对联系人配置文件资源的引用。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
ContactProfile
客户创建联系人配置文件资源,其中包含安排联系人所需的所有配置。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
资源所在的地理位置 |
name |
string |
资源的名称 |
properties.autoTrackingConfiguration |
自动跟踪配置。 |
|
properties.eventHubUri |
string |
用于遥测的事件中心的 ARM 资源标识符。 需要向 Orbital 资源提供程序授予将遥测数据发送到中心的权限。 |
properties.links |
联系人配置文件的链接。 介绍 RF 链接、调制解调器处理和 IP 终结点。 |
|
properties.minimumElevationDegrees |
number |
联系人的最小可行提升(以十进制度为单位)。 用于列出在给定地面站与航天器可用的接触。 |
properties.minimumViableContactDuration |
string |
ISO 8601 格式的最小可行联系人持续时间。 用于列出在给定地面站与航天器可用的接触。 |
properties.networkConfiguration |
客户虚拟网络的网络配置。 |
|
properties.provisioningState |
资源的创建、删除或修改的当前状态。 |
|
properties.thirdPartyConfigurations |
联系人配置文件的第三方任务配置。 介绍 RF 链接、调制解调器处理和 IP 终结点。 |
|
systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
|
tags |
object |
资源标记。 |
type |
string |
资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
ContactProfileLink
联系人配置文件链接。
名称 | 类型 | 说明 |
---|---|---|
channels |
联系人配置文件链接通道。 |
|
direction |
方向(上行或下行)。 |
|
eirpdBW |
number |
dBW 中的有效异性辐射功率(EIRP)。 这是客户所需的 EIRP。 尚未使用。 |
gainOverTemperature |
number |
增益到 db/K 中的噪音温度。 这是客户所需的 G/T。 尚未使用。 |
name |
string |
链接名称。 |
polarization |
极化。 例如(RHCP、LHCP)。 |
ContactProfileLinkChannel
联系人配置文件链接通道。
名称 | 类型 | 说明 |
---|---|---|
bandwidthMHz |
number |
MHz 中的带宽。 |
centerFrequencyMHz |
number |
以 MHz 为单位的中心频率。 |
decodingConfiguration |
string |
当前未使用。 |
demodulationConfiguration |
string |
调制解调器配置文件的副本,例如 Kratos QRadio 或 Kratos QuantumRx。 仅适用于下行路线。 如果提供,调制解调器将连接到客户终结点,并发送演示的数据,而不是 VITA.49 流。 |
encodingConfiguration |
string |
当前未使用。 |
endPoint |
客户终结点在与航天器接触期间存储和检索数据。 |
|
modulationConfiguration |
string |
调制解调器配置文件的副本,例如 Kratos QRadio。 仅对上行路线有效。 如果提供,调制解调器将连接到客户终结点,并接受来自客户的命令,而不是 VITA.49 流。 |
name |
string |
渠道名称。 |
ContactProfilesProperties.ProvisioningState
资源的创建、删除或修改的当前状态。
ContactProfileThirdPartyConfiguration
联系配置文件第三方合作伙伴配置。
名称 | 类型 | 说明 |
---|---|---|
missionConfiguration |
string |
引用描述特定任务的联系人设置的配置的字符串的名称。 预期值是与合作伙伴网络协作创建的值。 |
providerName |
string |
第三方提供程序的名称。 |
createdByType
创建资源的标识的类型。
值 | 说明 |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
direction
方向(上行或下行)。
值 | 说明 |
---|---|
Downlink | |
Uplink |
EndPoint
客户终结点在与航天器接触期间存储和检索数据。
名称 | 类型 | 说明 |
---|---|---|
endPointName |
string |
终结点的名称。 |
ipAddress |
string |
IP 地址(IPv4)。 |
port |
string |
要侦听以接收数据的 TCP 端口。 |
protocol |
协议 UDP 或 TCP。 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
NetworkConfiguration
客户虚拟网络的网络配置。
名称 | 类型 | 说明 |
---|---|---|
subnetId |
string |
委托给 Microsoft.Orbital/orbitalGateways 的子网的 ARM 资源标识符。 至少必须是 C 类子网,并且不应在其中创建任何 IP。 |
polarization
极化。 例如(RHCP、LHCP)。
值 | 说明 |
---|---|
LHCP | |
RHCP | |
linearHorizontal | |
linearVertical |
protocol
协议 UDP 或 TCP。
值 | 说明 |
---|---|
TCP | |
UDP |
ProvisioningState
资源的创建、删除或修改的当前状态。
Spacecraft
客户创建航天器资源来安排联系人。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
资源所在的地理位置 |
name |
string |
资源的名称 |
properties.links |
航天器链接的不可变列表。 |
|
properties.noradId |
string |
航天器的 NORAD ID。 |
properties.provisioningState |
资源的创建、删除或修改的当前状态。 |
|
properties.titleLine |
string |
双行元素集(TLE)的标题行。 |
properties.tleLine1 |
string |
双行元素集 (TLE) 的第 1 行。 |
properties.tleLine2 |
string |
双行元素集 (TLE) 的第 2 行。 |
systemData |
包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 |
|
tags |
object |
资源标记。 |
type |
string |
资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
SpacecraftLink
每个地面站的授权航天器链接列表和授权的到期日期。
名称 | 类型 | 说明 |
---|---|---|
authorizations |
授权地面站 |
|
bandwidthMHz |
number |
MHz 中的带宽。 |
centerFrequencyMHz |
number |
以 MHz 为单位的中心频率。 |
direction |
方向(上行或下行)。 |
|
name |
string |
链接名称。 |
polarization |
极化。 例如(RHCP、LHCP)。 |
systemData
与创建和上次修改资源相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string (date-time) |
资源创建时间戳(UTC)。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识的类型。 |
|
lastModifiedAt |
string (date-time) |
上次修改的资源时间戳(UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识的类型。 |