Contacts - Create
Skapar en kontakt.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/contacts/{contactName}?api-version=2022-11-01
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
contact
|
path | True |
string |
Kontaktnamn. |
resource
|
path | True |
string |
Namnet på resursgruppen. Namnet är skiftlägesokänsligt. |
spacecraft
|
path | True |
string |
Rymdfarkost-ID. |
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 |
---|---|---|---|
properties.contactProfile | True |
Referensen till kontaktprofilresursen. |
|
properties.groundStationName | True |
string |
Namn på Azure Ground Station. |
properties.reservationEndTime | True |
string |
Reservationssluttid för en kontakt (ISO 8601 UTC-standard). |
properties.reservationStartTime | True |
string |
Reservationsstarttid för en kontakt (ISO 8601 UTC-standard). |
properties.provisioningState |
Det aktuella tillståndet för resursens skapande, borttagning eller ändring. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK. |
|
201 Created |
Skapa lyckad. Åtgärden returnerar den resulterande kontaktresursen. Headers Azure-AsyncOperation: string |
|
Other Status Codes |
Felsvar som beskriver varför åtgärden misslyckades. |
Exempel
Create a contact
Sample Request
PUT https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1?api-version=2022-11-01
{
"properties": {
"reservationStartTime": "2023-02-22T10:58:30Z",
"reservationEndTime": "2023-02-22T11:10:45Z",
"groundStationName": "EASTUS2_0",
"contactProfile": {
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"
}
}
}
Sample Response
Azure-AsyncOperation: https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01
{
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1",
"name": "contact1",
"type": "Microsoft.Orbital/spacecrafts/contacts",
"properties": {
"status": "scheduled",
"reservationStartTime": "2023-02-22T10:58:30Z",
"reservationEndTime": "2023-02-22T11:10:45Z",
"errorMessage": null,
"groundStationName": "EASTUS2_0",
"contactProfile": {
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"
},
"antennaConfiguration": null,
"maximumElevationDegrees": 85.9796,
"txStartTime": "2023-02-22T10:58:30Z",
"txEndTime": "2023-02-22T11:10:45Z",
"rxStartTime": "2023-02-22T10:58:30Z",
"rxEndTime": "2023-02-22T11:10:45Z",
"startAzimuthDegrees": 165.758896,
"endAzimuthDegrees": 345.848482,
"startElevationDegrees": 5,
"endElevationDegrees": 5.048656
}
}
Azure-AsyncOperation: https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01
{
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1",
"name": "contact1",
"type": "Microsoft.Orbital/spacecrafts/contacts",
"properties": {
"status": "scheduled",
"reservationStartTime": "2023-02-22T10:58:30Z",
"reservationEndTime": "2023-02-22T11:10:45Z",
"errorMessage": null,
"groundStationName": "EASTUS2_0",
"contactProfile": {
"id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"
},
"antennaConfiguration": null,
"maximumElevationDegrees": 0,
"txStartTime": null,
"txEndTime": null,
"rxStartTime": null,
"rxEndTime": null,
"startAzimuthDegrees": 0,
"endAzimuthDegrees": 0,
"startElevationDegrees": 0,
"endElevationDegrees": 0
}
}
Definitioner
Name | Description |
---|---|
Antenna |
Konfigurationen som är associerad med den allokerade antennen. |
Contact |
Kunden skapar en kontaktresurs för en rymdfarkostresurs. |
Contact |
Referensen till kontaktprofilresursen. |
Contacts |
Status för en kontakt. |
created |
Den typ av identitet som skapade resursen. |
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Provisioning |
Det aktuella tillståndet för resursens skapande, borttagning eller ändring. |
system |
Metadata som rör skapande och senaste ändring av resursen. |
AntennaConfiguration
Konfigurationen som är associerad med den allokerade antennen.
Name | Typ | Description |
---|---|---|
destinationIp |
string |
Mål-IP-adressen som ett paket kan skickas till. Detta skulle till exempel vara den TCP-slutpunkt som du skulle skicka data till. |
sourceIps |
string[] |
Lista över käll-IP |
Contact
Kunden skapar en kontaktresurs för en rymdfarkostresurs.
Name | Typ | Description |
---|---|---|
id |
string |
Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Namnet på resursen |
properties.antennaConfiguration |
Konfigurationen som är associerad med den allokerade antennen. |
|
properties.contactProfile |
Referensen till kontaktprofilresursen. |
|
properties.endAzimuthDegrees |
number |
Azimuth av antennen i slutet av kontakten i decimalgrader. |
properties.endElevationDegrees |
number |
Rymdfarkostens höjd ovanför horisonten vid kontaktänden. |
properties.errorMessage |
string |
Eventuella felmeddelanden när en kontakt schemaläggs. |
properties.groundStationName |
string |
Namn på Azure Ground Station. |
properties.maximumElevationDegrees |
number |
Maximal höjning av antennen under kontakten i decimalgrader. |
properties.provisioningState |
Det aktuella tillståndet för resursens skapande, borttagning eller ändring. |
|
properties.reservationEndTime |
string |
Reservationssluttid för en kontakt (ISO 8601 UTC-standard). |
properties.reservationStartTime |
string |
Reservationsstarttid för en kontakt (ISO 8601 UTC-standard). |
properties.rxEndTime |
string |
Få sluttid för en kontakt (ISO 8601 UTC-standard). |
properties.rxStartTime |
string |
Få starttid för en kontakt (ISO 8601 UTC-standard). |
properties.startAzimuthDegrees |
number |
Azimuth av antennen i början av kontakten i decimalgrader. |
properties.startElevationDegrees |
number |
Rymdfarkosthöjning ovanför horisonten vid kontaktstart. |
properties.status |
Status för en kontakt. |
|
properties.txEndTime |
string |
Sändningssluttid för en kontakt (ISO 8601 UTC-standard). |
properties.txStartTime |
string |
Sändningsstarttid för en kontakt (ISO 8601 UTC-standard). |
systemData |
Azure Resource Manager metadata som innehåller createdBy och modifiedBy information. |
|
type |
string |
Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" |
ContactProfile
Referensen till kontaktprofilresursen.
Name | Typ | Description |
---|---|---|
id |
string |
Resurs-ID. |
ContactsStatus
Status för en kontakt.
Name | Typ | Description |
---|---|---|
cancelled |
string |
|
failed |
string |
|
providerCancelled |
string |
|
scheduled |
string |
|
succeeded |
string |
createdByType
Den typ av identitet som skapade resursen.
Name | Typ | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
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. |
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. |