Contact Profiles - Create Or Update

Crée ou met à jour un profil de contact.

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

Paramètres URI

Nom Dans Obligatoire Type Description
contactProfileName
path True

string

Nom du profil de contact.

resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string

ID de l’abonnement cible.

api-version
query True

string

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Obligatoire Type Description
location True

string

Emplacement géographique où réside la ressource

properties.links True

ContactProfileLink[]

Liens du profil de contact. Décrit les liaisons RF, le traitement du modem et les points de terminaison IP.

properties.networkConfiguration True

NetworkConfiguration

Configuration réseau du réseau virtuel client.

properties.autoTrackingConfiguration

AutoTrackingConfiguration

Configuration du suivi automatique.

properties.eventHubUri

string

Identificateur de ressource ARM du hub d’événements utilisé pour la télémétrie. Nécessite d’accorder au fournisseur de ressources Orbital les droits d’envoyer des données de télémétrie dans le hub.

properties.minimumElevationDegrees

number

Élévation minimale viable pour le contact en degrés décimaux. Utilisé pour répertorier les contacts disponibles avec un vaisseau spatial à une station terrestre donnée.

properties.minimumViableContactDuration

string

Durée minimale viable du contact au format ISO 8601. Utilisé pour répertorier les contacts disponibles avec un vaisseau spatial à une station terrestre donnée.

properties.provisioningState

ProvisioningState

État actuel de la création, de la suppression ou de la modification de la ressource.

properties.thirdPartyConfigurations

ContactProfileThirdPartyConfiguration[]

Configuration de la mission tierce du profil de contact. Décrit les liaisons RF, le traitement du modem et les points de terminaison IP.

tags

object

Balises de ressource.

Réponses

Nom Type Description
200 OK

ContactProfile

Mise à jour réussie. L’opération retourne la ressource ContactProfile résultante.

201 Created

ContactProfile

Création réussie. L’opération retourne la ressource ContactProfile résultante.

Headers

Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

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

Définitions

Nom Description
AutoTrackingConfiguration

Configuration du suivi automatique.

ContactProfile

Le client crée une ressource de profil de contact, qui contient toutes les configurations requises pour la planification d’un contact.

ContactProfileLink

Lien de profil de contact.

ContactProfileLinkChannel

Canal de lien de profil de contact.

ContactProfileThirdPartyConfiguration

Contactez la configuration du partenaire tiers profil.

createdByType

Type d’identité qui a créé la ressource.

direction

Direction (liaison montante ou descendante).

EndPoint

Point de terminaison client pour stocker et récupérer des données pendant un contact avec le vaisseau spatial.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

NetworkConfiguration

Configuration réseau du réseau virtuel client.

polarization

Polarisation. par exemple (RHCP, LHCP).

protocol

Protocole UDP ou TCP.

ProvisioningState

État actuel de la création, de la suppression ou de la modification de la ressource.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

AutoTrackingConfiguration

Configuration du suivi automatique.

Nom Type Description
disabled

string

sBand

string

xBand

string

ContactProfile

Le client crée une ressource de profil de contact, qui contient toutes les configurations requises pour la planification d’un contact.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

Emplacement géographique où réside la ressource

name

string

nom de la ressource.

properties.autoTrackingConfiguration

AutoTrackingConfiguration

Configuration du suivi automatique.

properties.eventHubUri

string

Identificateur de ressource ARM du hub d’événements utilisé pour la télémétrie. Nécessite d’accorder au fournisseur de ressources Orbital les droits d’envoyer des données de télémétrie dans le hub.

properties.links

ContactProfileLink[]

Liens du profil de contact. Décrit les liaisons RF, le traitement du modem et les points de terminaison IP.

properties.minimumElevationDegrees

number

Élévation minimale viable pour le contact en degrés décimaux. Utilisé pour répertorier les contacts disponibles avec un vaisseau spatial à une station terrestre donnée.

properties.minimumViableContactDuration

string

Durée minimale viable du contact au format ISO 8601. Utilisé pour répertorier les contacts disponibles avec un vaisseau spatial à une station terrestre donnée.

properties.networkConfiguration

NetworkConfiguration

Configuration réseau du réseau virtuel client.

properties.provisioningState

ProvisioningState

État actuel de la création, de la suppression ou de la modification de la ressource.

properties.thirdPartyConfigurations

ContactProfileThirdPartyConfiguration[]

Configuration de la mission tierce du profil de contact. Décrit les liaisons RF, le traitement du modem et les points de terminaison IP.

systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.

tags

object

Balises de ressource.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

Lien de profil de contact.

Nom Type Description
channels

ContactProfileLinkChannel[]

Canal de lien de profil de contact.

direction

direction

Direction (liaison montante ou descendante).

eirpdBW

number

Puissance isotropique rayonnée effective (EIRP) en dBW. Il s’agit de l’EIRP requis par le client. Pas encore utilisé.

gainOverTemperature

number

Gagnez à la température du bruit en db/K. Il s’agit du G/T requis par le client. Pas encore utilisé.

name

string

Nom du lien.

polarization

polarization

Polarisation. par exemple (RHCP, LHCP).

ContactProfileLinkChannel

Canal de lien de profil de contact.

Nom Type Description
bandwidthMHz

number

Bande passante en MHz.

centerFrequencyMHz

number

Fréquence centrale en MHz.

decodingConfiguration

string

Actuellement inutilisé.

demodulationConfiguration

string

Copie du fichier de configuration du modem, tel que Kratos QRadio ou Kratos QuantumRx. Valide uniquement pour les directions de la liaison descendante. S’il est fourni, le modem se connecte au point de terminaison du client et envoie des données démodulées au lieu d’un flux VITA.49.

encodingConfiguration

string

Actuellement inutilisé.

endPoint

EndPoint

Point de terminaison client pour stocker et récupérer des données pendant un contact avec le vaisseau spatial.

modulationConfiguration

string

Copie du fichier de configuration du modem, tel que Kratos QRadio. Valide uniquement pour les directions de liaison montante. S’il est fourni, le modem se connecte au point de terminaison du client et accepte les commandes du client au lieu d’un flux VITA.49.

name

string

Nom du canal.

ContactProfileThirdPartyConfiguration

Contactez la configuration du partenaire tiers profil.

Nom Type Description
missionConfiguration

string

Nom de la chaîne référençant la configuration décrivant la configuration du contact pour une mission particulière. Les valeurs attendues sont celles qui ont été créées en collaboration avec le réseau de partenaires.

providerName

string

Nom du fournisseur tiers.

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

direction

Direction (liaison montante ou descendante).

Nom Type Description
Downlink

string

Uplink

string

EndPoint

Point de terminaison client pour stocker et récupérer des données pendant un contact avec le vaisseau spatial.

Nom Type Description
endPointName

string

Nom d’un point de terminaison.

ipAddress

string

Adresse IP (IPv4).

port

string

Port TCP sur lequel écouter pour recevoir des données.

protocol

protocol

Protocole UDP ou TCP.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet error.

NetworkConfiguration

Configuration réseau du réseau virtuel client.

Nom Type Description
subnetId

string

Identificateur de ressource ARM du sous-réseau délégué à Microsoft.Orbital/orbitalGateways. Doit être au moins un sous-réseau de classe C et ne doit pas contenir d’adresse IP créée.

polarization

Polarisation. par exemple (RHCP, LHCP).

Nom Type Description
LHCP

string

RHCP

string

linearHorizontal

string

linearVertical

string

protocol

Protocole UDP ou TCP.

Nom Type Description
TCP

string

UDP

string

ProvisioningState

État actuel de la création, de la suppression ou de la modification de la ressource.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.