Contact Profiles - Create Or Update
Skapar eller uppdaterar en kontaktprofil.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}?api-version=2022-11-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
contact
|
path | True |
string |
Namn på kontaktprofil. |
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
subscription
|
path | True |
string |
ID för målprenumerationen. |
api-version
|
query | True |
string |
Den API-version som ska användas för den här åtgärden. |
Begärandetext
Name | Obligatorisk | Typ | Description |
---|---|---|---|
location | True |
string |
Den geo-plats där resursen finns |
properties.links | True |
Länkar till kontaktprofilen. Beskriver RF-länkar, modembearbetning och IP-slutpunkter. |
|
properties.networkConfiguration | True |
Nätverkskonfiguration för kundens virtuella nätverk. |
|
properties.autoTrackingConfiguration |
Automatisk spårningskonfiguration. |
||
properties.eventHubUri |
string |
ARM-resursidentifierare för den händelsehubb som används för telemetri. Kräver att Orbital Resource Provider beviljas behörighet att skicka telemetri till hubben. |
|
properties.minimumElevationDegrees |
number |
Minsta livskraftiga höjning för kontakten i decimalgrader. Används för att lista tillgängliga kontakter med en rymdfarkost på en viss markstation. |
|
properties.minimumViableContactDuration |
string |
Minsta varaktighet för livskraftig kontakt i ISO 8601-format. Används för att lista tillgängliga kontakter med en rymdfarkost på en viss markstation. |
|
properties.provisioningState |
Det aktuella tillståndet för resursens skapande, borttagning eller ändring. |
||
properties.thirdPartyConfigurations |
Tredjepartsuppdragskonfiguration för kontaktprofilen. Beskriver RF-länkar, modembearbetning och IP-slutpunkter. |
||
tags |
object |
Resurstaggar. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Uppdateringen lyckades. Åtgärden returnerar den resulterande ContactProfile-resursen. |
|
201 Created |
Skapa lyckades. Åtgärden returnerar den resulterande ContactProfile-resursen. Sidhuvuden Azure-AsyncOperation: string |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Exempel
Create a contact profile
Exempelbegäran
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"
}
}
]
}
]
}
}
Exempelsvar
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
}
]
}
]
}
}
Definitioner
Name | Description |
---|---|
Auto |
Automatisk spårningskonfiguration. |
Contact |
Kunden skapar en kontaktprofilresurs som innehåller alla konfigurationer som krävs för att schemalägga en kontakt. |
Contact |
Kontaktprofillänk. |
Contact |
Kontaktprofillänkkanal. |
Contact |
Kontakta profilens partnerkonfiguration från tredje part. |
created |
Den typ av identitet som skapade resursen. |
direction |
Riktning (överordnad eller nedlänk). |
End |
Kundens slutpunkt för att lagra och hämta data under en kontakt med rymdfarkosten. |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Network |
Nätverkskonfiguration för kundens virtuella nätverk. |
polarization |
Polarisering. (RHCP, LHCP). |
protocol |
Protokoll, antingen UDP eller TCP. |
Provisioning |
Det aktuella tillståndet för resursens skapande, borttagning eller ändring. |
system |
Metadata som rör skapande och senaste ändring av resursen. |
AutoTrackingConfiguration
Automatisk spårningskonfiguration.
Name | Typ | Description |
---|---|---|
disabled |
string |
|
sBand |
string |
|
xBand |
string |
ContactProfile
Kunden skapar en kontaktprofilresurs som innehåller alla konfigurationer som krävs för att schemalägga en kontakt.
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
Den geo-plats där resursen finns |
name |
string |
Namnet på resursen |
properties.autoTrackingConfiguration |
Automatisk spårningskonfiguration. |
|
properties.eventHubUri |
string |
ARM-resursidentifierare för den händelsehubb som används för telemetri. Kräver att Orbital Resource Provider beviljas behörighet att skicka telemetri till hubben. |
properties.links |
Länkar till kontaktprofilen. Beskriver RF-länkar, modembearbetning och IP-slutpunkter. |
|
properties.minimumElevationDegrees |
number |
Minsta livskraftiga höjning för kontakten i decimalgrader. Används för att lista tillgängliga kontakter med en rymdfarkost på en viss markstation. |
properties.minimumViableContactDuration |
string |
Minsta varaktighet för livskraftig kontakt i ISO 8601-format. Används för att lista tillgängliga kontakter med en rymdfarkost på en viss markstation. |
properties.networkConfiguration |
Nätverkskonfiguration för kundens virtuella nätverk. |
|
properties.provisioningState |
Det aktuella tillståndet för resursens skapande, borttagning eller ändring. |
|
properties.thirdPartyConfigurations |
Tredjepartsuppdragskonfiguration för kontaktprofilen. Beskriver RF-länkar, modembearbetning och IP-slutpunkter. |
|
systemData |
Azure Resource Manager metadata som innehåller createdBy och modifiedBy information. |
|
tags |
object |
Resurstaggar. |
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
ContactProfileLink
Kontaktprofillänk.
Name | Typ | Description |
---|---|---|
channels |
Kontaktprofillänkkanal. |
|
direction |
Riktning (överordnad eller nedlänk). |
|
eirpdBW |
number |
Effektiv isotropisk utstrålad kraft (EIRP) i dBW. Det är den EIRP som krävs av kunden. Används inte än. |
gainOverTemperature |
number |
Öka till brustemperaturen i db/K. Det är kundens obligatoriska G/T. Används inte än. |
name |
string |
Länknamn. |
polarization |
Polarisering. (RHCP, LHCP). |
ContactProfileLinkChannel
Kontaktprofillänkkanal.
Name | Typ | Description |
---|---|---|
bandwidthMHz |
number |
Bandbredd i MHz. |
centerFrequencyMHz |
number |
Center Frequency i MHz. |
decodingConfiguration |
string |
Används för närvarande inte. |
demodulationConfiguration |
string |
Kopia av modemkonfigurationsfilen, till exempel Kratos QRadio eller Kratos QuantumRx. Endast giltigt för vägbeskrivningar för nedlänkar. Om det tillhandahålls ansluter modemet till kundslutpunkten och skickar demodulerade data i stället för en VITA.49-ström. |
encodingConfiguration |
string |
Används för närvarande inte. |
endPoint |
Kundens slutpunkt för att lagra och hämta data under en kontakt med rymdfarkosten. |
|
modulationConfiguration |
string |
Kopia av modemkonfigurationsfilen, till exempel Kratos QRadio. Endast giltigt för vägbeskrivningar för överordnad länk. Om det tillhandahålls ansluter modemet till kundslutpunkten och accepterar kommandon från kunden i stället för en VITA.49-ström. |
name |
string |
Kanalnamn. |
ContactProfileThirdPartyConfiguration
Kontakta profilens partnerkonfiguration från tredje part.
Name | Typ | Description |
---|---|---|
missionConfiguration |
string |
Namnet på strängen som refererar till konfigurationen som beskriver kontaktkonfigurationen för ett visst uppdrag. Förväntade värden är de som har skapats i samarbete med partnernätverket. |
providerName |
string |
Namnet på tredjepartsprovidern. |
createdByType
Den typ av identitet som skapade resursen.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
direction
Riktning (överordnad eller nedlänk).
Name | Typ | Description |
---|---|---|
Downlink |
string |
|
Uplink |
string |
EndPoint
Kundens slutpunkt för att lagra och hämta data under en kontakt med rymdfarkosten.
Name | Typ | Description |
---|---|---|
endPointName |
string |
Namnet på en slutpunkt. |
ipAddress |
string |
IP-adress (IPv4). |
port |
string |
TCP-port för att lyssna på för att ta emot data. |
protocol |
Protokoll, antingen UDP eller TCP. |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Ytterligare information. |
type |
string |
Den ytterligare informationstypen. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
NetworkConfiguration
Nätverkskonfiguration för kundens virtuella nätverk.
Name | Typ | Description |
---|---|---|
subnetId |
string |
ARM-resursidentifierare för undernätet som delegerats till Microsoft.Orbital/orbitalGateways. Måste vara minst ett klass C-undernät och bör inte ha någon IP-adress skapad i det. |
polarization
Polarisering. (RHCP, LHCP).
Name | Typ | Description |
---|---|---|
LHCP |
string |
|
RHCP |
string |
|
linearHorizontal |
string |
|
linearVertical |
string |
protocol
Protokoll, antingen UDP eller TCP.
Name | Typ | Description |
---|---|---|
TCP |
string |
|
UDP |
string |
ProvisioningState
Det aktuella tillståndet för resursens skapande, borttagning eller ändring.
systemData
Metadata som rör skapande och senaste ändring av resursen.
Name | Typ | Description |
---|---|---|
createdAt |
string |
Tidsstämpeln för resursskapande (UTC). |
createdBy |
string |
Identiteten som skapade resursen. |
createdByType |
Den typ av identitet som skapade resursen. |
|
lastModifiedAt |
string |
Tidsstämpeln för resursens senaste ändring (UTC) |
lastModifiedBy |
string |
Identiteten som senast ändrade resursen. |
lastModifiedByType |
Den typ av identitet som senast ändrade resursen. |