Partilhar via


Spacecrafts - List Available Contacts

Devolve a lista de contactos disponíveis. Está disponível um contacto se a nave estiver visível a partir da estação terrestre durante mais do que a duração mínima viável de contacto fornecida no perfil de contacto.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/listAvailableContacts?api-version=2022-11-01

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.

spacecraftName
path True

string

ID da nave espacial.

subscriptionId
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
contactProfile True

ContactProfile

A referência ao recurso do perfil de contacto.

endTime True

string

Hora de fim de um contacto (NORMA ISO 8601 UTC).

groundStationName True

string

Nome da Estação Terrestre do Azure.

startTime True

string

Hora de início de um contacto (NORMA ISO 8601 UTC).

Respostas

Name Tipo Description
200 OK

AvailableContactsListResult

Pedido com êxito. A operação devolve uma lista de recursos de contactos disponíveis.

202 Accepted

Aceite e a operação será concluída de forma assíncrona.

Cabeçalhos

Location: string

Other Status Codes

ErrorResponse

Resposta de erro que descreve a razão pela qual a operação falhou. Se o grupo de recursos não existir, será devolvido 404 (NotFound).

Exemplos

List of Contact

Pedido de amostra

POST https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/listAvailableContacts?api-version=2022-11-01

{
  "contactProfile": {
    "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"
  },
  "groundStationName": "EASTUS2_0",
  "startTime": "2022-11-01T11:30:00Z",
  "endTime": "2022-11-02T11:30:00Z"
}

Resposta da amostra

Location: https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01
{
  "value": [
    {
      "spacecraft": {
        "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"
      },
      "groundStationName": "EASTUS2_0",
      "properties": {
        "maximumElevationDegrees": 26.617297,
        "txStartTime": "2022-11-01T11:55:01Z",
        "txEndTime": "2022-11-01T12:05:25Z",
        "rxStartTime": "2022-11-01T11:55:01Z",
        "rxEndTime": "2022-11-01T12:05:25Z",
        "startAzimuthDegrees": 201.340472,
        "endAzimuthDegrees": 330.489627,
        "startElevationDegrees": 5,
        "endElevationDegrees": 5.040625
      }
    },
    {
      "spacecraft": {
        "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"
      },
      "groundStationName": "EASTUS2_0",
      "properties": {
        "maximumElevationDegrees": 85.9796,
        "txStartTime": "2022-11-02T10:58:30Z",
        "txEndTime": "2022-11-02T11:10:45Z",
        "rxStartTime": "2022-11-02T10:58:30Z",
        "rxEndTime": "2022-11-02T11:10:45Z",
        "startAzimuthDegrees": 165.758896,
        "endAzimuthDegrees": 345.848482,
        "startElevationDegrees": 5,
        "endElevationDegrees": 5.048656
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/listAvailableContacts?api-version=2022-11-01&$skiptoken=opaqueString"
}

Definições

Name Description
AuthorizedGroundstation

Estação de terra autorizada.

AutoTrackingConfiguration

Configuração de controlo automático.

AvailableContacts

O cliente obtém a lista de Contactos Disponíveis para um recurso de nave espacial. Mais tarde, um dos contactos disponíveis pode ser selecionado para criar um contacto.

AvailableContactsListResult

Resposta para a chamada do serviço API ListAvailableContacts.

ContactParameters

Parâmetros que definem o recurso de contacto.

ContactParameters.ContactProfile

A referência ao recurso do perfil de contacto.

ContactProfile

O cliente cria um Recurso de Perfil de Contacto, que irá conter todas as configurações necessárias para agendar um contacto.

ContactProfileLink

Contacte a Ligação do Perfil.

ContactProfileLinkChannel

Contacte o Canal de Ligação do Perfil.

ContactProfilesProperties.ProvisioningState

O estado atual da criação, eliminação ou modificação do recurso.

ContactProfileThirdPartyConfiguration

Contacte a configuração de parceiros de terceiros do Perfil.

createdByType

O tipo de identidade que criou o recurso.

direction

Direção (Uplink ou Downlink).

EndPoint

Ponto final do cliente para armazenar e obter dados durante um contacto com a nave espacial.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta a erros

NetworkConfiguration

Configuração de rede da rede virtual do cliente.

polarization

Polarização. por exemplo, (RHCP, LHCP).

protocol

Protocolo UDP ou TCP.

ProvisioningState

O estado atual da criação, eliminação ou modificação do recurso.

Spacecraft

O cliente cria um recurso de nave espacial para agendar um contacto.

SpacecraftLink

Lista de ligações de naves espaciais autorizadas por estação terrestre e a data de expiração da autorização.

systemData

Metadados relativos à criação e última modificação do recurso.

AuthorizedGroundstation

Estação de terra autorizada.

Name Tipo Description
expirationDate

string

Data de expiração da autorização.

groundStation

string

Nome da estação de terra.

AutoTrackingConfiguration

Configuração de controlo automático.

Name Tipo Description
disabled

string

sBand

string

xBand

string

AvailableContacts

O cliente obtém a lista de Contactos Disponíveis para um recurso de nave espacial. Mais tarde, um dos contactos disponíveis pode ser selecionado para criar um contacto.

Name Tipo Description
groundStationName

string

Nome da Estação Terrestre do Azure.

properties.endAzimuthDegrees

number

Azimuth da antena no final do contacto em graus decimais.

properties.endElevationDegrees

number

Elevação de naves espaciais acima do horizonte no final do contacto.

properties.maximumElevationDegrees

number

Elevação máxima da antena durante o contacto em graus decimais.

properties.rxEndTime

string

Tempo a perder ao receber um sinal (norma ISO 8601 UTC).

properties.rxStartTime

string

A hora mais antiga para receber um sinal (norma ISO 8601 UTC).

properties.startAzimuthDegrees

number

Azimuth da antena no início do contacto em graus decimais.

properties.startElevationDegrees

number

Elevação de naves espaciais acima do horizonte no início do contacto.

properties.txEndTime

string

Tempo em que a transmissão de antena será desativada (norma ISO 8601 UTC).

properties.txStartTime

string

Tempo em que a transmissão de antenas será ativada (NORMA ISO 8601 UTC).

spacecraft

Spacecraft

A referência ao recurso da nave espacial.

AvailableContactsListResult

Resposta para a chamada do serviço API ListAvailableContacts.

Name Tipo Description
nextLink

string

O URL para obter o próximo conjunto de resultados.

value

AvailableContacts[]

Uma lista de contactos disponíveis.

ContactParameters

Parâmetros que definem o recurso de contacto.

Name Tipo Description
contactProfile

ContactProfile

A referência ao recurso do perfil de contacto.

endTime

string

Hora de fim de um contacto (NORMA ISO 8601 UTC).

groundStationName

string

Nome da Estação Terrestre do Azure.

startTime

string

Hora de início de um contacto (NORMA ISO 8601 UTC).

ContactParameters.ContactProfile

A referência ao recurso do perfil de contacto.

Name Tipo Description
id

string

ID do Recurso.

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

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

ContactProfileLink[]

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

NetworkConfiguration

Configuração de rede da rede virtual do cliente.

properties.provisioningState

ContactProfilesProperties.ProvisioningState

O estado atual da criação, eliminação ou modificação do recurso.

properties.thirdPartyConfigurations

ContactProfileThirdPartyConfiguration[]

Configuração da missão de terceiros do Perfil de Contacto. Descreve ligações RF, processamento de modem e pontos finais IP.

systemData

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"

Contacte a Ligação do Perfil.

Name Tipo Description
channels

ContactProfileLinkChannel[]

Contacte o Canal de Ligação do Perfil.

direction

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

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

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.

ContactProfilesProperties.ProvisioningState

O estado atual da criação, eliminação ou modificação do recurso.

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

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

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

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.

Spacecraft

O cliente cria um recurso de nave espacial 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.links

SpacecraftLink[]

Lista imutável de ligações de naves espaciais.

properties.noradId

string

ID NORAD da nave espacial.

properties.provisioningState

ProvisioningState

O estado atual da criação, eliminação ou modificação do recurso.

properties.titleLine

string

Linha de título do conjunto de elementos de duas linhas (TLE).

properties.tleLine1

string

Linha 1 do conjunto de elementos de duas linhas (TLE).

properties.tleLine2

string

Linha 2 do conjunto de elementos de duas linhas (TLE).

systemData

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"

Lista de ligações de naves espaciais autorizadas por estação terrestre e a data de expiração da autorização.

Name Tipo Description
authorizations

AuthorizedGroundstation[]

Estações Terrestres Autorizadas

bandwidthMHz

number

Largura de banda em MHz.

centerFrequencyMHz

number

Frequência Central no MHz.

direction

direction

Direção (Uplink ou Downlink).

name

string

Nome da ligação.

polarization

polarization

Polarização. por exemplo, (RHCP, LHCP).

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

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

createdByType

O tipo de identidade que modificou o recurso pela última vez.