Contact Profiles - Create Or Update
Hiermee maakt u een contactprofiel of werkt u dit bij.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}?api-version=2022-11-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
contact
|
path | True |
string |
Naam van het profiel van de contactpersoon. |
resource
|
path | True |
string |
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig. |
subscription
|
path | True |
string |
De id van het doelabonnement. |
api-version
|
query | True |
string |
De API-versie die voor deze bewerking moet worden gebruikt. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
location | True |
string |
De geografische locatie waar de resource zich bevindt |
properties.links | True |
Koppelingen van het profiel van de contactpersoon. Beschrijft RF-koppelingen, modemverwerking en IP-eindpunten. |
|
properties.networkConfiguration | True |
Netwerkconfiguratie van het virtuele netwerk van de klant. |
|
properties.autoTrackingConfiguration |
Configuratie voor automatisch bijhouden. |
||
properties.eventHubUri |
string |
ARM-resource-id van de Event Hub die wordt gebruikt voor telemetrie. Vereist dat Orbital Resource Provider de rechten verleent om telemetriegegevens naar de hub te verzenden. |
|
properties.minimumElevationDegrees |
number |
Minimale levensvatbare verhoging voor de contactpersoon in decimale graden. Wordt gebruikt voor het weergeven van de beschikbare contacten met een ruimtevaartuig op een bepaald grondstation. |
|
properties.minimumViableContactDuration |
string |
Minimale levensvatbare contactduur in ISO 8601-indeling. Wordt gebruikt voor het weergeven van de beschikbare contacten met een ruimtevaartuig op een bepaald grondstation. |
|
properties.provisioningState |
De huidige status van het maken, verwijderen of wijzigen van de resource. |
||
properties.thirdPartyConfigurations |
Configuratie van de missie van derden van het contactprofiel. Beschrijft RF-koppelingen, modemverwerking en IP-eindpunten. |
||
tags |
object |
Resourcetags. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De update is voltooid. De bewerking retourneert de resulterende ContactProfile-resource. |
|
201 Created |
Het maken is voltooid. De bewerking retourneert de resulterende ContactProfile-resource. Headers Azure-AsyncOperation: string |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Voorbeelden
Create a contact profile
Sample Request
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"
}
}
]
}
]
}
}
Sample Response
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
}
]
}
]
}
}
Definities
Name | Description |
---|---|
Auto |
Configuratie voor automatisch bijhouden. |
Contact |
De klant maakt een profielresource voor contactpersonen, die alle configuraties bevat die nodig zijn voor het plannen van een contactpersoon. |
Contact |
Profielkoppeling voor contactpersoon. |
Contact |
Profielkoppelingskanaal voor contactpersonen. |
Contact |
Neem contact op met Profiel van externe partnerconfiguratie. |
created |
Het type identiteit waarmee de resource is gemaakt. |
direction |
Richting (uplink of downlink). |
End |
Eindpunt van de klant om gegevens op te slaan en op te halen tijdens contact met het ruimtevaartuig. |
Error |
Aanvullende informatie over de resourcebeheerfout. |
Error |
De foutdetails. |
Error |
Foutreactie |
Network |
Netwerkconfiguratie van het virtuele netwerk van de klant. |
polarization |
Polarisatie. bijvoorbeeld (RHCP, LHCP). |
protocol |
Protocol UDP of TCP. |
Provisioning |
De huidige status van het maken, verwijderen of wijzigen van de resource. |
system |
Metagegevens met betrekking tot het maken en laatste wijzigen van de resource. |
AutoTrackingConfiguration
Configuratie voor automatisch bijhouden.
Name | Type | Description |
---|---|---|
disabled |
string |
|
sBand |
string |
|
xBand |
string |
ContactProfile
De klant maakt een profielresource voor contactpersonen, die alle configuraties bevat die nodig zijn voor het plannen van een contactpersoon.
Name | Type | Description |
---|---|---|
id |
string |
Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
De geografische locatie waar de resource zich bevindt |
name |
string |
De naam van de resource |
properties.autoTrackingConfiguration |
Configuratie voor automatisch bijhouden. |
|
properties.eventHubUri |
string |
ARM-resource-id van de Event Hub die wordt gebruikt voor telemetrie. Vereist dat Orbital Resource Provider de rechten verleent om telemetriegegevens naar de hub te verzenden. |
properties.links |
Koppelingen van het profiel van de contactpersoon. Beschrijft RF-koppelingen, modemverwerking en IP-eindpunten. |
|
properties.minimumElevationDegrees |
number |
Minimale levensvatbare verhoging voor de contactpersoon in decimale graden. Wordt gebruikt voor het weergeven van de beschikbare contacten met een ruimtevaartuig op een bepaald grondstation. |
properties.minimumViableContactDuration |
string |
Minimale levensvatbare contactduur in ISO 8601-indeling. Wordt gebruikt voor het weergeven van de beschikbare contacten met een ruimtevaartuig op een bepaald grondstation. |
properties.networkConfiguration |
Netwerkconfiguratie van het virtuele netwerk van de klant. |
|
properties.provisioningState |
De huidige status van het maken, verwijderen of wijzigen van de resource. |
|
properties.thirdPartyConfigurations |
Configuratie van de missie van derden van het contactprofiel. Beschrijft RF-koppelingen, modemverwerking en IP-eindpunten. |
|
systemData |
Azure Resource Manager metagegevens met informatie over createdBy en modifiedBy. |
|
tags |
object |
Resourcetags. |
type |
string |
Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
ContactProfileLink
Profielkoppeling voor contactpersoon.
Name | Type | Description |
---|---|---|
channels |
Profielkoppelingskanaal voor contactpersonen. |
|
direction |
Richting (uplink of downlink). |
|
eirpdBW |
number |
Effectieve Isotropic Radiated Power (EIRP) in dBW. Dit is de vereiste EIRP door de klant. Nog niet gebruikt. |
gainOverTemperature |
number |
Gain tot ruistemperatuur in db/K. Dit is de vereiste G/T door de klant. Nog niet gebruikt. |
name |
string |
Naam van koppeling. |
polarization |
Polarisatie. bijvoorbeeld (RHCP, LHCP). |
ContactProfileLinkChannel
Profielkoppelingskanaal voor contactpersonen.
Name | Type | Description |
---|---|---|
bandwidthMHz |
number |
Bandbreedte in MHz. |
centerFrequencyMHz |
number |
Middenfrequentie in MHz. |
decodingConfiguration |
string |
Momenteel niet gebruikt. |
demodulationConfiguration |
string |
Kopie van het modemconfiguratiebestand, zoals Kratos QRadio of Kratos QuantumRx. Alleen geldig voor routebeschrijvingen voor downlinks. Indien opgegeven, maakt het modem verbinding met het eindpunt van de klant en verzendt gedemoduleerde gegevens in plaats van een VITA.49-stream. |
encodingConfiguration |
string |
Momenteel niet gebruikt. |
endPoint |
Eindpunt van de klant om gegevens op te slaan en op te halen tijdens contact met het ruimtevaartuig. |
|
modulationConfiguration |
string |
Kopie van het modemconfiguratiebestand, zoals Kratos QRadio. Alleen geldig voor routebeschrijvingen voor uplinks. Indien opgegeven, maakt de modem verbinding met het eindpunt van de klant en accepteert opdrachten van de klant in plaats van een VITA.49-stream. |
name |
string |
Kanaalnaam. |
ContactProfileThirdPartyConfiguration
Neem contact op met Profiel van externe partnerconfiguratie.
Name | Type | Description |
---|---|---|
missionConfiguration |
string |
De naam van de tekenreeks die verwijst naar de configuratie die het instellen van contactpersonen voor een bepaalde missie beschrijft. Verwachte waarden zijn de waarden die zijn gemaakt in samenwerking met het partnernetwerk. |
providerName |
string |
Naam van de externe provider. |
createdByType
Het type identiteit waarmee de resource is gemaakt.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
direction
Richting (uplink of downlink).
Name | Type | Description |
---|---|---|
Downlink |
string |
|
Uplink |
string |
EndPoint
Eindpunt van de klant om gegevens op te slaan en op te halen tijdens contact met het ruimtevaartuig.
Name | Type | Description |
---|---|---|
endPointName |
string |
Naam van een eindpunt. |
ipAddress |
string |
IP-adres (IPv4). |
port |
string |
TCP-poort waarop moet worden geluisterd om gegevens te ontvangen. |
protocol |
Protocol UDP of TCP. |
ErrorAdditionalInfo
Aanvullende informatie over de resourcebeheerfout.
Name | Type | Description |
---|---|---|
info |
object |
De aanvullende informatie. |
type |
string |
Het type aanvullende informatie. |
ErrorDetail
De foutdetails.
Name | Type | Description |
---|---|---|
additionalInfo |
De fout aanvullende informatie. |
|
code |
string |
De foutcode. |
details |
De foutdetails. |
|
message |
string |
Het foutbericht. |
target |
string |
Het foutdoel. |
ErrorResponse
Foutreactie
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
NetworkConfiguration
Netwerkconfiguratie van het virtuele netwerk van de klant.
Name | Type | Description |
---|---|---|
subnetId |
string |
ARM-resource-id van het subnet dat is gedelegeerd aan de Microsoft.Orbital/orbitalGateways. Moet ten minste een subnet van klasse C zijn en er mag geen IP-adres zijn gemaakt. |
polarization
Polarisatie. bijvoorbeeld (RHCP, LHCP).
Name | Type | Description |
---|---|---|
LHCP |
string |
|
RHCP |
string |
|
linearHorizontal |
string |
|
linearVertical |
string |
protocol
Protocol UDP of TCP.
Name | Type | Description |
---|---|---|
TCP |
string |
|
UDP |
string |
ProvisioningState
De huidige status van het maken, verwijderen of wijzigen van de resource.
systemData
Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
De tijdstempel van het maken van resources (UTC). |
createdBy |
string |
De identiteit die de resource heeft gemaakt. |
createdByType |
Het type identiteit waarmee de resource is gemaakt. |
|
lastModifiedAt |
string |
Het tijdstempel van de laatste wijziging van de resource (UTC) |
lastModifiedBy |
string |
De identiteit die de resource het laatst heeft gewijzigd. |
lastModifiedByType |
Het type identiteit dat de resource het laatst heeft gewijzigd. |