Contact Profiles - Create Or Update

Создает или обновляет профиль контакта.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}?api-version=2022-11-01

Параметры URI

Имя В Обязательно Тип Описание
contactProfileName
path True

string

Имя профиля контакта.

resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

Версия API, используемая для данной операции.

Текст запроса

Имя Обязательно Тип Описание
location True

string

Географическое расположение, в котором находится ресурс

properties.links True

ContactProfileLink[]

Ссылки профиля контакта. Описывает rf-каналы, обработку модема и конечные точки IP.

properties.networkConfiguration True

NetworkConfiguration

Конфигурация сети виртуальной сети клиента.

properties.autoTrackingConfiguration

AutoTrackingConfiguration

Настройка автоматического отслеживания.

properties.eventHubUri

string

Идентификатор ресурса ARM концентратора событий, используемого для телеметрии. Требует предоставления поставщику ресурсов Orbital прав на отправку данных телеметрии в концентратор.

properties.minimumElevationDegrees

number

Минимальное допустимое повышение для контакта в десятичных градусах. Используется для перечисления доступных контактов с космическим аппаратом на данной наземной станции.

properties.minimumViableContactDuration

string

Минимальная жизнеспособная продолжительность контакта в формате ISO 8601. Используется для перечисления доступных контактов с космическим аппаратом на данной наземной станции.

properties.provisioningState

ProvisioningState

Текущее состояние создания, удаления или изменения ресурса.

properties.thirdPartyConfigurations

ContactProfileThirdPartyConfiguration[]

Конфигурация профиля контактов стороннего производителя. Описывает rf-каналы, обработку модема и конечные точки IP.

tags

object

Теги ресурсов.

Ответы

Имя Тип Описание
200 OK

ContactProfile

Обновление выполнено успешно. Операция возвращает результирующий ресурс ContactProfile.

201 Created

ContactProfile

Создание выполнено успешно. Операция возвращает результирующий ресурс ContactProfile.

Headers

Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

Примеры

Create a contact profile

Sample Request

PUT https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP?api-version=2022-11-01

{
  "location": "eastus2",
  "properties": {
    "minimumViableContactDuration": "PT1M",
    "minimumElevationDegrees": 5,
    "autoTrackingConfiguration": "disabled",
    "eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub",
    "networkConfiguration": {
      "subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"
    },
    "thirdPartyConfigurations": [
      {
        "providerName": "KSAT",
        "missionConfiguration": "Ksat_MissionConfiguration"
      },
      {
        "providerName": "VIASAT",
        "missionConfiguration": "Viasat_Configuration"
      }
    ],
    "links": [
      {
        "name": "contoso-uplink",
        "polarization": "LHCP",
        "direction": "Uplink",
        "gainOverTemperature": 0,
        "eirpdBW": 45,
        "channels": [
          {
            "name": "contoso-uplink-channel",
            "centerFrequencyMHz": 2250,
            "bandwidthMHz": 2,
            "endPoint": {
              "ipAddress": "10.1.0.4",
              "endPointName": "ContosoTest_Uplink",
              "port": "50000",
              "protocol": "TCP"
            }
          }
        ]
      },
      {
        "name": "contoso-downlink",
        "polarization": "RHCP",
        "direction": "Downlink",
        "gainOverTemperature": 25,
        "eirpdBW": 0,
        "channels": [
          {
            "name": "contoso-downlink-channel",
            "centerFrequencyMHz": 8160,
            "bandwidthMHz": 15,
            "endPoint": {
              "ipAddress": "10.1.0.5",
              "endPointName": "ContosoTest_Downlink",
              "port": "50001",
              "protocol": "UDP"
            }
          }
        ]
      }
    ]
  }
}

Sample Response

Azure-AsyncOperation: https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01
{
  "location": "eastus2",
  "tags": null,
  "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP",
  "name": "CONTOSO-CP",
  "type": "Microsoft.Orbital/contactProfiles",
  "properties": {
    "provisioningState": "updating",
    "minimumViableContactDuration": "PT1M",
    "minimumElevationDegrees": 5,
    "autoTrackingConfiguration": "disabled",
    "eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub",
    "networkConfiguration": {
      "subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"
    },
    "thirdPartyConfigurations": [
      {
        "providerName": "KSAT",
        "missionConfiguration": "Ksat_MissionConfiguration"
      },
      {
        "providerName": "VIASAT",
        "missionConfiguration": "Viasat_Configuration"
      }
    ],
    "links": [
      {
        "name": "contoso-uplink",
        "polarization": "LHCP",
        "direction": "Uplink",
        "gainOverTemperature": 0,
        "eirpdBW": 45,
        "channels": [
          {
            "name": "contoso-uplink-channel",
            "centerFrequencyMHz": 2250,
            "bandwidthMHz": 2,
            "endPoint": {
              "ipAddress": "10.1.0.4",
              "endPointName": "ContosoTest_Uplink",
              "port": "50000",
              "protocol": "TCP"
            },
            "modulationConfiguration": null,
            "demodulationConfiguration": null,
            "encodingConfiguration": null,
            "decodingConfiguration": null
          }
        ]
      },
      {
        "name": "contoso-downlink",
        "polarization": "RHCP",
        "direction": "Downlink",
        "gainOverTemperature": 25,
        "eirpdBW": 0,
        "channels": [
          {
            "name": "contoso-downlink-channel",
            "centerFrequencyMHz": 8160,
            "bandwidthMHz": 15,
            "endPoint": {
              "ipAddress": "10.1.0.5",
              "endPointName": "ContosoTest_Downlink",
              "port": "50001",
              "protocol": "UDP"
            },
            "modulationConfiguration": null,
            "demodulationConfiguration": null,
            "encodingConfiguration": null,
            "decodingConfiguration": null
          }
        ]
      }
    ]
  }
}
Azure-AsyncOperation: https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01
{
  "location": "eastus2",
  "tags": null,
  "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP",
  "name": "CONTOSO-CP",
  "type": "Microsoft.Orbital/contactProfiles",
  "properties": {
    "provisioningState": "succeeded",
    "minimumViableContactDuration": "PT1M",
    "minimumElevationDegrees": 5,
    "autoTrackingConfiguration": "disabled",
    "eventHubUri": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub",
    "networkConfiguration": {
      "subnetId": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"
    },
    "thirdPartyConfigurations": [
      {
        "providerName": "KSAT",
        "missionConfiguration": "Ksat_MissionConfiguration"
      },
      {
        "providerName": "VIASAT",
        "missionConfiguration": "Viasat_Configuration"
      }
    ],
    "links": [
      {
        "name": "contoso-uplink",
        "polarization": "LHCP",
        "direction": "Uplink",
        "gainOverTemperature": 0,
        "eirpdBW": 45,
        "channels": [
          {
            "name": "contoso-uplink-channel",
            "centerFrequencyMHz": 2250,
            "bandwidthMHz": 2,
            "endPoint": {
              "ipAddress": "10.1.0.4",
              "endPointName": "ContosoTest_Uplink",
              "port": "50000",
              "protocol": "TCP"
            },
            "modulationConfiguration": null,
            "demodulationConfiguration": null,
            "encodingConfiguration": null,
            "decodingConfiguration": null
          }
        ]
      },
      {
        "name": "contoso-downlink",
        "polarization": "RHCP",
        "direction": "Downlink",
        "gainOverTemperature": 25,
        "eirpdBW": 0,
        "channels": [
          {
            "name": "contoso-downlink-channel",
            "centerFrequencyMHz": 8160,
            "bandwidthMHz": 15,
            "endPoint": {
              "ipAddress": "10.1.0.5",
              "endPointName": "ContosoTest_Downlink",
              "port": "50001",
              "protocol": "UDP"
            },
            "modulationConfiguration": null,
            "demodulationConfiguration": null,
            "encodingConfiguration": null,
            "decodingConfiguration": null
          }
        ]
      }
    ]
  }
}

Определения

Имя Описание
AutoTrackingConfiguration

Настройка автоматического отслеживания.

ContactProfile

Клиент создает ресурс профиля контакта, который будет содержать все конфигурации, необходимые для планирования контакта.

ContactProfileLink

Ссылка на профиль контакта.

ContactProfileLinkChannel

Канал связи профиля контакта.

ContactProfileThirdPartyConfiguration

Конфигурация стороннего партнера профиля контакта.

createdByType

Тип удостоверения, создавшего ресурс.

direction

Направление (исходящей или нисходящей).

EndPoint

Конечная точка клиента для хранения и извлечения данных во время контакта с космическим аппаратом.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Сообщение об ошибке

NetworkConfiguration

Конфигурация сети виртуальной сети клиента.

polarization

Поляризации. например (RHCP, LHCP).

protocol

Протокол UDP или TCP.

ProvisioningState

Текущее состояние создания, удаления или изменения ресурса.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

AutoTrackingConfiguration

Настройка автоматического отслеживания.

Имя Тип Описание
disabled

string

sBand

string

xBand

string

ContactProfile

Клиент создает ресурс профиля контакта, который будет содержать все конфигурации, необходимые для планирования контакта.

Имя Тип Описание
id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Географическое расположение, в котором находится ресурс

name

string

Имя ресурса.

properties.autoTrackingConfiguration

AutoTrackingConfiguration

Настройка автоматического отслеживания.

properties.eventHubUri

string

Идентификатор ресурса ARM концентратора событий, используемого для телеметрии. Требует предоставления поставщику ресурсов Orbital прав на отправку данных телеметрии в концентратор.

properties.links

ContactProfileLink[]

Ссылки профиля контакта. Описывает rf-каналы, обработку модема и конечные точки IP.

properties.minimumElevationDegrees

number

Минимальное допустимое повышение для контакта в десятичных градусах. Используется для перечисления доступных контактов с космическим аппаратом на данной наземной станции.

properties.minimumViableContactDuration

string

Минимальная жизнеспособная продолжительность контакта в формате ISO 8601. Используется для перечисления доступных контактов с космическим аппаратом на данной наземной станции.

properties.networkConfiguration

NetworkConfiguration

Конфигурация сети виртуальной сети клиента.

properties.provisioningState

ProvisioningState

Текущее состояние создания, удаления или изменения ресурса.

properties.thirdPartyConfigurations

ContactProfileThirdPartyConfiguration[]

Конфигурация профиля контактов стороннего производителя. Описывает rf-каналы, обработку модема и конечные точки IP.

systemData

systemData

Azure Resource Manager метаданные, содержащие сведения о createdBy и modifiedBy.

tags

object

Теги ресурсов.

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

Ссылка на профиль контакта.

Имя Тип Описание
channels

ContactProfileLinkChannel[]

Канал связи профиля контакта.

direction

direction

Направление (исходящей или нисходящей).

eirpdBW

number

Эффективная изотропная излучаемая мощность (EIRP) в dBW. Это обязательный EIRP для клиента. Еще не используется.

gainOverTemperature

number

Повышение до шумовой температуры в db/K. Это обязательный G/T для клиента. Еще не используется.

name

string

Имя ссылки.

polarization

polarization

Поляризации. например (RHCP, LHCP).

ContactProfileLinkChannel

Канал связи профиля контакта.

Имя Тип Описание
bandwidthMHz

number

Пропускная способность в МГц.

centerFrequencyMHz

number

Центральная частота в МГц.

decodingConfiguration

string

В настоящее время неиспользуется.

demodulationConfiguration

string

Копия файла конфигурации модема, например Kratos QRadio или Kratos QuantumRx. Допустимо только для направлений нисходящей связи. Если этот параметр указан, модем подключается к конечной точке клиента и отправляет демодулированные данные вместо потока VITA.49.

encodingConfiguration

string

В настоящее время неиспользуется.

endPoint

EndPoint

Конечная точка клиента для хранения и извлечения данных во время контакта с космическим аппаратом.

modulationConfiguration

string

Копия файла конфигурации модема, например Kratos QRadio. Допустимо только для направлений исходящей связи. Если этот параметр указан, модем подключается к конечной точке клиента и принимает команды от клиента вместо потока VITA.49.

name

string

Имя канала.

ContactProfileThirdPartyConfiguration

Конфигурация стороннего партнера профиля контакта.

Имя Тип Описание
missionConfiguration

string

Имя строки, ссылающейся на конфигурацию, описывающую настройку контакта для определенной миссии. Ожидаемые значения — это значения, созданные совместно с партнерской сетью.

providerName

string

Имя стороннего поставщика.

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

direction

Направление (исходящей или нисходящей).

Имя Тип Описание
Downlink

string

Uplink

string

EndPoint

Конечная точка клиента для хранения и извлечения данных во время контакта с космическим аппаратом.

Имя Тип Описание
endPointName

string

Имя конечной точки.

ipAddress

string

IP-адрес (IPv4).

port

string

TCP-порт для прослушивания для получения данных.

protocol

protocol

Протокол UDP или TCP.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

NetworkConfiguration

Конфигурация сети виртуальной сети клиента.

Имя Тип Описание
subnetId

string

Идентификатор ресурса ARM подсети, делегированной Microsoft.Orbital/orbitalGateways. Должен быть по крайней мере подсетью класса C, и в ней не должно быть создано IP-адрес.

polarization

Поляризации. например (RHCP, LHCP).

Имя Тип Описание
LHCP

string

RHCP

string

linearHorizontal

string

linearVertical

string

protocol

Протокол UDP или TCP.

Имя Тип Описание
TCP

string

UDP

string

ProvisioningState

Текущее состояние создания, удаления или изменения ресурса.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Удостоверение, которое в последний раз изменял ресурс.

lastModifiedByType

createdByType

Тип удостоверения, изменяющего ресурс в последний раз.