Contact Profiles - Create Or Update
Crea o aggiorna un profilo di contatto.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}?api-version=2022-11-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
contact
|
path | True |
string |
Nome del profilo di contatto. |
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
location | True |
string |
Posizione geografica in cui risiede la risorsa |
properties.links | True |
Collegamenti del profilo di contatto. Vengono descritti i collegamenti RF, l'elaborazione del modem e gli endpoint IP. |
|
properties.networkConfiguration | True |
Configurazione di rete della rete virtuale del cliente. |
|
properties.autoTrackingConfiguration |
Configurazione del rilevamento automatico. |
||
properties.eventHubUri |
string |
Identificatore di risorsa ARM dell'hub eventi usato per la telemetria. È necessario concedere al provider di risorse Orbital i diritti per inviare i dati di telemetria nell'hub. |
|
properties.minimumElevationDegrees |
number |
Elevazione minima praticabile per il contatto in gradi decimali. Utilizzato per elencare i contatti disponibili con un veicolo spaziale in una determinata stazione di terra. |
|
properties.minimumViableContactDuration |
string |
Durata minima del contatto valido in formato ISO 8601. Utilizzato per elencare i contatti disponibili con un veicolo spaziale in una determinata stazione di terra. |
|
properties.provisioningState |
Stato corrente della creazione, eliminazione o modifica della risorsa. |
||
properties.thirdPartyConfigurations |
Configurazione della missione di terze parti del profilo di contatto. Vengono descritti i collegamenti RF, l'elaborazione del modem e gli endpoint IP. |
||
tags |
object |
Tag delle risorse. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Aggiornamento riuscito. L'operazione restituisce la risorsa ContactProfile risultante. |
|
201 Created |
Creazione riuscita. L'operazione restituisce la risorsa ContactProfile risultante. Intestazioni Azure-AsyncOperation: string |
|
Other Status Codes |
Risposta di errore che descrive il motivo per cui l'operazione non è riuscita. |
Esempio
Create a contact profile
Esempio di richiesta
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"
}
}
]
}
]
}
}
Risposta di esempio
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
}
]
}
]
}
}
Definizioni
Nome | Descrizione |
---|---|
Auto |
Configurazione del rilevamento automatico. |
Contact |
Il cliente crea una risorsa del profilo di contatto, che conterrà tutte le configurazioni necessarie per la pianificazione di un contatto. |
Contact |
Collegamento al profilo di contatto. |
Contact |
Canale di collegamento del profilo di contatto. |
Contact |
Configurazione del partner di terze parti del profilo di contatto. |
created |
Tipo di identità che ha creato la risorsa. |
direction |
Direzione (Uplink o Downlink). |
End |
Punto finale del cliente per archiviare e recuperare i dati durante un contatto con il veicolo spaziale. |
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
Error |
Dettagli dell'errore. |
Error |
Risposta di errore |
Network |
Configurazione di rete della rete virtuale del cliente. |
polarization |
Polarizzazione. ad esempio (RHCP, LHCP). |
protocol |
Protocollo UDP o TCP. |
Provisioning |
Stato corrente della creazione, eliminazione o modifica della risorsa. |
system |
Metadati relativi alla creazione e all'ultima modifica della risorsa. |
AutoTrackingConfiguration
Configurazione del rilevamento automatico.
Nome | Tipo | Descrizione |
---|---|---|
disabled |
string |
|
sBand |
string |
|
xBand |
string |
ContactProfile
Il cliente crea una risorsa del profilo di contatto, che conterrà tutte le configurazioni necessarie per la pianificazione di un contatto.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
Posizione geografica in cui risiede la risorsa |
name |
string |
nome della risorsa. |
properties.autoTrackingConfiguration |
Configurazione del rilevamento automatico. |
|
properties.eventHubUri |
string |
Identificatore di risorsa ARM dell'hub eventi usato per la telemetria. È necessario concedere al provider di risorse Orbital i diritti per inviare i dati di telemetria nell'hub. |
properties.links |
Collegamenti del profilo di contatto. Vengono descritti i collegamenti RF, l'elaborazione del modem e gli endpoint IP. |
|
properties.minimumElevationDegrees |
number |
Elevazione minima praticabile per il contatto in gradi decimali. Utilizzato per elencare i contatti disponibili con un veicolo spaziale in una determinata stazione di terra. |
properties.minimumViableContactDuration |
string |
Durata minima del contatto valido in formato ISO 8601. Utilizzato per elencare i contatti disponibili con un veicolo spaziale in una determinata stazione di terra. |
properties.networkConfiguration |
Configurazione di rete della rete virtuale del cliente. |
|
properties.provisioningState |
Stato corrente della creazione, eliminazione o modifica della risorsa. |
|
properties.thirdPartyConfigurations |
Configurazione della missione di terze parti del profilo di contatto. Vengono descritti i collegamenti RF, l'elaborazione del modem e gli endpoint IP. |
|
systemData |
Azure Resource Manager metadati contenenti le informazioni createdBy e modifiedBy. |
|
tags |
object |
Tag delle risorse. |
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
ContactProfileLink
Collegamento al profilo di contatto.
Nome | Tipo | Descrizione |
---|---|---|
channels |
Canale di collegamento del profilo di contatto. |
|
direction |
Direzione (Uplink o Downlink). |
|
eirpdBW |
number |
Potenza EIRP (Effective Isotropic Radiated Power) in dBW. È l'EIRP richiesto dal cliente. Non ancora usato. |
gainOverTemperature |
number |
Ottenere la temperatura del rumore in db/K. È il G/T richiesto dal cliente. Non ancora usato. |
name |
string |
Nome del collegamento. |
polarization |
Polarizzazione. ad esempio (RHCP, LHCP). |
ContactProfileLinkChannel
Canale di collegamento del profilo di contatto.
Nome | Tipo | Descrizione |
---|---|---|
bandwidthMHz |
number |
Larghezza di banda in MHz. |
centerFrequencyMHz |
number |
Frequenza centrale in MHz. |
decodingConfiguration |
string |
Attualmente inutilizzato. |
demodulationConfiguration |
string |
Copia del file di configurazione del modem, ad esempio Kratos QRadio o Kratos QuantumRx. Valido solo per le direzioni downlink. Se specificato, il modem si connette all'endpoint del cliente e invia dati demodulati anziché un flusso VITA.49. |
encodingConfiguration |
string |
Attualmente inutilizzato. |
endPoint |
Punto finale del cliente per archiviare e recuperare i dati durante un contatto con il veicolo spaziale. |
|
modulationConfiguration |
string |
Copia del file di configurazione del modem, ad esempio Kratos QRadio. Valido solo per le direzioni uplink. Se specificato, il modem si connette all'endpoint del cliente e accetta i comandi del cliente anziché un flusso VITA.49. |
name |
string |
Nome del canale. |
ContactProfileThirdPartyConfiguration
Configurazione del partner di terze parti del profilo di contatto.
Nome | Tipo | Descrizione |
---|---|---|
missionConfiguration |
string |
Nome della stringa che fa riferimento alla configurazione che descrive la configurazione del contatto per una determinata missione. I valori previsti sono quelli creati in collaborazione con la rete partner. |
providerName |
string |
Nome del provider di terze parti. |
createdByType
Tipo di identità che ha creato la risorsa.
Nome | Tipo | Descrizione |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
direction
Direzione (Uplink o Downlink).
Nome | Tipo | Descrizione |
---|---|---|
Downlink |
string |
|
Uplink |
string |
EndPoint
Punto finale del cliente per archiviare e recuperare i dati durante un contatto con il veicolo spaziale.
Nome | Tipo | Descrizione |
---|---|---|
endPointName |
string |
Nome di un punto finale. |
ipAddress |
string |
Indirizzo IP (IPv4). |
port |
string |
Porta TCP su cui rimanere in ascolto per ricevere i dati. |
protocol |
Protocollo UDP o TCP. |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
Nome | Tipo | Descrizione |
---|---|---|
info |
object |
Informazioni aggiuntive. |
type |
string |
Tipo di informazioni aggiuntive. |
ErrorDetail
Dettagli dell'errore.
Nome | Tipo | Descrizione |
---|---|---|
additionalInfo |
Informazioni aggiuntive sull'errore. |
|
code |
string |
Codice di errore. |
details |
Dettagli dell'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore. |
ErrorResponse
Risposta di errore
Nome | Tipo | Descrizione |
---|---|---|
error |
Oggetto error. |
NetworkConfiguration
Configurazione di rete della rete virtuale del cliente.
Nome | Tipo | Descrizione |
---|---|---|
subnetId |
string |
Identificatore di risorsa ARM della subnet delegata a Microsoft.Orbital/orbitalGateways. Deve essere almeno una subnet C di classe e non deve essere creato alcun indirizzo IP. |
polarization
Polarizzazione. ad esempio (RHCP, LHCP).
Nome | Tipo | Descrizione |
---|---|---|
LHCP |
string |
|
RHCP |
string |
|
linearHorizontal |
string |
|
linearVertical |
string |
protocol
Protocollo UDP o TCP.
Nome | Tipo | Descrizione |
---|---|---|
TCP |
string |
|
UDP |
string |
ProvisioningState
Stato corrente della creazione, eliminazione o modifica della risorsa.
systemData
Metadati relativi alla creazione e all'ultima modifica della risorsa.
Nome | Tipo | Descrizione |
---|---|---|
createdAt |
string |
Timestamp della creazione di risorse (UTC). |
createdBy |
string |
Identità che ha creato la risorsa. |
createdByType |
Tipo di identità che ha creato la risorsa. |
|
lastModifiedAt |
string |
Timestamp dell'ultima modifica della risorsa (UTC) |
lastModifiedBy |
string |
Identità che ha modificato l'ultima volta la risorsa. |
lastModifiedByType |
Tipo di identità che ha modificato l'ultima volta la risorsa. |