Compartilhar via


Spacecrafts - List Available Contacts

Retorna a lista de contatos disponíveis. Um contato estará disponível se a nave estiver visível da estação terrestre por mais do que a duração mínima de contato viável fornecida no perfil de contato.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

spacecraftName
path True

string

ID da nave espacial.

subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome Obrigatório Tipo Description
contactProfile True

ContactProfile

A referência ao recurso de perfil de contato.

endTime True

string

Hora de término de um contato (padrão UTC ISO 8601).

groundStationName True

string

Nome da Estação Terrestre do Azure.

startTime True

string

Hora de início de um contato (padrão UTC ISO 8601).

Respostas

Nome Tipo Description
200 OK

AvailableContactsListResult

Solicitação bem-sucedida. A operação retorna uma lista de recursos de contatos disponíveis.

202 Accepted

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

Headers

Location: string

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou. Se o grupo de recursos não existir, 404 (NotFound) serão retornados.

Exemplos

List of Contact

Sample Request

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"
}

Sample Response

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

Nome Description
AuthorizedGroundstation

Estação terrestre autorizada.

AutoTrackingConfiguration

Configuração de acompanhamento automático.

AvailableContacts

O cliente recupera a lista de Contatos Disponíveis para um recurso de nave espacial. Posteriormente, um dos contatos disponíveis pode ser selecionado para criar um contato.

AvailableContactsListResult

Resposta para a chamada ao serviço de API ListAvailableContacts.

ContactParameters

Parâmetros que definem o recurso de contato.

ContactParameters.ContactProfile

A referência ao recurso de perfil de contato.

ContactProfile

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

ContactProfileLink

Link do Perfil de Contato.

ContactProfileLinkChannel

Entrar em contato com o Canal de Link do Perfil.

ContactProfilesProperties.ProvisioningState

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

ContactProfileThirdPartyConfiguration

Contate a configuração de parceiro de terceiros do Perfil.

createdByType

O tipo de identidade que criou o recurso.

direction

Direção (Uplink ou Downlink).

EndPoint

Ponto de extremidade do cliente para armazenar e recuperar dados durante um contato com a nave espacial.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

Os detalhes do erro.

ErrorResponse

Resposta de erro

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, exclusão ou modificação do recurso.

Spacecraft

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

SpacecraftLink

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

systemData

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

AuthorizedGroundstation

Estação terrestre autorizada.

Nome Tipo Description
expirationDate

string

Data de validade da autorização.

groundStation

string

Nome da estação de terra.

AutoTrackingConfiguration

Configuração de acompanhamento automático.

Nome Tipo Description
disabled

string

sBand

string

xBand

string

AvailableContacts

O cliente recupera a lista de Contatos Disponíveis para um recurso de nave espacial. Posteriormente, um dos contatos disponíveis pode ser selecionado para criar um contato.

Nome Tipo Description
groundStationName

string

Nome da Estação Terrestre do Azure.

properties.endAzimuthDegrees

number

Azimute da antena no final do contato em graus decimais.

properties.endElevationDegrees

number

Elevação de nave espacial acima do horizonte no fim do contato.

properties.maximumElevationDegrees

number

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

properties.rxEndTime

string

Tempo de perda ao receber um sinal (padrão ISO 8601 UTC).

properties.rxStartTime

string

Hora mais antiga para receber um sinal (padrão ISO 8601 UTC).

properties.startAzimuthDegrees

number

Azimute da antena no início do contato em graus decimais.

properties.startElevationDegrees

number

Elevação de nave espacial acima do horizonte no início do contato.

properties.txEndTime

string

Hora em que a transmissão da antena será desabilitada (padrão ISO 8601 UTC).

properties.txStartTime

string

Hora em que a transmissão de antena será habilitada (padrão ISO 8601 UTC).

spacecraft

Spacecraft

A referência ao recurso de nave espacial.

AvailableContactsListResult

Resposta para a chamada ao serviço de API ListAvailableContacts.

Nome Tipo Description
nextLink

string

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

value

AvailableContacts[]

Uma lista de contatos disponíveis.

ContactParameters

Parâmetros que definem o recurso de contato.

Nome Tipo Description
contactProfile

ContactProfile

A referência ao recurso de perfil de contato.

endTime

string

Hora de término de um contato (padrão ISO 8601 UTC).

groundStationName

string

Nome da Estação Terrestre do Azure.

startTime

string

Hora de início de um contato (padrão ISO 8601 UTC).

ContactParameters.ContactProfile

A referência ao recurso de perfil de contato.

Nome Tipo Description
id

string

ID do recurso.

ContactProfile

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

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

A localização geográfica em que o recurso reside

name

string

O nome do recurso

properties.autoTrackingConfiguration

AutoTrackingConfiguration

Configuração de acompanhamento automático.

properties.eventHubUri

string

Identificador de recurso arm do Hub de Eventos usado para telemetria. Requer a concessão do Provedor de Recursos orbital os direitos para enviar telemetria para o hub.

properties.links

ContactProfileLink[]

Links do Perfil de Contato. Descreve links RF, processamento de modem e pontos de extremidade IP.

properties.minimumElevationDegrees

number

Elevação viável mínima para o contato em graus decimais. Usado para listar os contatos disponíveis com uma nave espacial em uma determinada estação terrestre.

properties.minimumViableContactDuration

string

Duração mínima do contato viável no formato ISO 8601. Usado para listar os contatos disponíveis com uma nave espacial em uma 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, exclusão ou modificação do recurso.

properties.thirdPartyConfigurations

ContactProfileThirdPartyConfiguration[]

Configuração de missão de terceiros do Perfil de Contato. Descreve links RF, processamento de modem e pontos de extremidade IP.

systemData

systemData

Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.

tags

object

Marcas de recurso.

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

Link do Perfil de Contato.

Nome Tipo Description
channels

ContactProfileLinkChannel[]

Entrar em contato com o Canal de Link do Perfil.

direction

direction

Direção (Uplink ou Downlink).

eirpdBW

number

EiRP (Energia Radiada Isotrópica) eficaz no dBW. É o EIRP exigido pelo cliente. Ainda não foi usado.

gainOverTemperature

number

Ganho à temperatura do ruído no banco de dados/K. É o G/T necessário para o cliente. Ainda não foi usado.

name

string

Nome do link.

polarization

polarization

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

ContactProfileLinkChannel

Entrar em contato com o Canal de Link do Perfil.

Nome Tipo Description
bandwidthMHz

number

Largura de banda no MHz.

centerFrequencyMHz

number

Frequência central no MHz.

decodingConfiguration

string

Atualmente não utilizado.

demodulationConfiguration

string

Cópia do arquivo de configuração de modem, como Kratos QRadio ou Kratos QuantumRx. Válido apenas para direções de downlink. Se fornecido, o modem se conecta ao ponto de extremidade do cliente e envia dados rebaixados em vez de um fluxo VITA.49.

encodingConfiguration

string

Atualmente não utilizado.

endPoint

EndPoint

Ponto de extremidade do cliente para armazenar e recuperar dados durante um contato com a nave espacial.

modulationConfiguration

string

Cópia do arquivo de configuração de modem, como Kratos QRadio. Válido apenas para trajetos de uplink. Se fornecido, o modem se conecta ao ponto de extremidade 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, exclusão ou modificação do recurso.

ContactProfileThirdPartyConfiguration

Contate a configuração de parceiro de terceiros do Perfil.

Nome Tipo Description
missionConfiguration

string

Nome da cadeia de caracteres que faz referência à configuração que descreve a configuração de contato para uma missão específica. Os valores esperados são aqueles que foram criados em colaboração com a rede de parceiros.

providerName

string

Nome do provedor de terceiros.

createdByType

O tipo de identidade que criou o recurso.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

direction

Direção (Uplink ou Downlink).

Nome Tipo Description
Downlink

string

Uplink

string

EndPoint

Ponto de extremidade do cliente para armazenar e recuperar dados durante um contato com a nave espacial.

Nome Tipo Description
endPointName

string

Nome de um ponto de extremidade.

ipAddress

string

Endereço IP (IPv4).

port

string

Porta TCP para escutar para receber dados.

protocol

protocol

Protocolo UDP ou TCP.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

Nome 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 de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

NetworkConfiguration

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

Nome Tipo Description
subnetId

string

Identificador de recurso arm da sub-rede delegada para Microsoft.Orbital/orbitalGateways. Precisa ser pelo menos uma sub-rede C de classe e não deve ter nenhum IP criado nela.

polarization

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

Nome Tipo Description
LHCP

string

RHCP

string

linearHorizontal

string

linearVertical

string

protocol

Protocolo UDP ou TCP.

Nome Tipo Description
TCP

string

UDP

string

ProvisioningState

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

Spacecraft

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

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

A localização geográfica em que o recurso reside

name

string

O nome do recurso

properties.links

SpacecraftLink[]

Lista imutável de links de naves espaciais.

properties.noradId

string

ID de NORAD da nave espacial.

properties.provisioningState

ProvisioningState

O estado atual da criação, exclusã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

Os metadados do Azure Resource Manager que contêm as informações createdBy e modifiedBy.

tags

object

Marcas de recurso.

type

string

Tipo do 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 validade da autorização.

Nome Tipo Description
authorizations

AuthorizedGroundstation[]

Estações terrestres autorizadas

bandwidthMHz

number

Largura de banda no MHz.

centerFrequencyMHz

number

Frequência central no MHz.

direction

direction

Direção (Uplink ou Downlink).

name

string

Nome do link.

polarization

polarization

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

systemData

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

Nome 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.