Contact Profiles - Create Or Update
Cria ou atualiza um perfil de contacto.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}?api-version=2022-11-01
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
contact
|
path | True |
string |
Contacte o Nome do perfil. |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas. |
subscription
|
path | True |
string |
O ID da subscrição de destino. |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
Corpo do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
location | True |
string |
A localização geográfica onde o recurso se encontra |
properties.links | True |
Ligações do Perfil de Contacto. Descreve ligações RF, processamento de modem e pontos finais IP. |
|
properties.networkConfiguration | True |
Configuração de rede da rede virtual do cliente. |
|
properties.autoTrackingConfiguration |
Configuração de controlo automático. |
||
properties.eventHubUri |
string |
Identificador de recursos do ARM do Hub de Eventos utilizado para telemetria. Requer a concessão do Fornecedor de Recursos Orbital aos direitos de envio de telemetria para o hub. |
|
properties.minimumElevationDegrees |
number |
Elevação viável mínima para o contacto em graus decimais. Utilizado para listar os contactos disponíveis com uma nave espacial numa determinada estação terrestre. |
|
properties.minimumViableContactDuration |
string |
Duração mínima viável do contacto no formato ISO 8601. Utilizado para listar os contactos disponíveis com uma nave espacial numa determinada estação terrestre. |
|
properties.provisioningState |
O estado atual da criação, eliminação ou modificação do recurso. |
||
properties.thirdPartyConfigurations |
Configuração da missão de terceiros do Perfil de Contacto. Descreve ligações RF, processamento de modem e pontos finais IP. |
||
tags |
object |
Etiquetas de recursos. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
Atualização com êxito. A operação devolve o recurso ContactProfile resultante. |
|
201 Created |
Crie com êxito. A operação devolve o recurso ContactProfile resultante. Cabeçalhos Azure-AsyncOperation: string |
|
Other Status Codes |
Resposta de erro que descreve a razão pela qual a operação falhou. |
Exemplos
Create a contact profile
Pedido de amostra
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"
}
}
]
}
]
}
}
Resposta da amostra
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
}
]
}
]
}
}
Definições
Name | Description |
---|---|
Auto |
Configuração de controlo automático. |
Contact |
O cliente cria um Recurso de Perfil de Contacto, que irá conter todas as configurações necessárias para agendar um contacto. |
Contact |
Contacte a Ligação do Perfil. |
Contact |
Contacte o Canal de Ligação do Perfil. |
Contact |
Contacte a configuração de parceiros de terceiros do Perfil. |
created |
O tipo de identidade que criou o recurso. |
direction |
Direção (Uplink ou Downlink). |
End |
Ponto final do cliente para armazenar e obter dados durante um contacto com a nave espacial. |
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta a erros |
Network |
Configuração de rede da rede virtual do cliente. |
polarization |
Polarização. por exemplo, (RHCP, LHCP). |
protocol |
Protocolo UDP ou TCP. |
Provisioning |
O estado atual da criação, eliminação ou modificação do recurso. |
system |
Metadados relativos à criação e última modificação do recurso. |
AutoTrackingConfiguration
Configuração de controlo automático.
Name | Tipo | Description |
---|---|---|
disabled |
string |
|
sBand |
string |
|
xBand |
string |
ContactProfile
O cliente cria um Recurso de Perfil de Contacto, que irá conter todas as configurações necessárias para agendar um contacto.
Name | Tipo | Description |
---|---|---|
id |
string |
ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
A localização geográfica onde o recurso se encontra |
name |
string |
O nome do recurso |
properties.autoTrackingConfiguration |
Configuração de controlo automático. |
|
properties.eventHubUri |
string |
Identificador de recursos do ARM do Hub de Eventos utilizado para telemetria. Requer a concessão do Fornecedor de Recursos Orbital aos direitos de envio de telemetria para o hub. |
properties.links |
Ligações do Perfil de Contacto. Descreve ligações RF, processamento de modem e pontos finais IP. |
|
properties.minimumElevationDegrees |
number |
Elevação viável mínima para o contacto em graus decimais. Utilizado para listar os contactos disponíveis com uma nave espacial numa determinada estação terrestre. |
properties.minimumViableContactDuration |
string |
Duração mínima viável do contacto no formato ISO 8601. Utilizado para listar os contactos disponíveis com uma nave espacial numa determinada estação terrestre. |
properties.networkConfiguration |
Configuração de rede da rede virtual do cliente. |
|
properties.provisioningState |
O estado atual da criação, eliminação ou modificação do recurso. |
|
properties.thirdPartyConfigurations |
Configuração da missão de terceiros do Perfil de Contacto. Descreve ligações RF, processamento de modem e pontos finais IP. |
|
systemData |
O Azure Resource Manager metadados que contêm informações createdBy e modifiedBy. |
|
tags |
object |
Etiquetas de recursos. |
type |
string |
O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" |
ContactProfileLink
Contacte a Ligação do Perfil.
Name | Tipo | Description |
---|---|---|
channels |
Contacte o Canal de Ligação do Perfil. |
|
direction |
Direção (Uplink ou Downlink). |
|
eirpdBW |
number |
Potência Isotrópica Efetiva (EIRP) em dBW. É o EIRP necessário pelo cliente. Ainda não foi utilizado. |
gainOverTemperature |
number |
Obter a temperatura de ruído em db/K. É o G/T necessário pelo cliente. Ainda não foi utilizado. |
name |
string |
Nome da ligação. |
polarization |
Polarização. por exemplo, (RHCP, LHCP). |
ContactProfileLinkChannel
Contacte o Canal de Ligação do Perfil.
Name | Tipo | Description |
---|---|---|
bandwidthMHz |
number |
Largura de banda em MHz. |
centerFrequencyMHz |
number |
Frequência Central no MHz. |
decodingConfiguration |
string |
Atualmente não utilizado. |
demodulationConfiguration |
string |
Cópia do ficheiro de configuração do modem, como Kratos QRadio ou Kratos QuantumRx. Apenas válido para direções de downlink. Se for fornecido, o modem liga-se ao ponto final do cliente e envia dados desmodulados em vez de um fluxo VITA.49. |
encodingConfiguration |
string |
Atualmente não utilizado. |
endPoint |
Ponto final do cliente para armazenar e obter dados durante um contacto com a nave espacial. |
|
modulationConfiguration |
string |
Cópia do ficheiro de configuração do modem, como Kratos QRadio. Apenas válido para direções de uplink. Se for fornecido, o modem liga-se ao ponto final do cliente e aceita comandos do cliente em vez de um fluxo VITA.49. |
name |
string |
Nome do canal. |
ContactProfileThirdPartyConfiguration
Contacte a configuração de parceiros de terceiros do Perfil.
Name | Tipo | Description |
---|---|---|
missionConfiguration |
string |
Nome da cadeia que referencia a configuração que descreve a configuração de contactos para uma determinada missão. Os valores esperados são aqueles que foram criados em colaboração com a rede de parceiros. |
providerName |
string |
Nome do fornecedor de terceiros. |
createdByType
O tipo de identidade que criou o recurso.
Name | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
direction
Direção (Uplink ou Downlink).
Name | Tipo | Description |
---|---|---|
Downlink |
string |
|
Uplink |
string |
EndPoint
Ponto final do cliente para armazenar e obter dados durante um contacto com a nave espacial.
Name | Tipo | Description |
---|---|---|
endPointName |
string |
Nome de um ponto final. |
ipAddress |
string |
Endereço IP (IPv4). |
port |
string |
Porta TCP para escutar para receber dados. |
protocol |
Protocolo UDP ou TCP. |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gestão de recursos.
Name | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
Name | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorResponse
Resposta a erros
Name | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
NetworkConfiguration
Configuração de rede da rede virtual do cliente.
Name | Tipo | Description |
---|---|---|
subnetId |
string |
Identificador de recursos do ARM da sub-rede delegada às Microsoft.Orbital/orbitalGateways. Tem de ser, pelo menos, uma sub-rede de classe C e não deve ter nenhum IP criado na mesma. |
polarization
Polarização. por exemplo, (RHCP, LHCP).
Name | Tipo | Description |
---|---|---|
LHCP |
string |
|
RHCP |
string |
|
linearHorizontal |
string |
|
linearVertical |
string |
protocol
Protocolo UDP ou TCP.
Name | Tipo | Description |
---|---|---|
TCP |
string |
|
UDP |
string |
ProvisioningState
O estado atual da criação, eliminação ou modificação do recurso.
systemData
Metadados relativos à criação e última modificação do recurso.
Name | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O carimbo de data/hora da última modificação do recurso (UTC) |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |