Contact Profiles - Create Or Update
Tworzy lub aktualizuje profil kontaktu.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}?api-version=2022-11-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
contact
|
path | True |
string |
Nazwa profilu kontaktu. |
resource
|
path | True |
string |
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter. |
subscription
|
path | True |
string |
Identyfikator subskrypcji docelowej. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Treść żądania
Nazwa | Wymagane | Typ | Opis |
---|---|---|---|
location | True |
string |
Lokalizacja geograficzna, w której znajduje się zasób |
properties.links | True |
Linki profilu kontaktu. Opis linków RF, przetwarzania modemów i punktów końcowych IP. |
|
properties.networkConfiguration | True |
Konfiguracja sieciowa sieci wirtualnej klienta. |
|
properties.autoTrackingConfiguration |
Konfiguracja automatycznego śledzenia. |
||
properties.eventHubUri |
string |
Identyfikator zasobu usługi ARM centrum zdarzeń używany do telemetrii. Wymaga przyznania dostawcy zasobów orbitalnych uprawnień do wysyłania danych telemetrycznych do centrum. |
|
properties.minimumElevationDegrees |
number |
Minimalna opłacalna wysokość kontaktu w stopniach dziesiętnych. Służy do wyświetlania listy dostępnych kontaktów ze statkiem kosmicznym na danej stacji naziemnej. |
|
properties.minimumViableContactDuration |
string |
Minimalny realny czas trwania kontaktu w formacie ISO 8601. Służy do wyświetlania listy dostępnych kontaktów ze statkiem kosmicznym na danej stacji naziemnej. |
|
properties.provisioningState |
Bieżący stan tworzenia, usuwania lub modyfikacji zasobu. |
||
properties.thirdPartyConfigurations |
Konfiguracja misji innych firm w profilu kontaktu. Opis linków RF, przetwarzania modemów i punktów końcowych IP. |
||
tags |
object |
Tagi zasobów. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Aktualizacja powiodła się. Operacja zwraca wynikowy zasób ContactProfile. |
|
201 Created |
Tworzenie powiodło się. Operacja zwraca wynikowy zasób ContactProfile. Nagłówki Azure-AsyncOperation: string |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Przykłady
Create a contact profile
Przykładowe żądanie
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"
}
}
]
}
]
}
}
Przykładowa odpowiedź
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
}
]
}
]
}
}
Definicje
Nazwa | Opis |
---|---|
Auto |
Konfiguracja automatycznego śledzenia. |
Contact |
Klient tworzy zasób profilu kontaktu, który będzie zawierać wszystkie konfiguracje wymagane do planowania kontaktu. |
Contact |
Link profilu kontaktu. |
Contact |
Kanał linku profilu kontaktu. |
Contact |
Skontaktuj się z konfiguracją partnera innej firmy. |
created |
Typ tożsamości, która utworzyła zasób. |
direction |
Kierunek (link do góry lub do dołu). |
End |
Punkt końcowy klienta do przechowywania i pobierania danych podczas kontaktu ze statkiem kosmicznym. |
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd |
Network |
Konfiguracja sieciowa sieci wirtualnej klienta. |
polarization |
Polaryzacji. np. (RHCP, LHCP). |
protocol |
Protokół UDP lub TCP. |
Provisioning |
Bieżący stan tworzenia, usuwania lub modyfikacji zasobu. |
system |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
AutoTrackingConfiguration
Konfiguracja automatycznego śledzenia.
Nazwa | Typ | Opis |
---|---|---|
disabled |
string |
|
sBand |
string |
|
xBand |
string |
ContactProfile
Klient tworzy zasób profilu kontaktu, który będzie zawierać wszystkie konfiguracje wymagane do planowania kontaktu.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
Lokalizacja geograficzna, w której znajduje się zasób |
name |
string |
Nazwa zasobu |
properties.autoTrackingConfiguration |
Konfiguracja automatycznego śledzenia. |
|
properties.eventHubUri |
string |
Identyfikator zasobu usługi ARM centrum zdarzeń używany do telemetrii. Wymaga przyznania dostawcy zasobów orbitalnych uprawnień do wysyłania danych telemetrycznych do centrum. |
properties.links |
Linki profilu kontaktu. Opis linków RF, przetwarzania modemów i punktów końcowych IP. |
|
properties.minimumElevationDegrees |
number |
Minimalna opłacalna wysokość kontaktu w stopniach dziesiętnych. Służy do wyświetlania listy dostępnych kontaktów ze statkiem kosmicznym na danej stacji naziemnej. |
properties.minimumViableContactDuration |
string |
Minimalny realny czas trwania kontaktu w formacie ISO 8601. Służy do wyświetlania listy dostępnych kontaktów ze statkiem kosmicznym na danej stacji naziemnej. |
properties.networkConfiguration |
Konfiguracja sieciowa sieci wirtualnej klienta. |
|
properties.provisioningState |
Bieżący stan tworzenia, usuwania lub modyfikacji zasobu. |
|
properties.thirdPartyConfigurations |
Konfiguracja misji innych firm w profilu kontaktu. Opis linków RF, przetwarzania modemów i punktów końcowych IP. |
|
systemData |
Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy. |
|
tags |
object |
Tagi zasobów. |
type |
string |
Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" |
ContactProfileLink
Link profilu kontaktu.
Nazwa | Typ | Opis |
---|---|---|
channels |
Kanał linku profilu kontaktu. |
|
direction |
Kierunek (link do góry lub do dołu). |
|
eirpdBW |
number |
Efektywna izotropowa moc promieniowana (EIRP) w dBW. Jest to wymagany EIRP przez klienta. Jeszcze nie użyto. |
gainOverTemperature |
number |
Zyskaj na temperaturę szumu w bazie danych/K. Jest to wymagane przez klienta G/T. Jeszcze nie użyto. |
name |
string |
Nazwa łącza. |
polarization |
Polaryzacji. np. (RHCP, LHCP). |
ContactProfileLinkChannel
Kanał linku profilu kontaktu.
Nazwa | Typ | Opis |
---|---|---|
bandwidthMHz |
number |
Przepustowość w MHz. |
centerFrequencyMHz |
number |
Częstotliwość wyśrodkowania w MHz. |
decodingConfiguration |
string |
Obecnie nieużywane. |
demodulationConfiguration |
string |
Kopia pliku konfiguracji modemu, takiego jak Kratos QRadio lub Kratos QuantumRx. Prawidłowe tylko dla wskazówek łącza do dołu. Jeśli zostanie podany, modem łączy się z punktem końcowym klienta i wysyła zdegradowane dane zamiast strumienia VITA.49. |
encodingConfiguration |
string |
Obecnie nieużywane. |
endPoint |
Punkt końcowy klienta do przechowywania i pobierania danych podczas kontaktu ze statkiem kosmicznym. |
|
modulationConfiguration |
string |
Kopia pliku konfiguracji modemu, takiego jak Kratos QRadio. Prawidłowe tylko dla wskazówek pasma. Jeśli zostanie podany, modem łączy się z punktem końcowym klienta i akceptuje polecenia od klienta zamiast strumienia VITA.49. |
name |
string |
Nazwa kanału. |
ContactProfileThirdPartyConfiguration
Skontaktuj się z konfiguracją partnera innej firmy.
Nazwa | Typ | Opis |
---|---|---|
missionConfiguration |
string |
Nazwa ciągu odwołującego się do konfiguracji opisującej konfigurację kontaktu skonfigurowaną dla określonej misji. Oczekiwane wartości to te, które zostały utworzone we współpracy z siecią partnerów. |
providerName |
string |
Nazwa dostawcy innej firmy. |
createdByType
Typ tożsamości, która utworzyła zasób.
Nazwa | Typ | Opis |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
direction
Kierunek (link do góry lub do dołu).
Nazwa | Typ | Opis |
---|---|---|
Downlink |
string |
|
Uplink |
string |
EndPoint
Punkt końcowy klienta do przechowywania i pobierania danych podczas kontaktu ze statkiem kosmicznym.
Nazwa | Typ | Opis |
---|---|---|
endPointName |
string |
Nazwa punktu końcowego. |
ipAddress |
string |
Adres IP (IPv4). |
port |
string |
Port TCP do nasłuchiwania w celu odbierania danych. |
protocol |
Protokół UDP lub TCP. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
Nazwa | Typ | Opis |
---|---|---|
info |
object |
Dodatkowe informacje. |
type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
additionalInfo |
Dodatkowe informacje o błędzie. |
|
code |
string |
Kod błędu. |
details |
Szczegóły błędu. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Element docelowy błędu. |
ErrorResponse
Odpowiedź na błąd
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt error. |
NetworkConfiguration
Konfiguracja sieciowa sieci wirtualnej klienta.
Nazwa | Typ | Opis |
---|---|---|
subnetId |
string |
Identyfikator zasobu usługi ARM podsieci delegowanej do bramy Microsoft.Orbital/orbitalGateways. Musi być co najmniej podsiecią klasy C i nie powinna mieć w niej żadnego adresu IP. |
polarization
Polaryzacji. np. (RHCP, LHCP).
Nazwa | Typ | Opis |
---|---|---|
LHCP |
string |
|
RHCP |
string |
|
linearHorizontal |
string |
|
linearVertical |
string |
protocol
Protokół UDP lub TCP.
Nazwa | Typ | Opis |
---|---|---|
TCP |
string |
|
UDP |
string |
ProvisioningState
Bieżący stan tworzenia, usuwania lub modyfikacji zasobu.
systemData
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
Nazwa | Typ | Opis |
---|---|---|
createdAt |
string |
Sygnatura czasowa tworzenia zasobów (UTC). |
createdBy |
string |
Tożsamość, która utworzyła zasób. |
createdByType |
Typ tożsamości, która utworzyła zasób. |
|
lastModifiedAt |
string |
Sygnatura czasowa ostatniej modyfikacji zasobu (UTC) |
lastModifiedBy |
string |
Tożsamość, która ostatnio zmodyfikowała zasób. |
lastModifiedByType |
Typ tożsamości, która ostatnio zmodyfikowała zasób. |