Contacts - Create
建立連絡人。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/contacts/{contactName}?api-version=2022-11-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
contact
|
path | True |
string |
聯繫人名稱。 |
resource
|
path | True |
string |
資源群組的名稱。 名稱不區分大小寫。 |
spacecraft
|
path | True |
string |
新月標識碼。 |
subscription
|
path | True |
string |
目標訂用帳戶的標識碼。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
要求本文
名稱 | 必要 | 類型 | Description |
---|---|---|---|
properties.contactProfile | True |
連絡人配置檔資源的參考。 |
|
properties.groundStationName | True |
string |
Azure 地面站名稱。 |
properties.reservationEndTime | True |
string |
聯繫人的保留結束時間 (ISO 8601 UTC 標準) 。 |
properties.reservationStartTime | True |
string |
聯繫人的保留開始時間 (ISO 8601 UTC 標準) 。 |
properties.provisioningState |
資源的建立、刪除或修改目前狀態。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
正常。 |
|
201 Created |
建立成功。 作業會傳回產生的聯繫人資源。 Headers Azure-AsyncOperation: string |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
範例
Create a contact
Sample Request
PUT https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1?api-version=2022-11-01
{
"properties": {
"reservationStartTime": "2023-02-22T10:58:30Z",
"reservationEndTime": "2023-02-22T11:10:45Z",
"groundStationName": "EASTUS2_0",
"contactProfile": {
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"
}
}
}
Sample Response
Azure-AsyncOperation: https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01
{
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1",
"name": "contact1",
"type": "Microsoft.Orbital/spacecrafts/contacts",
"properties": {
"status": "scheduled",
"reservationStartTime": "2023-02-22T10:58:30Z",
"reservationEndTime": "2023-02-22T11:10:45Z",
"errorMessage": null,
"groundStationName": "EASTUS2_0",
"contactProfile": {
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"
},
"antennaConfiguration": null,
"maximumElevationDegrees": 85.9796,
"txStartTime": "2023-02-22T10:58:30Z",
"txEndTime": "2023-02-22T11:10:45Z",
"rxStartTime": "2023-02-22T10:58:30Z",
"rxEndTime": "2023-02-22T11:10:45Z",
"startAzimuthDegrees": 165.758896,
"endAzimuthDegrees": 345.848482,
"startElevationDegrees": 5,
"endElevationDegrees": 5.048656
}
}
Azure-AsyncOperation: https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01
{
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1",
"name": "contact1",
"type": "Microsoft.Orbital/spacecrafts/contacts",
"properties": {
"status": "scheduled",
"reservationStartTime": "2023-02-22T10:58:30Z",
"reservationEndTime": "2023-02-22T11:10:45Z",
"errorMessage": null,
"groundStationName": "EASTUS2_0",
"contactProfile": {
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"
},
"antennaConfiguration": null,
"maximumElevationDegrees": 0,
"txStartTime": null,
"txEndTime": null,
"rxStartTime": null,
"rxEndTime": null,
"startAzimuthDegrees": 0,
"endAzimuthDegrees": 0,
"startElevationDegrees": 0,
"endElevationDegrees": 0
}
}
定義
名稱 | Description |
---|---|
Antenna |
與配置之天線相關聯的組態。 |
Contact |
客戶會建立一個聯繫人資源來取得一個資源。 |
Contact |
連絡人配置檔資源的參考。 |
Contacts |
聯繫人的狀態。 |
created |
建立資源的身分識別類型。 |
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Provisioning |
資源的建立、刪除或修改目前狀態。 |
system |
與建立和上次修改資源相關的元數據。 |
AntennaConfiguration
與配置之天線相關聯的組態。
名稱 | 類型 | Description |
---|---|---|
destinationIp |
string |
封包可以傳送至的目的地IP。 例如,這是您要傳送數據的 TCP 端點。 |
sourceIps |
string[] |
來源IP清單 |
Contact
客戶會建立一個聯繫人資源來取得一個資源。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源的完整資源識別碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
資源的名稱 |
properties.antennaConfiguration |
與配置之天線相關聯的組態。 |
|
properties.contactProfile |
連絡人配置檔資源的參考。 |
|
properties.endAzimuthDegrees |
number |
以十進制度為單位的接觸結尾的天線 Azimuth。 |
properties.endElevationDegrees |
number |
在接觸端的水準線上方提高許可權。 |
properties.errorMessage |
string |
排程聯繫人時的任何錯誤訊息。 |
properties.groundStationName |
string |
Azure 地面站名稱。 |
properties.maximumElevationDegrees |
number |
在接觸期間以十進制度為單位的最大天線高度。 |
properties.provisioningState |
資源的建立、刪除或修改目前狀態。 |
|
properties.reservationEndTime |
string |
聯繫人的保留結束時間 (ISO 8601 UTC 標準) 。 |
properties.reservationStartTime |
string |
聯繫人的保留開始時間 (ISO 8601 UTC 標準) 。 |
properties.rxEndTime |
string |
接收聯繫人的結束時間, (ISO 8601 UTC 標準) 。 |
properties.rxStartTime |
string |
接收聯繫人的開始時間, (ISO 8601 UTC 標準) 。 |
properties.startAzimuthDegrees |
number |
Azimuth,以十進制度為單位的接觸點開頭。 |
properties.startElevationDegrees |
number |
在聯繫人開始時,水平線上方的高度。 |
properties.status |
聯繫人的狀態。 |
|
properties.txEndTime |
string |
傳輸聯繫人的結束時間 (ISO 8601 UTC 標準) 。 |
properties.txStartTime |
string |
傳輸聯繫人的開始時間, (ISO 8601 UTC 標準) 。 |
systemData |
Azure Resource Manager 包含 createdBy 和 modifiedBy 資訊的中繼資料。 |
|
type |
string |
資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
ContactProfile
連絡人配置檔資源的參考。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源識別碼。 |
ContactsStatus
聯繫人的狀態。
名稱 | 類型 | Description |
---|---|---|
cancelled |
string |
|
failed |
string |
|
providerCancelled |
string |
|
scheduled |
string |
|
succeeded |
string |
createdByType
建立資源的身分識別類型。
名稱 | 類型 | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細資料。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
錯誤物件。 |
ProvisioningState
資源的建立、刪除或修改目前狀態。
systemData
與建立和上次修改資源相關的元數據。
名稱 | 類型 | Description |
---|---|---|
createdAt |
string |
資源建立的時間戳 (UTC) 。 |
createdBy |
string |
建立資源的身分識別。 |
createdByType |
建立資源的身分識別類型。 |
|
lastModifiedAt |
string |
上次修改的資源時間戳 (UTC) |
lastModifiedBy |
string |
上次修改資源的身分識別。 |
lastModifiedByType |
上次修改資源的身分識別類型。 |