Contact Profiles - Create Or Update
Erstellt oder aktualisiert ein Kontaktprofil.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}?api-version=2022-11-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
contact
|
path | True |
string |
Name des Kontaktprofils. |
resource
|
path | True |
string |
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet. |
subscription
|
path | True |
string |
Hierbei handelt es sich um die ID des Zielabonnements. |
api-version
|
query | True |
string |
Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
location | True |
string |
Der geografische Standort, an dem sich die Ressource befindet |
properties.links | True |
Links des Kontaktprofils. Beschreibt RF-Verbindungen, Modemverarbeitung und IP-Endpunkte. |
|
properties.networkConfiguration | True |
Netzwerkkonfiguration des virtuellen Kundennetzwerks. |
|
properties.autoTrackingConfiguration |
Automatische Nachverfolgungskonfiguration. |
||
properties.eventHubUri |
string |
ARM-Ressourcenbezeichner des Event Hubs, der für Telemetriedaten verwendet wird. Erfordert die Gewährung der Rechte des Orbitalressourcenanbieters zum Senden von Telemetriedaten an den Hub. |
|
properties.minimumElevationDegrees |
number |
Minimale lebensfähige Höhe für den Kontakt in Dezimalgraden. Wird verwendet, um die verfügbaren Kontakte mit einem Raumfahrzeug auf einer bestimmten Bodenstation aufzulisten. |
|
properties.minimumViableContactDuration |
string |
Minimale lebensfähige Kontaktdauer im ISO 8601-Format. Wird verwendet, um die verfügbaren Kontakte mit einem Raumfahrzeug auf einer bestimmten Bodenstation aufzulisten. |
|
properties.provisioningState |
Der aktuelle Status der Erstellung, Löschung oder Änderung der Ressource. |
||
properties.thirdPartyConfigurations |
Konfiguration der Drittanbietermission des Kontaktprofils. Beschreibt RF-Verbindungen, Modemverarbeitung und IP-Endpunkte. |
||
tags |
object |
Ressourcentags. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Aktualisierung erfolgreich. Der Vorgang gibt die resultierende ContactProfile-Ressource zurück. |
|
201 Created |
Erstellen Sie erfolgreich. Der Vorgang gibt die resultierende ContactProfile-Ressource zurück. Header Azure-AsyncOperation: string |
|
Other Status Codes |
Fehlerantwort mit Beschreibung des Grunds für den Fehler. |
Beispiele
Create a contact profile
Beispielanforderung
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"
}
}
]
}
]
}
}
Beispiel für eine Antwort
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
}
]
}
]
}
}
Definitionen
Name | Beschreibung |
---|---|
Auto |
Automatische Nachverfolgungskonfiguration. |
Contact |
Der Kunde erstellt eine Kontaktprofilressource, die alle konfigurationen enthält, die für die Planung eines Kontakts erforderlich sind. |
Contact |
Kontaktprofillink. |
Contact |
Kontaktprofillinkkanal. |
Contact |
Wenden Sie sich an die Profilkonfiguration eines Drittanbieterpartners. |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
direction |
Richtung (Uplink oder Downlink). |
End |
Kundenendpunkt zum Speichern und Abrufen von Daten während eines Kontakts mit dem Raumfahrzeug. |
Error |
Zusätzliche Informationen zum Ressourcenverwaltungsfehler. |
Error |
Die Fehlerdetails. |
Error |
Fehlerantwort |
Network |
Netzwerkkonfiguration des virtuellen Kundennetzwerks. |
polarization |
Polarisation. z.B. (RHCP, LHCP). |
protocol |
Protokoll entweder UDP oder TCP. |
Provisioning |
Der aktuelle Status der Erstellung, Löschung oder Änderung der Ressource. |
system |
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen. |
AutoTrackingConfiguration
Automatische Nachverfolgungskonfiguration.
Name | Typ | Beschreibung |
---|---|---|
disabled |
string |
|
sBand |
string |
|
xBand |
string |
ContactProfile
Der Kunde erstellt eine Kontaktprofilressource, die alle konfigurationen enthält, die für die Planung eines Kontakts erforderlich sind.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
Der geografische Standort, an dem sich die Ressource befindet |
name |
string |
Der Name der Ressource |
properties.autoTrackingConfiguration |
Automatische Nachverfolgungskonfiguration. |
|
properties.eventHubUri |
string |
ARM-Ressourcenbezeichner des Event Hubs, der für Telemetriedaten verwendet wird. Erfordert die Gewährung der Rechte des Orbitalressourcenanbieters zum Senden von Telemetriedaten an den Hub. |
properties.links |
Links des Kontaktprofils. Beschreibt RF-Verbindungen, Modemverarbeitung und IP-Endpunkte. |
|
properties.minimumElevationDegrees |
number |
Minimale lebensfähige Höhe für den Kontakt in Dezimalgraden. Wird verwendet, um die verfügbaren Kontakte mit einem Raumfahrzeug auf einer bestimmten Bodenstation aufzulisten. |
properties.minimumViableContactDuration |
string |
Minimale lebensfähige Kontaktdauer im ISO 8601-Format. Wird verwendet, um die verfügbaren Kontakte mit einem Raumfahrzeug auf einer bestimmten Bodenstation aufzulisten. |
properties.networkConfiguration |
Netzwerkkonfiguration des virtuellen Kundennetzwerks. |
|
properties.provisioningState |
Der aktuelle Status der Erstellung, Löschung oder Änderung der Ressource. |
|
properties.thirdPartyConfigurations |
Konfiguration der Drittanbietermission des Kontaktprofils. Beschreibt RF-Verbindungen, Modemverarbeitung und IP-Endpunkte. |
|
systemData |
Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen. |
|
tags |
object |
Ressourcentags. |
type |
string |
Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
ContactProfileLink
Kontaktprofillink.
Name | Typ | Beschreibung |
---|---|---|
channels |
Kontaktprofillinkkanal. |
|
direction |
Richtung (Uplink oder Downlink). |
|
eirpdBW |
number |
Effektive isotrope Strahlungsleistung (EIRP) in dBW. Es ist die vom Kunden geforderte EIRP. Noch nicht verwendet. |
gainOverTemperature |
number |
Verstärkung der Rauschtemperatur in db/K. Es handelt sich um die vom Kunden geforderte G/T. Noch nicht verwendet. |
name |
string |
Linkname. |
polarization |
Polarisation. z.B. (RHCP, LHCP). |
ContactProfileLinkChannel
Kontaktprofillinkkanal.
Name | Typ | Beschreibung |
---|---|---|
bandwidthMHz |
number |
Bandbreite in MHz. |
centerFrequencyMHz |
number |
Zentrierungsfrequenz in MHz. |
decodingConfiguration |
string |
Derzeit nicht verwendet. |
demodulationConfiguration |
string |
Kopie der Modemkonfigurationsdatei, z. B. Kratos QRadio oder Kratos QuantumRx. Nur gültig für Downlink-Wegbeschreibungen. Falls angegeben, stellt das Modem eine Verbindung mit dem Kundenendpunkt her und sendet demodulierte Daten anstelle eines VITA.49-Datenstroms. |
encodingConfiguration |
string |
Derzeit nicht verwendet. |
endPoint |
Kundenendpunkt zum Speichern und Abrufen von Daten während eines Kontakts mit dem Raumfahrzeug. |
|
modulationConfiguration |
string |
Kopie der Modemkonfigurationsdatei, z. B. Kratos QRadio. Nur gültig für Uplink-Wegbeschreibungen. Falls angegeben, stellt das Modem eine Verbindung mit dem Kundenendpunkt her und akzeptiert Befehle vom Kunden anstelle eines VITA.49-Streams. |
name |
string |
Kanalname. |
ContactProfileThirdPartyConfiguration
Wenden Sie sich an die Profilkonfiguration eines Drittanbieterpartners.
Name | Typ | Beschreibung |
---|---|---|
missionConfiguration |
string |
Name der Zeichenfolge, die auf die Konfiguration verweist, die die Einrichtung des Kontakts für eine bestimmte Mission beschreibt. Erwartete Werte sind werte, die in Zusammenarbeit mit dem Partnernetzwerk erstellt wurden. |
providerName |
string |
Name des Drittanbieters. |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Name | Typ | Beschreibung |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
direction
Richtung (Uplink oder Downlink).
Name | Typ | Beschreibung |
---|---|---|
Downlink |
string |
|
Uplink |
string |
EndPoint
Kundenendpunkt zum Speichern und Abrufen von Daten während eines Kontakts mit dem Raumfahrzeug.
Name | Typ | Beschreibung |
---|---|---|
endPointName |
string |
Name eines Endpunkts. |
ipAddress |
string |
IP-Adresse (IPv4). |
port |
string |
TCP-Port, an dem daten empfangen werden sollen. |
protocol |
Protokoll entweder UDP oder TCP. |
ErrorAdditionalInfo
Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
Name | Typ | Beschreibung |
---|---|---|
info |
object |
Zusätzliche Informationen. |
type |
string |
Typ der zusätzlichen Informationen. |
ErrorDetail
Die Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
additionalInfo |
Die zusätzlichen Fehlerinformationen. |
|
code |
string |
Der Fehlercode. |
details |
Die Fehlerdetails. |
|
message |
string |
Die Fehlermeldung. |
target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
NetworkConfiguration
Netzwerkkonfiguration des virtuellen Kundennetzwerks.
Name | Typ | Beschreibung |
---|---|---|
subnetId |
string |
ARM-Ressourcenbezeichner des Subnetzes, das an Microsoft.Orbital/orbitalGateways delegiert wurde. Muss mindestens ein Subnetz der Klasse C sein und sollte keine IP-Adresse darin erstellt haben. |
polarization
Polarisation. z.B. (RHCP, LHCP).
Name | Typ | Beschreibung |
---|---|---|
LHCP |
string |
|
RHCP |
string |
|
linearHorizontal |
string |
|
linearVertical |
string |
protocol
Protokoll entweder UDP oder TCP.
Name | Typ | Beschreibung |
---|---|---|
TCP |
string |
|
UDP |
string |
ProvisioningState
Der aktuelle Status der Erstellung, Löschung oder Änderung der Ressource.
systemData
Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string |
Der Zeitstempel der letzten Änderung der Ressource (UTC) |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |