Contacts - Create
Создает контакт.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/contacts/{contactName}?api-version=2022-11-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
contact
|
path | True |
string |
Имя контакта. |
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
spacecraft
|
path | True |
string |
Идентификатор космического аппарата. |
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
properties.contactProfile | True |
Ссылка на ресурс профиля контакта. |
|
properties.groundStationName | True |
string |
Имя наземной станции Azure. |
properties.reservationEndTime | True |
string |
Время окончания резервирования контакта (стандарт ISO 8601 UTC). |
properties.reservationStartTime | True |
string |
Время начала резервирования контакта (стандарт ISO 8601 UTC). |
properties.provisioningState |
Текущее состояние создания, удаления или изменения ресурса. |
Ответы
Имя | Тип | Описание |
---|---|---|
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
}
}
Определения
Имя | Описание |
---|---|
Antenna |
Конфигурация, связанная с выделенной антенной. |
Contact |
Клиент создает контактный ресурс для ресурса космического аппарата. |
Contact |
Ссылка на ресурс профиля контакта. |
Contacts |
Состояние контакта. |
created |
Тип удостоверения, создавшего ресурс. |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Сообщение об ошибке |
Provisioning |
Текущее состояние создания, удаления или изменения ресурса. |
system |
Метаданные, относящиеся к созданию и последнему изменению ресурса. |
AntennaConfiguration
Конфигурация, связанная с выделенной антенной.
Имя | Тип | Описание |
---|---|---|
destinationIp |
string |
IP-адрес назначения, на который можно отправить пакет. Это может быть, например, конечная точка TCP, в который вы будете отправлять данные. |
sourceIps |
string[] |
Список исходных IP-адресов |
Contact
Клиент создает контактный ресурс для ресурса космического аппарата.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Имя ресурса. |
properties.antennaConfiguration |
Конфигурация, связанная с выделенной антенной. |
|
properties.contactProfile |
Ссылка на ресурс профиля контакта. |
|
properties.endAzimuthDegrees |
number |
Азимут антенны в конце контакта в десятичных градусах. |
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 |
Азимут антенны в начале контакта в десятичных градусах. |
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
Ссылка на ресурс профиля контакта.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса. |
ContactsStatus
Состояние контакта.
Имя | Тип | Описание |
---|---|---|
cancelled |
string |
|
failed |
string |
|
providerCancelled |
string |
|
scheduled |
string |
|
succeeded |
string |
createdByType
Тип удостоверения, создавшего ресурс.
Имя | Тип | Описание |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
error |
Объект error. |
ProvisioningState
Текущее состояние создания, удаления или изменения ресурса.
systemData
Метаданные, относящиеся к созданию и последнему изменению ресурса.
Имя | Тип | Описание |
---|---|---|
createdAt |
string |
Метка времени создания ресурса (UTC). |
createdBy |
string |
Удостоверение, создающее ресурс. |
createdByType |
Тип удостоверения, создавшего ресурс. |
|
lastModifiedAt |
string |
Метка времени последнего изменения ресурса (UTC) |
lastModifiedBy |
string |
Удостоверение, которое последним изменял ресурс. |
lastModifiedByType |
Тип удостоверения, которое последним изменял ресурс. |