Spacecrafts - List Available Contacts
Renvoie la liste des contacts disponibles. Un contact est disponible si le vaisseau spatial est visible à partir de la station au sol pendant une durée supérieure à la durée minimale viable de contact indiquée dans le profil de contact.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/listAvailableContacts?api-version=2022-11-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
spacecraft
|
path | True |
string |
ID du vaisseau spatial. |
subscription
|
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 |
---|---|---|---|
contactProfile | True |
Référence à la ressource de profil de contact. |
|
endTime | True |
string |
Heure de fin d’un contact (norme UTC ISO 8601). |
groundStationName | True |
string |
Nom d’Azure Ground Station. |
startTime | True |
string |
Heure de début d’un contact (norme UTC ISO 8601). |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
La demande a réussi. L’opération retourne une liste de ressources de contacts disponibles. |
|
202 Accepted |
Accepté et l’opération se terminera de manière asynchrone. En-têtes Location: string |
|
Other Status Codes |
Réponse d’erreur décrivant la raison de l’échec de l’opération. Si le groupe de ressources n’existe pas, 404 (NotFound) est retourné. |
Exemples
List of Contact
Exemple de requête
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"
}
Exemple de réponse
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"
}
Définitions
Nom | Description |
---|---|
Authorized |
Station au sol autorisée. |
Auto |
Configuration du suivi automatique. |
Available |
Le client récupère la liste des contacts disponibles pour une ressource de vaisseau spatial. Plus tard, l’un des contacts disponibles peut être sélectionné pour créer un contact. |
Available |
Réponse à l’appel de service de l’API ListAvailableContacts. |
Contact |
Paramètres qui définissent la ressource de contact. |
Contact |
Référence à la ressource de profil de contact. |
Contact |
Le client crée une ressource de profil de contact, qui contiendra toutes les configurations requises pour la planification d’un contact. |
Contact |
Lien de profil de contact. |
Contact |
Canal de lien de profil de contact. |
Contact |
État actuel de la création, de la suppression ou de la modification de la ressource. |
Contact |
Contactez la configuration du partenaire tiers profil. |
created |
Type d’identité qui a créé la ressource. |
direction |
Direction (liaison montante ou descendante). |
End |
Point de terminaison client pour stocker et récupérer des données pendant un contact avec le vaisseau spatial. |
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
Error |
Détail de l’erreur. |
Error |
Réponse d’erreur |
Network |
Configuration réseau du réseau virtuel client. |
polarization |
Polarisation. par exemple (RHCP, LHCP). |
protocol |
Protocole UDP ou TCP. |
Provisioning |
État actuel de la création, de la suppression ou de la modification de la ressource. |
Spacecraft |
Le client crée une ressource de vaisseau spatial pour planifier un contact. |
Spacecraft |
Liste des liaisons d’engins spatiaux autorisées par station au sol et la date d’expiration de l’autorisation. |
system |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
AuthorizedGroundstation
Station au sol autorisée.
Nom | Type | Description |
---|---|---|
expirationDate |
string |
Date d’expiration de l’autorisation. |
groundStation |
string |
Nom de la station de terre. |
AutoTrackingConfiguration
Configuration du suivi automatique.
Nom | Type | Description |
---|---|---|
disabled |
string |
|
sBand |
string |
|
xBand |
string |
AvailableContacts
Le client récupère la liste des contacts disponibles pour une ressource de vaisseau spatial. Plus tard, l’un des contacts disponibles peut être sélectionné pour créer un contact.
Nom | Type | Description |
---|---|---|
groundStationName |
string |
Nom d’Azure Ground Station. |
properties.endAzimuthDegrees |
number |
Azimut de l’antenne à la fin du contact en degrés décimaux. |
properties.endElevationDegrees |
number |
Élévation du vaisseau spatial au-dessus de l’horizon à l’extrémité du contact. |
properties.maximumElevationDegrees |
number |
Élévation maximale de l’antenne pendant le contact en degrés décimaux. |
properties.rxEndTime |
string |
Temps perdu à recevoir un signal (norme ISO 8601 UTC). |
properties.rxStartTime |
string |
Heure la plus précoce de réception d’un signal (norme UTC ISO 8601). |
properties.startAzimuthDegrees |
number |
Azimut de l’antenne au début du contact en degrés décimaux. |
properties.startElevationDegrees |
number |
Élévation du vaisseau spatial au-dessus de l’horizon au début du contact. |
properties.txEndTime |
string |
Heure à laquelle la transmission d’antenne sera désactivée (norme UTC ISO 8601). |
properties.txStartTime |
string |
Heure à laquelle la transmission d’antenne sera activée (norme UTC ISO 8601). |
spacecraft |
Référence à la ressource du vaisseau spatial. |
AvailableContactsListResult
Réponse à l’appel de service de l’API ListAvailableContacts.
Nom | Type | Description |
---|---|---|
nextLink |
string |
URL permettant d’obtenir l’ensemble de résultats suivant. |
value |
Liste des contacts disponibles. |
ContactParameters
Paramètres qui définissent la ressource de contact.
Nom | Type | Description |
---|---|---|
contactProfile |
Référence à la ressource de profil de contact. |
|
endTime |
string |
Heure de fin d’un contact (norme UTC ISO 8601). |
groundStationName |
string |
Nom d’Azure Ground Station. |
startTime |
string |
Heure de début d’un contact (norme UTC ISO 8601). |
ContactParameters.ContactProfile
Référence à la ressource de profil de contact.
Nom | Type | Description |
---|---|---|
id |
string |
ID de la ressource |
ContactProfile
Le client crée une ressource de profil de contact, qui contiendra 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 |
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 |
Liens du profil de contact. Décrit les liens RF, le traitement des modems 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 au sol 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 au sol donnée. |
properties.networkConfiguration |
Configuration réseau du réseau virtuel client. |
|
properties.provisioningState |
État actuel de la création, de la suppression ou de la modification de la ressource. |
|
properties.thirdPartyConfigurations |
Configuration de la mission tierce du profil de contact. Décrit les liens RF, le traitement des modems et les points de terminaison IP. |
|
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 » |
ContactProfileLink
Lien de profil de contact.
Nom | Type | Description |
---|---|---|
channels |
Canal de lien de profil de contact. |
|
direction |
Direction (liaison montante ou descendante). |
|
eirpdBW |
number |
Puissance isotrope rayonnée effective (EIRP) en dBW. Il s’agit de l’EIRP requis par le client. Pas encore utilisé. |
gainOverTemperature |
number |
Gain de la température du bruit dans db/K. Il s’agit du G/T requis par le client. Pas encore utilisé. |
name |
string |
Nom du lien. |
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 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 |
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. |
ContactProfilesProperties.ProvisioningState
État actuel de la création, de la suppression ou de la modification de la ressource.
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 partenaire. |
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 à écouter pour recevoir des données. |
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 |
Informations supplémentaires sur l’erreur. |
|
code |
string |
Code d'erreur. |
details |
Détails de l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
Nom | Type | Description |
---|---|---|
error |
Objet d’erreur. |
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 aucune adresse IP ne doit être 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.
Spacecraft
Le client crée une ressource de vaisseau spatial pour planifier 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.links |
Liste immuable des liens des vaisseaux spatiaux. |
|
properties.noradId |
string |
ID NORAD du vaisseau spatial. |
properties.provisioningState |
État actuel de la création, de la suppression ou de la modification de la ressource. |
|
properties.titleLine |
string |
Ligne de titre du jeu d’éléments à deux lignes (TLE). |
properties.tleLine1 |
string |
Ligne 1 du jeu d’éléments à deux lignes (TLE). |
properties.tleLine2 |
string |
Ligne 2 du jeu d’éléments à deux lignes (TLE). |
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 » |
SpacecraftLink
Liste des liaisons d’engins spatiaux autorisées par station au sol et la date d’expiration de l’autorisation.
Nom | Type | Description |
---|---|---|
authorizations |
Stations terrestres autorisées |
|
bandwidthMHz |
number |
Bande passante en MHz. |
centerFrequencyMHz |
number |
Fréquence centrale en MHz. |
direction |
Direction (liaison montante ou descendante). |
|
name |
string |
Nom du lien. |
polarization |
Polarisation. par exemple (RHCP, LHCP). |
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 |
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 dernière ressource. |
lastModifiedByType |
Type d’identité qui a modifié la dernière ressource. |