armorbital

package module
v2.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 24, 2023 License: MIT Imports: 14 Imported by: 1

README

Azure Orbital Module for Go

PkgGoDev

The armorbital module provides operations for working with Azure Orbital.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Orbital module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Orbital. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Client Factory

Azure Orbital module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armorbital.NewClientFactory(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armorbital.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewContactsClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Orbital label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionType 

type ActionType string

ActionType - Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. 

const (
	ActionTypeInternal ActionType = "Internal"
)

func PossibleActionTypeValues 

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns the possible values for the ActionType const type.

type AuthorizedGroundstation 

type AuthorizedGroundstation struct {
	// REQUIRED; Date of authorization expiration.
	ExpirationDate *time.Time

	// REQUIRED; Groundstation name.
	GroundStation *string
}

AuthorizedGroundstation - Authorized groundstation.

func (AuthorizedGroundstation) MarshalJSON 

func (a AuthorizedGroundstation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AuthorizedGroundstation.

func (*AuthorizedGroundstation) UnmarshalJSON 

func (a *AuthorizedGroundstation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AuthorizedGroundstation.

type AutoTrackingConfiguration 

type AutoTrackingConfiguration string

AutoTrackingConfiguration - Auto-tracking configuration. 

const (
	AutoTrackingConfigurationDisabled AutoTrackingConfiguration = "disabled"
	AutoTrackingConfigurationSBand    AutoTrackingConfiguration = "sBand"
	AutoTrackingConfigurationXBand    AutoTrackingConfiguration = "xBand"
)

func PossibleAutoTrackingConfigurationValues 

func PossibleAutoTrackingConfigurationValues() []AutoTrackingConfiguration

PossibleAutoTrackingConfigurationValues returns the possible values for the AutoTrackingConfiguration const type.

type AvailableContacts 

type AvailableContacts struct {
	// Properties of Contact resource.
	Properties *AvailableContactsProperties

	// The reference to the spacecraft resource.
	Spacecraft *AvailableContactsSpacecraft

	// READ-ONLY; Name of Azure Ground Station.
	GroundStationName *string
}

AvailableContacts - Customer retrieves list of Available Contacts for a spacecraft resource. Later, one of the available contact can be selected to create a contact.

func (AvailableContacts) MarshalJSON 

func (a AvailableContacts) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableContacts.

func (*AvailableContacts) UnmarshalJSON 

func (a *AvailableContacts) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableContacts.

type AvailableContactsListResult 

type AvailableContactsListResult struct {
	// A list of available contacts.
	Value []*AvailableContacts

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

AvailableContactsListResult - Response for the ListAvailableContacts API service call.

func (AvailableContactsListResult) MarshalJSON 

func (a AvailableContactsListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableContactsListResult.

func (*AvailableContactsListResult) UnmarshalJSON 

func (a *AvailableContactsListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableContactsListResult.

type AvailableContactsProperties 

type AvailableContactsProperties struct {
	// READ-ONLY; Azimuth of the antenna at the end of the contact in decimal degrees.
	EndAzimuthDegrees *float32

	// READ-ONLY; Spacecraft elevation above the horizon at contact end.
	EndElevationDegrees *float32

	// READ-ONLY; Maximum elevation of the antenna during the contact in decimal degrees.
	MaximumElevationDegrees *float32

	// READ-ONLY; Time to lost receiving a signal (ISO 8601 UTC standard).
	RxEndTime *time.Time

	// READ-ONLY; Earliest time to receive a signal (ISO 8601 UTC standard).
	RxStartTime *time.Time

	// READ-ONLY; Azimuth of the antenna at the start of the contact in decimal degrees.
	StartAzimuthDegrees *float32

	// READ-ONLY; Spacecraft elevation above the horizon at contact start.
	StartElevationDegrees *float32

	// READ-ONLY; Time at which antenna transmit will be disabled (ISO 8601 UTC standard).
	TxEndTime *time.Time

	// READ-ONLY; Time at which antenna transmit will be enabled (ISO 8601 UTC standard).
	TxStartTime *time.Time
}

AvailableContactsProperties - Properties of Contact resource.

func (AvailableContactsProperties) MarshalJSON 

func (a AvailableContactsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableContactsProperties.

func (*AvailableContactsProperties) UnmarshalJSON 

func (a *AvailableContactsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableContactsProperties.

type AvailableContactsSpacecraft 

type AvailableContactsSpacecraft struct {
	// REQUIRED; Resource ID.
	ID *string
}

AvailableContactsSpacecraft - The reference to the spacecraft resource.

func (AvailableContactsSpacecraft) MarshalJSON 

func (a AvailableContactsSpacecraft) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableContactsSpacecraft.

func (*AvailableContactsSpacecraft) UnmarshalJSON 

func (a *AvailableContactsSpacecraft) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableContactsSpacecraft.

type AvailableGroundStation 

type AvailableGroundStation struct {
	// REQUIRED; The properties bag for this resource.
	Properties *AvailableGroundStationProperties

	// Azure region.
	Location *string

	// READ-ONLY; ID of groundStation.
	ID *string

	// READ-ONLY; Name of the ground station.
	Name *string

	// READ-ONLY; Resource type.
	Type *string
}

AvailableGroundStation - Ground Stations available to schedule Contacts.

func (AvailableGroundStation) MarshalJSON 

func (a AvailableGroundStation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableGroundStation.

func (*AvailableGroundStation) UnmarshalJSON 

func (a *AvailableGroundStation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableGroundStation.

type AvailableGroundStationListResult 

type AvailableGroundStationListResult struct {
	// A list of ground station resources.
	Value []*AvailableGroundStation

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

AvailableGroundStationListResult - Response for the AvailableGroundStations API service call.

func (AvailableGroundStationListResult) MarshalJSON 

func (a AvailableGroundStationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableGroundStationListResult.

func (*AvailableGroundStationListResult) UnmarshalJSON 

func (a *AvailableGroundStationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableGroundStationListResult.

type AvailableGroundStationProperties 

type AvailableGroundStationProperties struct {
	// Altitude of the ground station.
	AltitudeMeters *float32

	// City of ground station.
	City *string

	// Latitude of the ground station in decimal degrees.
	LatitudeDegrees *float32

	// Longitude of the ground station in decimal degrees.
	LongitudeDegrees *float32

	// Ground station provider name.
	ProviderName *string

	// Release Status of a ground station.
	ReleaseMode *ReleaseMode
}

AvailableGroundStationProperties - The properties bag for this resource.

func (AvailableGroundStationProperties) MarshalJSON 

func (a AvailableGroundStationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableGroundStationProperties.

func (*AvailableGroundStationProperties) UnmarshalJSON 

func (a *AvailableGroundStationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableGroundStationProperties.

type AvailableGroundStationPropertiesAutoGenerated 

type AvailableGroundStationPropertiesAutoGenerated struct {
	// Altitude of the ground station.
	AltitudeMeters *float32

	// City of ground station.
	City *string

	// Latitude of the ground station in decimal degrees.
	LatitudeDegrees *float32

	// Longitude of the ground station in decimal degrees.
	LongitudeDegrees *float32

	// Ground station provider name.
	ProviderName *string

	// Release Status of a ground station.
	ReleaseMode *ReleaseMode
}

AvailableGroundStationPropertiesAutoGenerated - Properties object for Available groundstation.

func (AvailableGroundStationPropertiesAutoGenerated) MarshalJSON 

func (a AvailableGroundStationPropertiesAutoGenerated) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AvailableGroundStationPropertiesAutoGenerated.

func (*AvailableGroundStationPropertiesAutoGenerated) UnmarshalJSON 

func (a *AvailableGroundStationPropertiesAutoGenerated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableGroundStationPropertiesAutoGenerated.

type AvailableGroundStationsClient 

type AvailableGroundStationsClient struct {
	// contains filtered or unexported fields
}

AvailableGroundStationsClient contains the methods for the AvailableGroundStations group. Don't use this type directly, use NewAvailableGroundStationsClient() instead.

func NewAvailableGroundStationsClient 

func NewAvailableGroundStationsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AvailableGroundStationsClient, error)

NewAvailableGroundStationsClient creates a new instance of AvailableGroundStationsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*AvailableGroundStationsClient) NewListByCapabilityPager 

func (client *AvailableGroundStationsClient) NewListByCapabilityPager(capability CapabilityParameter, options *AvailableGroundStationsClientListByCapabilityOptions) *runtime.Pager[AvailableGroundStationsClientListByCapabilityResponse]

NewListByCapabilityPager - Returns list of available ground stations.

Generated from API version 2022-11-01

  • capability - Ground Station Capability.
  • options - AvailableGroundStationsClientListByCapabilityOptions contains the optional parameters for the AvailableGroundStationsClient.NewListByCapabilityPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/AvailableGroundStationsByCapabilityList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewAvailableGroundStationsClient().NewListByCapabilityPager(armorbital.CapabilityParameterEarthObservation, nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.AvailableGroundStationListResult = armorbital.AvailableGroundStationListResult{
	// 	Value: []*armorbital.AvailableGroundStation{
	// 		{
	// 			Name: to.Ptr("EASTUS2_0"),
	// 			Type: to.Ptr("Microsoft.Orbital/availableGroundStations"),
	// 			ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/availableGroundStations/EASTUS2_0"),
	// 			Location: to.Ptr("eastus2"),
	// 			Properties: &armorbital.AvailableGroundStationProperties{
	// 				AltitudeMeters: to.Ptr[float32](1641),
	// 				City: to.Ptr("Atlanta"),
	// 				LatitudeDegrees: to.Ptr[float32](33.74831),
	// 				LongitudeDegrees: to.Ptr[float32](-84.39111),
	// 				ProviderName: to.Ptr("Microsoft"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("EASTUS_1"),
	// 			Type: to.Ptr("Microsoft.Orbital/availableGroundStations"),
	// 			ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/availableGroundStations/EASTUS_1"),
	// 			Location: to.Ptr("eastus2"),
	// 			Properties: &armorbital.AvailableGroundStationProperties{
	// 				AltitudeMeters: to.Ptr[float32](128),
	// 				City: to.Ptr("Reston"),
	// 				LatitudeDegrees: to.Ptr[float32](38.9586307),
	// 				LongitudeDegrees: to.Ptr[float32](-77.357002),
	// 				ProviderName: to.Ptr("Microsoft"),
	// 			},
	// 	}},
	// }
}

Output:

type AvailableGroundStationsClientListByCapabilityOptions 

type AvailableGroundStationsClientListByCapabilityOptions struct {
}

AvailableGroundStationsClientListByCapabilityOptions contains the optional parameters for the AvailableGroundStationsClient.NewListByCapabilityPager method.

type AvailableGroundStationsClientListByCapabilityResponse 

type AvailableGroundStationsClientListByCapabilityResponse struct {
	// Response for the AvailableGroundStations API service call.
	AvailableGroundStationListResult
}

AvailableGroundStationsClientListByCapabilityResponse contains the response from method AvailableGroundStationsClient.NewListByCapabilityPager.

type Capability 

type Capability string

Capability - Capability of the Ground Station. 

const (
	CapabilityCommunication    Capability = "Communication"
	CapabilityEarthObservation Capability = "EarthObservation"
)

func PossibleCapabilityValues 

func PossibleCapabilityValues() []Capability

PossibleCapabilityValues returns the possible values for the Capability const type.

type CapabilityParameter 

type CapabilityParameter string
const (
	CapabilityParameterCommunication    CapabilityParameter = "Communication"
	CapabilityParameterEarthObservation CapabilityParameter = "EarthObservation"
)

func PossibleCapabilityParameterValues 

func PossibleCapabilityParameterValues() []CapabilityParameter

PossibleCapabilityParameterValues returns the possible values for the CapabilityParameter const type.

type ClientFactory 

type ClientFactory struct {
	// contains filtered or unexported fields
}

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewAvailableGroundStationsClient 

func (c *ClientFactory) NewAvailableGroundStationsClient() *AvailableGroundStationsClient

NewAvailableGroundStationsClient creates a new instance of AvailableGroundStationsClient.

func (*ClientFactory) NewContactProfilesClient 

func (c *ClientFactory) NewContactProfilesClient() *ContactProfilesClient

NewContactProfilesClient creates a new instance of ContactProfilesClient.

func (*ClientFactory) NewContactsClient 

func (c *ClientFactory) NewContactsClient() *ContactsClient

NewContactsClient creates a new instance of ContactsClient.

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewOperationsResultsClient 

func (c *ClientFactory) NewOperationsResultsClient() *OperationsResultsClient

NewOperationsResultsClient creates a new instance of OperationsResultsClient.

func (*ClientFactory) NewSpacecraftsClient 

func (c *ClientFactory) NewSpacecraftsClient() *SpacecraftsClient

NewSpacecraftsClient creates a new instance of SpacecraftsClient.

type Contact 

type Contact struct {
	// REQUIRED; Properties of the Contact Resource.
	Properties *ContactsProperties

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Contact - Customer creates a contact resource for a spacecraft resource.

func (Contact) MarshalJSON 

func (c Contact) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Contact.

func (*Contact) UnmarshalJSON 

func (c *Contact) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Contact.

type ContactInstanceProperties 

type ContactInstanceProperties struct {
	// READ-ONLY; Azimuth of the antenna at the end of the contact in decimal degrees.
	EndAzimuthDegrees *float32

	// READ-ONLY; Spacecraft elevation above the horizon at contact end.
	EndElevationDegrees *float32

	// READ-ONLY; Maximum elevation of the antenna during the contact in decimal degrees.
	MaximumElevationDegrees *float32

	// READ-ONLY; Time to lost receiving a signal (ISO 8601 UTC standard).
	RxEndTime *time.Time

	// READ-ONLY; Earliest time to receive a signal (ISO 8601 UTC standard).
	RxStartTime *time.Time

	// READ-ONLY; Azimuth of the antenna at the start of the contact in decimal degrees.
	StartAzimuthDegrees *float32

	// READ-ONLY; Spacecraft elevation above the horizon at contact start.
	StartElevationDegrees *float32

	// READ-ONLY; Time at which antenna transmit will be disabled (ISO 8601 UTC standard).
	TxEndTime *time.Time

	// READ-ONLY; Time at which antenna transmit will be enabled (ISO 8601 UTC standard).
	TxStartTime *time.Time
}

ContactInstanceProperties - Contact Instance Properties.

func (ContactInstanceProperties) MarshalJSON 

func (c ContactInstanceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactInstanceProperties.

func (*ContactInstanceProperties) UnmarshalJSON 

func (c *ContactInstanceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactInstanceProperties.

type ContactListResult 

type ContactListResult struct {
	// A list of contact resources in a resource group.
	Value []*Contact

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

ContactListResult - Response for the ListContacts API service call.

func (ContactListResult) MarshalJSON 

func (c ContactListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactListResult.

func (*ContactListResult) UnmarshalJSON 

func (c *ContactListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactListResult.

type ContactParameters 

type ContactParameters struct {
	// REQUIRED; The reference to the contact profile resource.
	ContactProfile *ContactParametersContactProfile

	// REQUIRED; End time of a contact (ISO 8601 UTC standard).
	EndTime *time.Time

	// REQUIRED; Name of Azure Ground Station.
	GroundStationName *string

	// REQUIRED; Start time of a contact (ISO 8601 UTC standard).
	StartTime *time.Time
}

ContactParameters - Parameters that define the contact resource.

func (ContactParameters) MarshalJSON 

func (c ContactParameters) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactParameters.

func (*ContactParameters) UnmarshalJSON 

func (c *ContactParameters) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactParameters.

type ContactParametersContactProfile 

type ContactParametersContactProfile struct {
	// REQUIRED; Resource ID.
	ID *string
}

ContactParametersContactProfile - The reference to the contact profile resource.

func (ContactParametersContactProfile) MarshalJSON 

func (c ContactParametersContactProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactParametersContactProfile.

func (*ContactParametersContactProfile) UnmarshalJSON 

func (c *ContactParametersContactProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactParametersContactProfile.

type ContactProfile 

type ContactProfile struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; Properties of the contact profile resource.
	Properties *ContactProfileProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ContactProfile - Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact.

func (ContactProfile) MarshalJSON 

func (c ContactProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactProfile.

func (*ContactProfile) UnmarshalJSON 

func (c *ContactProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactProfile. 

type ContactProfileLink struct {
	// REQUIRED; Contact Profile Link Channel.
	Channels []*ContactProfileLinkChannel

	// REQUIRED; Direction (Uplink or Downlink).
	Direction *Direction

	// REQUIRED; Link name.
	Name *string

	// REQUIRED; Polarization. e.g. (RHCP, LHCP).
	Polarization *Polarization

	// Effective Isotropic Radiated Power (EIRP) in dBW. It is the required EIRP by the customer. Not used yet.
	EirpdBW *float32

	// Gain to noise temperature in db/K. It is the required G/T by the customer. Not used yet.
	GainOverTemperature *float32
}

ContactProfileLink - Contact Profile Link.

func (ContactProfileLink) MarshalJSON 

func (c ContactProfileLink) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactProfileLink.

func (*ContactProfileLink) UnmarshalJSON 

func (c *ContactProfileLink) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactProfileLink.

type ContactProfileLinkChannel 

type ContactProfileLinkChannel struct {
	// REQUIRED; Bandwidth in MHz.
	BandwidthMHz *float32

	// REQUIRED; Center Frequency in MHz.
	CenterFrequencyMHz *float32

	// REQUIRED; Customer end point to store and retrieve data during a contact with the spacecraft.
	EndPoint *EndPoint

	// REQUIRED; Channel name.
	Name *string

	// Currently unused.
	DecodingConfiguration *string

	// Copy of the modem configuration file such as Kratos QRadio or Kratos QuantumRx. Only valid for downlink directions. If
	// provided, the modem connects to the customer endpoint and sends demodulated data
	// instead of a VITA.49 stream.
	DemodulationConfiguration *string

	// Currently unused.
	EncodingConfiguration *string

	// Copy of the modem configuration file such as Kratos QRadio. Only valid for uplink directions. If provided, the modem connects
	// to the customer endpoint and accepts commands from the customer instead of
	// a VITA.49 stream.
	ModulationConfiguration *string
}

ContactProfileLinkChannel - Contact Profile Link Channel.

func (ContactProfileLinkChannel) MarshalJSON 

func (c ContactProfileLinkChannel) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactProfileLinkChannel.

func (*ContactProfileLinkChannel) UnmarshalJSON 

func (c *ContactProfileLinkChannel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactProfileLinkChannel.

type ContactProfileListResult 

type ContactProfileListResult struct {
	// A list of contact profile resources in a resource group.
	Value []*ContactProfile

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

ContactProfileListResult - Response for the ListContactProfiles API service call.

func (ContactProfileListResult) MarshalJSON 

func (c ContactProfileListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactProfileListResult.

func (*ContactProfileListResult) UnmarshalJSON 

func (c *ContactProfileListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactProfileListResult.

type ContactProfileProperties 

type ContactProfileProperties struct {
	// REQUIRED; Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints.
	Links []*ContactProfileLink

	// REQUIRED; Network configuration of customer virtual network.
	NetworkConfiguration *ContactProfilesPropertiesNetworkConfiguration

	// Auto-tracking configuration.
	AutoTrackingConfiguration *AutoTrackingConfiguration

	// ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to
	// send telemetry into the hub.
	EventHubURI *string

	// Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft
	// at a given ground station.
	MinimumElevationDegrees *float32

	// Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given
	// ground station.
	MinimumViableContactDuration *string

	// The current state of the resource's creation, deletion, or modification.
	ProvisioningState *ContactProfilesPropertiesProvisioningState

	// Third-party mission configuration of the Contact Profile. Describes RF links, modem processing, and IP endpoints.
	ThirdPartyConfigurations []*ContactProfileThirdPartyConfiguration
}

ContactProfileProperties - Properties of the contact profile resource.

func (ContactProfileProperties) MarshalJSON 

func (c ContactProfileProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactProfileProperties.

func (*ContactProfileProperties) UnmarshalJSON 

func (c *ContactProfileProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactProfileProperties.

type ContactProfileThirdPartyConfiguration 

type ContactProfileThirdPartyConfiguration struct {
	// REQUIRED; Name of string referencing the configuration describing contact set-up for a particular mission. Expected values
	// are those which have been created in collaboration with the partner network.
	MissionConfiguration *string

	// REQUIRED; Name of the third-party provider.
	ProviderName *string
}

ContactProfileThirdPartyConfiguration - Contact Profile third-party partner configuration.

func (ContactProfileThirdPartyConfiguration) MarshalJSON 

func (c ContactProfileThirdPartyConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactProfileThirdPartyConfiguration.

func (*ContactProfileThirdPartyConfiguration) UnmarshalJSON 

func (c *ContactProfileThirdPartyConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactProfileThirdPartyConfiguration.

type ContactProfilesClient 

type ContactProfilesClient struct {
	// contains filtered or unexported fields
}

ContactProfilesClient contains the methods for the ContactProfiles group. Don't use this type directly, use NewContactProfilesClient() instead.

func NewContactProfilesClient 

func NewContactProfilesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ContactProfilesClient, error)

NewContactProfilesClient creates a new instance of ContactProfilesClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ContactProfilesClient) BeginCreateOrUpdate 

func (client *ContactProfilesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, contactProfileName string, parameters ContactProfile, options *ContactProfilesClientBeginCreateOrUpdateOptions) (*runtime.Poller[ContactProfilesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a contact profile. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • contactProfileName - Contact Profile name.
  • parameters - The parameters to provide for the created Contact Profile.
  • options - ContactProfilesClientBeginCreateOrUpdateOptions contains the optional parameters for the ContactProfilesClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileCreate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewContactProfilesClient().BeginCreateOrUpdate(ctx, "contoso-Rgp", "CONTOSO-CP", armorbital.ContactProfile{
	Location: to.Ptr("eastus2"),
	Properties: &armorbital.ContactProfileProperties{
		AutoTrackingConfiguration: to.Ptr(armorbital.AutoTrackingConfigurationDisabled),
		EventHubURI:               to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub"),
		Links: []*armorbital.ContactProfileLink{
			{
				Name: to.Ptr("contoso-uplink"),
				Channels: []*armorbital.ContactProfileLinkChannel{
					{
						Name:               to.Ptr("contoso-uplink-channel"),
						BandwidthMHz:       to.Ptr[float32](2),
						CenterFrequencyMHz: to.Ptr[float32](2250),
						EndPoint: &armorbital.EndPoint{
							EndPointName: to.Ptr("ContosoTest_Uplink"),
							IPAddress:    to.Ptr("10.1.0.4"),
							Port:         to.Ptr("50000"),
							Protocol:     to.Ptr(armorbital.ProtocolTCP),
						},
					}},
				Direction:           to.Ptr(armorbital.DirectionUplink),
				EirpdBW:             to.Ptr[float32](45),
				GainOverTemperature: to.Ptr[float32](0),
				Polarization:        to.Ptr(armorbital.PolarizationLHCP),
			},
			{
				Name: to.Ptr("contoso-downlink"),
				Channels: []*armorbital.ContactProfileLinkChannel{
					{
						Name:               to.Ptr("contoso-downlink-channel"),
						BandwidthMHz:       to.Ptr[float32](15),
						CenterFrequencyMHz: to.Ptr[float32](8160),
						EndPoint: &armorbital.EndPoint{
							EndPointName: to.Ptr("ContosoTest_Downlink"),
							IPAddress:    to.Ptr("10.1.0.5"),
							Port:         to.Ptr("50001"),
							Protocol:     to.Ptr(armorbital.ProtocolUDP),
						},
					}},
				Direction:           to.Ptr(armorbital.DirectionDownlink),
				EirpdBW:             to.Ptr[float32](0),
				GainOverTemperature: to.Ptr[float32](25),
				Polarization:        to.Ptr(armorbital.PolarizationRHCP),
			}},
		MinimumElevationDegrees:      to.Ptr[float32](5),
		MinimumViableContactDuration: to.Ptr("PT1M"),
		NetworkConfiguration: &armorbital.ContactProfilesPropertiesNetworkConfiguration{
			SubnetID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"),
		},
		ThirdPartyConfigurations: []*armorbital.ContactProfileThirdPartyConfiguration{
			{
				MissionConfiguration: to.Ptr("Ksat_MissionConfiguration"),
				ProviderName:         to.Ptr("KSAT"),
			},
			{
				MissionConfiguration: to.Ptr("Viasat_Configuration"),
				ProviderName:         to.Ptr("VIASAT"),
			}},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ContactProfile = armorbital.ContactProfile{
// 	Name: to.Ptr("CONTOSO-CP"),
// 	Type: to.Ptr("Microsoft.Orbital/contactProfiles"),
// 	ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
// 	Location: to.Ptr("eastus2"),
// 	Properties: &armorbital.ContactProfileProperties{
// 		AutoTrackingConfiguration: to.Ptr(armorbital.AutoTrackingConfigurationDisabled),
// 		EventHubURI: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub"),
// 		Links: []*armorbital.ContactProfileLink{
// 			{
// 				Name: to.Ptr("contoso-uplink"),
// 				Channels: []*armorbital.ContactProfileLinkChannel{
// 					{
// 						Name: to.Ptr("contoso-uplink-channel"),
// 						BandwidthMHz: to.Ptr[float32](2),
// 						CenterFrequencyMHz: to.Ptr[float32](2250),
// 						EndPoint: &armorbital.EndPoint{
// 							EndPointName: to.Ptr("ContosoTest_Uplink"),
// 							IPAddress: to.Ptr("10.1.0.4"),
// 							Port: to.Ptr("50000"),
// 							Protocol: to.Ptr(armorbital.ProtocolTCP),
// 						},
// 				}},
// 				Direction: to.Ptr(armorbital.DirectionUplink),
// 				EirpdBW: to.Ptr[float32](45),
// 				GainOverTemperature: to.Ptr[float32](0),
// 				Polarization: to.Ptr(armorbital.PolarizationLHCP),
// 			},
// 			{
// 				Name: to.Ptr("contoso-downlink"),
// 				Channels: []*armorbital.ContactProfileLinkChannel{
// 					{
// 						Name: to.Ptr("contoso-downlink-channel"),
// 						BandwidthMHz: to.Ptr[float32](15),
// 						CenterFrequencyMHz: to.Ptr[float32](8160),
// 						EndPoint: &armorbital.EndPoint{
// 							EndPointName: to.Ptr("ContosoTest_Downlink"),
// 							IPAddress: to.Ptr("10.1.0.5"),
// 							Port: to.Ptr("50001"),
// 							Protocol: to.Ptr(armorbital.ProtocolUDP),
// 						},
// 				}},
// 				Direction: to.Ptr(armorbital.DirectionDownlink),
// 				EirpdBW: to.Ptr[float32](0),
// 				GainOverTemperature: to.Ptr[float32](25),
// 				Polarization: to.Ptr(armorbital.PolarizationRHCP),
// 		}},
// 		MinimumElevationDegrees: to.Ptr[float32](5),
// 		MinimumViableContactDuration: to.Ptr("PT1M"),
// 		NetworkConfiguration: &armorbital.ContactProfilesPropertiesNetworkConfiguration{
// 			SubnetID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"),
// 		},
// 		ProvisioningState: to.Ptr(armorbital.ContactProfilesPropertiesProvisioningState("Succeeded")),
// 		ThirdPartyConfigurations: []*armorbital.ContactProfileThirdPartyConfiguration{
// 			{
// 				MissionConfiguration: to.Ptr("Ksat_MissionConfiguration"),
// 				ProviderName: to.Ptr("KSAT"),
// 			},
// 			{
// 				MissionConfiguration: to.Ptr("Viasat_Configuration"),
// 				ProviderName: to.Ptr("VIASAT"),
// 		}},
// 	},
// }

Output:

func (*ContactProfilesClient) BeginDelete 

func (client *ContactProfilesClient) BeginDelete(ctx context.Context, resourceGroupName string, contactProfileName string, options *ContactProfilesClientBeginDeleteOptions) (*runtime.Poller[ContactProfilesClientDeleteResponse], error)

BeginDelete - Deletes a specified contact profile resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • contactProfileName - Contact Profile name.
  • options - ContactProfilesClientBeginDeleteOptions contains the optional parameters for the ContactProfilesClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileDelete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewContactProfilesClient().BeginDelete(ctx, "contoso-Rgp", "CONTOSO-CP", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*ContactProfilesClient) BeginUpdateTags 

func (client *ContactProfilesClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, contactProfileName string, parameters TagsObject, options *ContactProfilesClientBeginUpdateTagsOptions) (*runtime.Poller[ContactProfilesClientUpdateTagsResponse], error)

BeginUpdateTags - Updates the specified contact profile tags. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • contactProfileName - Contact Profile name.
  • parameters - Parameters supplied to update contact profile tags.
  • options - ContactProfilesClientBeginUpdateTagsOptions contains the optional parameters for the ContactProfilesClient.BeginUpdateTags method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileUpdateTag.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewContactProfilesClient().BeginUpdateTags(ctx, "contoso-Rgp", "CONTOSO-CP", armorbital.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ContactProfile = armorbital.ContactProfile{
// 	Name: to.Ptr("CONTOSO-CP"),
// 	Type: to.Ptr("Microsoft.Orbital/contactProfiles"),
// 	ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
// 	Location: to.Ptr("eastus2"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armorbital.ContactProfileProperties{
// 		AutoTrackingConfiguration: to.Ptr(armorbital.AutoTrackingConfigurationDisabled),
// 		EventHubURI: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub"),
// 		Links: []*armorbital.ContactProfileLink{
// 			{
// 				Name: to.Ptr("contoso-uplink"),
// 				Channels: []*armorbital.ContactProfileLinkChannel{
// 					{
// 						Name: to.Ptr("contoso-uplink-channel"),
// 						BandwidthMHz: to.Ptr[float32](2),
// 						CenterFrequencyMHz: to.Ptr[float32](2250),
// 						EndPoint: &armorbital.EndPoint{
// 							EndPointName: to.Ptr("ContosoTest_Uplink"),
// 							IPAddress: to.Ptr("10.1.0.4"),
// 							Port: to.Ptr("50000"),
// 							Protocol: to.Ptr(armorbital.ProtocolTCP),
// 						},
// 				}},
// 				Direction: to.Ptr(armorbital.DirectionUplink),
// 				EirpdBW: to.Ptr[float32](45),
// 				GainOverTemperature: to.Ptr[float32](0),
// 				Polarization: to.Ptr(armorbital.PolarizationLHCP),
// 			},
// 			{
// 				Name: to.Ptr("contoso-downlink"),
// 				Channels: []*armorbital.ContactProfileLinkChannel{
// 					{
// 						Name: to.Ptr("contoso-downlink-channel"),
// 						BandwidthMHz: to.Ptr[float32](15),
// 						CenterFrequencyMHz: to.Ptr[float32](8160),
// 						EndPoint: &armorbital.EndPoint{
// 							EndPointName: to.Ptr("ContosoTest_Downlink"),
// 							IPAddress: to.Ptr("10.1.0.5"),
// 							Port: to.Ptr("50001"),
// 							Protocol: to.Ptr(armorbital.ProtocolUDP),
// 						},
// 				}},
// 				Direction: to.Ptr(armorbital.DirectionDownlink),
// 				EirpdBW: to.Ptr[float32](0),
// 				GainOverTemperature: to.Ptr[float32](25),
// 				Polarization: to.Ptr(armorbital.PolarizationRHCP),
// 		}},
// 		MinimumElevationDegrees: to.Ptr[float32](5),
// 		MinimumViableContactDuration: to.Ptr("PT1M"),
// 		NetworkConfiguration: &armorbital.ContactProfilesPropertiesNetworkConfiguration{
// 			SubnetID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"),
// 		},
// 		ProvisioningState: to.Ptr(armorbital.ContactProfilesPropertiesProvisioningState("Succeeded")),
// 		ThirdPartyConfigurations: []*armorbital.ContactProfileThirdPartyConfiguration{
// 			{
// 				MissionConfiguration: to.Ptr("Ksat_MissionConfiguration"),
// 				ProviderName: to.Ptr("KSAT"),
// 			},
// 			{
// 				MissionConfiguration: to.Ptr("Viasat_Configuration"),
// 				ProviderName: to.Ptr("VIASAT"),
// 		}},
// 	},
// }

Output:

func (*ContactProfilesClient) Get 

func (client *ContactProfilesClient) Get(ctx context.Context, resourceGroupName string, contactProfileName string, options *ContactProfilesClientGetOptions) (ContactProfilesClientGetResponse, error)

Get - Gets the specified contact Profile in a specified resource group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • contactProfileName - Contact Profile name.
  • options - ContactProfilesClientGetOptions contains the optional parameters for the ContactProfilesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfileGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewContactProfilesClient().Get(ctx, "contoso-Rgp", "CONTOSO-CP", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.ContactProfile = armorbital.ContactProfile{
// 	Name: to.Ptr("CONTOSO-CP"),
// 	Type: to.Ptr("Microsoft.Orbital/contactProfiles"),
// 	ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
// 	Location: to.Ptr("eastus2"),
// 	Properties: &armorbital.ContactProfileProperties{
// 		AutoTrackingConfiguration: to.Ptr(armorbital.AutoTrackingConfigurationDisabled),
// 		EventHubURI: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub"),
// 		Links: []*armorbital.ContactProfileLink{
// 			{
// 				Name: to.Ptr("contoso-uplink"),
// 				Channels: []*armorbital.ContactProfileLinkChannel{
// 					{
// 						Name: to.Ptr("contoso-uplink-channel"),
// 						BandwidthMHz: to.Ptr[float32](2),
// 						CenterFrequencyMHz: to.Ptr[float32](2250),
// 						EndPoint: &armorbital.EndPoint{
// 							EndPointName: to.Ptr("ContosoTest_Uplink"),
// 							IPAddress: to.Ptr("10.1.0.4"),
// 							Port: to.Ptr("50000"),
// 							Protocol: to.Ptr(armorbital.ProtocolTCP),
// 						},
// 				}},
// 				Direction: to.Ptr(armorbital.DirectionUplink),
// 				EirpdBW: to.Ptr[float32](45),
// 				GainOverTemperature: to.Ptr[float32](0),
// 				Polarization: to.Ptr(armorbital.PolarizationLHCP),
// 			},
// 			{
// 				Name: to.Ptr("contoso-downlink"),
// 				Channels: []*armorbital.ContactProfileLinkChannel{
// 					{
// 						Name: to.Ptr("contoso-downlink-channel"),
// 						BandwidthMHz: to.Ptr[float32](15),
// 						CenterFrequencyMHz: to.Ptr[float32](8160),
// 						EndPoint: &armorbital.EndPoint{
// 							EndPointName: to.Ptr("ContosoTest_Downlink"),
// 							IPAddress: to.Ptr("10.1.0.5"),
// 							Port: to.Ptr("51103"),
// 							Protocol: to.Ptr(armorbital.ProtocolUDP),
// 						},
// 				}},
// 				Direction: to.Ptr(armorbital.DirectionDownlink),
// 				EirpdBW: to.Ptr[float32](0),
// 				GainOverTemperature: to.Ptr[float32](25),
// 				Polarization: to.Ptr(armorbital.PolarizationRHCP),
// 		}},
// 		MinimumElevationDegrees: to.Ptr[float32](5),
// 		MinimumViableContactDuration: to.Ptr("PT1M"),
// 		NetworkConfiguration: &armorbital.ContactProfilesPropertiesNetworkConfiguration{
// 			SubnetID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"),
// 		},
// 		ProvisioningState: to.Ptr(armorbital.ContactProfilesPropertiesProvisioningState("Succeeded")),
// 		ThirdPartyConfigurations: []*armorbital.ContactProfileThirdPartyConfiguration{
// 			{
// 				MissionConfiguration: to.Ptr("Ksat_MissionConfiguration"),
// 				ProviderName: to.Ptr("KSAT"),
// 			},
// 			{
// 				MissionConfiguration: to.Ptr("Viasat_Configuration"),
// 				ProviderName: to.Ptr("VIASAT"),
// 		}},
// 	},
// }

Output:

func (*ContactProfilesClient) NewListBySubscriptionPager 

func (client *ContactProfilesClient) NewListBySubscriptionPager(options *ContactProfilesClientListBySubscriptionOptions) *runtime.Pager[ContactProfilesClientListBySubscriptionResponse]

NewListBySubscriptionPager - Returns list of contact profiles by Subscription.

Generated from API version 2022-11-01

  • options - ContactProfilesClientListBySubscriptionOptions contains the optional parameters for the ContactProfilesClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfilesBySubscriptionList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewContactProfilesClient().NewListBySubscriptionPager(&armorbital.ContactProfilesClientListBySubscriptionOptions{Skiptoken: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ContactProfileListResult = armorbital.ContactProfileListResult{
	// 	Value: []*armorbital.ContactProfile{
	// 		{
	// 			Name: to.Ptr("CONTOSO-CP"),
	// 			Type: to.Ptr("Microsoft.Orbital/contactProfiles"),
	// 			ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
	// 			Location: to.Ptr("eastus2"),
	// 			Properties: &armorbital.ContactProfileProperties{
	// 				AutoTrackingConfiguration: to.Ptr(armorbital.AutoTrackingConfigurationDisabled),
	// 				EventHubURI: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub"),
	// 				Links: []*armorbital.ContactProfileLink{
	// 					{
	// 						Name: to.Ptr("contoso-uplink"),
	// 						Channels: []*armorbital.ContactProfileLinkChannel{
	// 							{
	// 								Name: to.Ptr("contoso-uplink-channel"),
	// 								BandwidthMHz: to.Ptr[float32](2),
	// 								CenterFrequencyMHz: to.Ptr[float32](2250),
	// 								EndPoint: &armorbital.EndPoint{
	// 									EndPointName: to.Ptr("ContosoTest_Uplink"),
	// 									IPAddress: to.Ptr("10.1.0.4"),
	// 									Port: to.Ptr("50000"),
	// 									Protocol: to.Ptr(armorbital.ProtocolTCP),
	// 								},
	// 						}},
	// 						Direction: to.Ptr(armorbital.DirectionUplink),
	// 						EirpdBW: to.Ptr[float32](45),
	// 						GainOverTemperature: to.Ptr[float32](0),
	// 						Polarization: to.Ptr(armorbital.PolarizationLHCP),
	// 					},
	// 					{
	// 						Name: to.Ptr("contoso-downlink"),
	// 						Channels: []*armorbital.ContactProfileLinkChannel{
	// 							{
	// 								Name: to.Ptr("contoso-downlink-channel"),
	// 								BandwidthMHz: to.Ptr[float32](15),
	// 								CenterFrequencyMHz: to.Ptr[float32](8160),
	// 								EndPoint: &armorbital.EndPoint{
	// 									EndPointName: to.Ptr("ContosoTest_Downlink"),
	// 									IPAddress: to.Ptr("10.1.0.5"),
	// 									Port: to.Ptr("50001"),
	// 									Protocol: to.Ptr(armorbital.ProtocolUDP),
	// 								},
	// 						}},
	// 						Direction: to.Ptr(armorbital.DirectionDownlink),
	// 						EirpdBW: to.Ptr[float32](0),
	// 						GainOverTemperature: to.Ptr[float32](25),
	// 						Polarization: to.Ptr(armorbital.PolarizationRHCP),
	// 				}},
	// 				MinimumElevationDegrees: to.Ptr[float32](5),
	// 				MinimumViableContactDuration: to.Ptr("PT1M"),
	// 				NetworkConfiguration: &armorbital.ContactProfilesPropertiesNetworkConfiguration{
	// 					SubnetID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"),
	// 				},
	// 				ProvisioningState: to.Ptr(armorbital.ContactProfilesPropertiesProvisioningState("Succeeded")),
	// 				ThirdPartyConfigurations: []*armorbital.ContactProfileThirdPartyConfiguration{
	// 					{
	// 						MissionConfiguration: to.Ptr("Ksat_MissionConfiguration"),
	// 						ProviderName: to.Ptr("KSAT"),
	// 					},
	// 					{
	// 						MissionConfiguration: to.Ptr("Viasat_Configuration"),
	// 						ProviderName: to.Ptr("VIASAT"),
	// 				}},
	// 			},
	// 	}},
	// }
}

Output:

func (*ContactProfilesClient) NewListPager 

func (client *ContactProfilesClient) NewListPager(resourceGroupName string, options *ContactProfilesClientListOptions) *runtime.Pager[ContactProfilesClientListResponse]

NewListPager - Returns list of contact profiles by Resource Group.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - ContactProfilesClientListOptions contains the optional parameters for the ContactProfilesClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactProfilesByResourceGroupList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewContactProfilesClient().NewListPager("contoso-Rgp", &armorbital.ContactProfilesClientListOptions{Skiptoken: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ContactProfileListResult = armorbital.ContactProfileListResult{
	// 	Value: []*armorbital.ContactProfile{
	// 		{
	// 			Name: to.Ptr("CONTOSO-CP"),
	// 			Type: to.Ptr("Microsoft.Orbital/contactProfiles"),
	// 			ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
	// 			Location: to.Ptr("eastus2"),
	// 			Properties: &armorbital.ContactProfileProperties{
	// 				AutoTrackingConfiguration: to.Ptr(armorbital.AutoTrackingConfigurationDisabled),
	// 				EventHubURI: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.EventHub/namespaces/contosoHub/eventhubs/contosoHub"),
	// 				Links: []*armorbital.ContactProfileLink{
	// 					{
	// 						Name: to.Ptr("contoso-uplink"),
	// 						Channels: []*armorbital.ContactProfileLinkChannel{
	// 							{
	// 								Name: to.Ptr("contoso-uplink-channel"),
	// 								BandwidthMHz: to.Ptr[float32](2),
	// 								CenterFrequencyMHz: to.Ptr[float32](2250),
	// 								EndPoint: &armorbital.EndPoint{
	// 									EndPointName: to.Ptr("ContosoTest_Uplink"),
	// 									IPAddress: to.Ptr("10.1.0.4"),
	// 									Port: to.Ptr("50000"),
	// 									Protocol: to.Ptr(armorbital.ProtocolTCP),
	// 								},
	// 						}},
	// 						Direction: to.Ptr(armorbital.DirectionUplink),
	// 						EirpdBW: to.Ptr[float32](45),
	// 						GainOverTemperature: to.Ptr[float32](0),
	// 						Polarization: to.Ptr(armorbital.PolarizationLHCP),
	// 					},
	// 					{
	// 						Name: to.Ptr("contoso-downlink"),
	// 						Channels: []*armorbital.ContactProfileLinkChannel{
	// 							{
	// 								Name: to.Ptr("contoso-downlink-channel"),
	// 								BandwidthMHz: to.Ptr[float32](15),
	// 								CenterFrequencyMHz: to.Ptr[float32](8160),
	// 								EndPoint: &armorbital.EndPoint{
	// 									EndPointName: to.Ptr("ContosoTest_Downlink"),
	// 									IPAddress: to.Ptr("10.1.0.5"),
	// 									Port: to.Ptr("50001"),
	// 									Protocol: to.Ptr(armorbital.ProtocolUDP),
	// 								},
	// 						}},
	// 						Direction: to.Ptr(armorbital.DirectionDownlink),
	// 						EirpdBW: to.Ptr[float32](0),
	// 						GainOverTemperature: to.Ptr[float32](25),
	// 						Polarization: to.Ptr(armorbital.PolarizationRHCP),
	// 				}},
	// 				MinimumElevationDegrees: to.Ptr[float32](5),
	// 				MinimumViableContactDuration: to.Ptr("PT1M"),
	// 				NetworkConfiguration: &armorbital.ContactProfilesPropertiesNetworkConfiguration{
	// 					SubnetID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Network/virtualNetworks/contoso-vnet/subnets/orbital-delegated-subnet"),
	// 				},
	// 				ProvisioningState: to.Ptr(armorbital.ContactProfilesPropertiesProvisioningState("Succeeded")),
	// 				ThirdPartyConfigurations: []*armorbital.ContactProfileThirdPartyConfiguration{
	// 					{
	// 						MissionConfiguration: to.Ptr("Ksat_MissionConfiguration"),
	// 						ProviderName: to.Ptr("KSAT"),
	// 					},
	// 					{
	// 						MissionConfiguration: to.Ptr("Viasat_Configuration"),
	// 						ProviderName: to.Ptr("VIASAT"),
	// 				}},
	// 			},
	// 	}},
	// }
}

Output:

type ContactProfilesClientBeginCreateOrUpdateOptions 

type ContactProfilesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContactProfilesClientBeginCreateOrUpdateOptions contains the optional parameters for the ContactProfilesClient.BeginCreateOrUpdate method.

type ContactProfilesClientBeginDeleteOptions 

type ContactProfilesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContactProfilesClientBeginDeleteOptions contains the optional parameters for the ContactProfilesClient.BeginDelete method.

type ContactProfilesClientBeginUpdateTagsOptions 

type ContactProfilesClientBeginUpdateTagsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContactProfilesClientBeginUpdateTagsOptions contains the optional parameters for the ContactProfilesClient.BeginUpdateTags method.

type ContactProfilesClientCreateOrUpdateResponse 

type ContactProfilesClientCreateOrUpdateResponse struct {
	// Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact.
	ContactProfile
}

ContactProfilesClientCreateOrUpdateResponse contains the response from method ContactProfilesClient.BeginCreateOrUpdate.

type ContactProfilesClientDeleteResponse 

type ContactProfilesClientDeleteResponse struct {
}

ContactProfilesClientDeleteResponse contains the response from method ContactProfilesClient.BeginDelete.

type ContactProfilesClientGetOptions 

type ContactProfilesClientGetOptions struct {
}

ContactProfilesClientGetOptions contains the optional parameters for the ContactProfilesClient.Get method.

type ContactProfilesClientGetResponse 

type ContactProfilesClientGetResponse struct {
	// Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact.
	ContactProfile
}

ContactProfilesClientGetResponse contains the response from method ContactProfilesClient.Get.

type ContactProfilesClientListBySubscriptionOptions 

type ContactProfilesClientListBySubscriptionOptions struct {
	// An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous
	// list operation call returned a partial result. If a previous response contains a
	// nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point
	// to use for subsequent calls.
	Skiptoken *string
}

ContactProfilesClientListBySubscriptionOptions contains the optional parameters for the ContactProfilesClient.NewListBySubscriptionPager method.

type ContactProfilesClientListBySubscriptionResponse 

type ContactProfilesClientListBySubscriptionResponse struct {
	// Response for the ListContactProfiles API service call.
	ContactProfileListResult
}

ContactProfilesClientListBySubscriptionResponse contains the response from method ContactProfilesClient.NewListBySubscriptionPager.

type ContactProfilesClientListOptions 

type ContactProfilesClientListOptions struct {
	// An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous
	// list operation call returned a partial result. If a previous response contains a
	// nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point
	// to use for subsequent calls.
	Skiptoken *string
}

ContactProfilesClientListOptions contains the optional parameters for the ContactProfilesClient.NewListPager method.

type ContactProfilesClientListResponse 

type ContactProfilesClientListResponse struct {
	// Response for the ListContactProfiles API service call.
	ContactProfileListResult
}

ContactProfilesClientListResponse contains the response from method ContactProfilesClient.NewListPager.

type ContactProfilesClientUpdateTagsResponse 

type ContactProfilesClientUpdateTagsResponse struct {
	// Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact.
	ContactProfile
}

ContactProfilesClientUpdateTagsResponse contains the response from method ContactProfilesClient.BeginUpdateTags.

type ContactProfilesProperties 

type ContactProfilesProperties struct {
	// REQUIRED; Links of the Contact Profile. Describes RF links, modem processing, and IP endpoints.
	Links []*ContactProfileLink

	// REQUIRED; Network configuration of customer virtual network.
	NetworkConfiguration *ContactProfilesPropertiesNetworkConfiguration

	// Auto-tracking configuration.
	AutoTrackingConfiguration *AutoTrackingConfiguration

	// ARM resource identifier of the Event Hub used for telemetry. Requires granting Orbital Resource Provider the rights to
	// send telemetry into the hub.
	EventHubURI *string

	// Minimum viable elevation for the contact in decimal degrees. Used for listing the available contacts with a spacecraft
	// at a given ground station.
	MinimumElevationDegrees *float32

	// Minimum viable contact duration in ISO 8601 format. Used for listing the available contacts with a spacecraft at a given
	// ground station.
	MinimumViableContactDuration *string

	// The current state of the resource's creation, deletion, or modification.
	ProvisioningState *ContactProfilesPropertiesProvisioningState

	// Third-party mission configuration of the Contact Profile. Describes RF links, modem processing, and IP endpoints.
	ThirdPartyConfigurations []*ContactProfileThirdPartyConfiguration
}

ContactProfilesProperties - List of Contact Profile Resource Properties.

func (ContactProfilesProperties) MarshalJSON 

func (c ContactProfilesProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactProfilesProperties.

func (*ContactProfilesProperties) UnmarshalJSON 

func (c *ContactProfilesProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactProfilesProperties.

type ContactProfilesPropertiesNetworkConfiguration 

type ContactProfilesPropertiesNetworkConfiguration struct {
	// REQUIRED; ARM resource identifier of the subnet delegated to the Microsoft.Orbital/orbitalGateways. Needs to be at least
	// a class C subnet, and should not have any IP created in it.
	SubnetID *string
}

ContactProfilesPropertiesNetworkConfiguration - Network configuration of customer virtual network.

func (ContactProfilesPropertiesNetworkConfiguration) MarshalJSON 

func (c ContactProfilesPropertiesNetworkConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactProfilesPropertiesNetworkConfiguration.

func (*ContactProfilesPropertiesNetworkConfiguration) UnmarshalJSON 

func (c *ContactProfilesPropertiesNetworkConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactProfilesPropertiesNetworkConfiguration.

type ContactProfilesPropertiesProvisioningState 

type ContactProfilesPropertiesProvisioningState string

ContactProfilesPropertiesProvisioningState - The current state of the resource's creation, deletion, or modification. 

const (
	ContactProfilesPropertiesProvisioningStateCanceled  ContactProfilesPropertiesProvisioningState = "canceled"
	ContactProfilesPropertiesProvisioningStateCreating  ContactProfilesPropertiesProvisioningState = "creating"
	ContactProfilesPropertiesProvisioningStateDeleting  ContactProfilesPropertiesProvisioningState = "deleting"
	ContactProfilesPropertiesProvisioningStateFailed    ContactProfilesPropertiesProvisioningState = "failed"
	ContactProfilesPropertiesProvisioningStateSucceeded ContactProfilesPropertiesProvisioningState = "succeeded"
	ContactProfilesPropertiesProvisioningStateUpdating  ContactProfilesPropertiesProvisioningState = "updating"
)

func PossibleContactProfilesPropertiesProvisioningStateValues 

func PossibleContactProfilesPropertiesProvisioningStateValues() []ContactProfilesPropertiesProvisioningState

PossibleContactProfilesPropertiesProvisioningStateValues returns the possible values for the ContactProfilesPropertiesProvisioningState const type.

type ContactsClient 

type ContactsClient struct {
	// contains filtered or unexported fields
}

ContactsClient contains the methods for the Contacts group. Don't use this type directly, use NewContactsClient() instead.

func NewContactsClient 

func NewContactsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ContactsClient, error)

NewContactsClient creates a new instance of ContactsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ContactsClient) BeginCreate 

func (client *ContactsClient) BeginCreate(ctx context.Context, resourceGroupName string, spacecraftName string, contactName string, parameters Contact, options *ContactsClientBeginCreateOptions) (*runtime.Poller[ContactsClientCreateResponse], error)

BeginCreate - Creates a contact. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • spacecraftName - Spacecraft ID.
  • contactName - Contact name.
  • parameters - The parameters to provide for the created contact.
  • options - ContactsClientBeginCreateOptions contains the optional parameters for the ContactsClient.BeginCreate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactCreate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewContactsClient().BeginCreate(ctx, "contoso-Rgp", "CONTOSO_SAT", "contact1", armorbital.Contact{
	Properties: &armorbital.ContactsProperties{
		ContactProfile: &armorbital.ContactsPropertiesContactProfile{
			ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
		},
		GroundStationName:    to.Ptr("EASTUS2_0"),
		ReservationEndTime:   to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T11:10:45.000Z"); return t }()),
		ReservationStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T10:58:30.000Z"); return t }()),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Contact = armorbital.Contact{
// 	Name: to.Ptr("contact1"),
// 	Type: to.Ptr("Microsoft.Orbital/spacecrafts/contacts"),
// 	ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1"),
// 	Properties: &armorbital.ContactsProperties{
// 		ContactProfile: &armorbital.ContactsPropertiesContactProfile{
// 			ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
// 		},
// 		EndAzimuthDegrees: to.Ptr[float32](345.848482),
// 		EndElevationDegrees: to.Ptr[float32](5.048656),
// 		GroundStationName: to.Ptr("EASTUS2_0"),
// 		MaximumElevationDegrees: to.Ptr[float32](85.9796),
// 		ReservationEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T11:10:45.000Z"); return t}()),
// 		ReservationStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T10:58:30.000Z"); return t}()),
// 		RxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T11:10:45.000Z"); return t}()),
// 		RxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T10:58:30.000Z"); return t}()),
// 		StartAzimuthDegrees: to.Ptr[float32](165.758896),
// 		StartElevationDegrees: to.Ptr[float32](5),
// 		Status: to.Ptr(armorbital.ContactsStatusScheduled),
// 		TxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T11:10:45.000Z"); return t}()),
// 		TxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-22T10:58:30.000Z"); return t}()),
// 	},
// }

Output:

func (*ContactsClient) BeginDelete 

func (client *ContactsClient) BeginDelete(ctx context.Context, resourceGroupName string, spacecraftName string, contactName string, options *ContactsClientBeginDeleteOptions) (*runtime.Poller[ContactsClientDeleteResponse], error)

BeginDelete - Deletes a specified contact. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • spacecraftName - Spacecraft ID.
  • contactName - Contact name.
  • options - ContactsClientBeginDeleteOptions contains the optional parameters for the ContactsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactDelete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewContactsClient().BeginDelete(ctx, "contoso-Rgp", "CONTOSO_SAT", "contact1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*ContactsClient) Get 

func (client *ContactsClient) Get(ctx context.Context, resourceGroupName string, spacecraftName string, contactName string, options *ContactsClientGetOptions) (ContactsClientGetResponse, error)

Get - Gets the specified contact in a specified resource group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • spacecraftName - Spacecraft ID.
  • contactName - Contact name.
  • options - ContactsClientGetOptions contains the optional parameters for the ContactsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewContactsClient().Get(ctx, "contoso-Rgp", "CONTOSO_SAT", "contact1", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Contact = armorbital.Contact{
// 	Name: to.Ptr("contact1"),
// 	Type: to.Ptr("Microsoft.Orbital/spacecrafts/contacts"),
// 	ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1"),
// 	Properties: &armorbital.ContactsProperties{
// 		AntennaConfiguration: &armorbital.ContactsPropertiesAntennaConfiguration{
// 			DestinationIP: to.Ptr("10.1.1.171"),
// 			SourceIPs: []*string{
// 				to.Ptr("10.1.1.4"),
// 				to.Ptr("10.1.1.5")},
// 			},
// 			ContactProfile: &armorbital.ContactsPropertiesContactProfile{
// 				ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
// 			},
// 			EndAzimuthDegrees: to.Ptr[float32](345.848482),
// 			EndElevationDegrees: to.Ptr[float32](5.048656),
// 			GroundStationName: to.Ptr("EASTUS2_0"),
// 			MaximumElevationDegrees: to.Ptr[float32](85.9796),
// 			ProvisioningState: to.Ptr(armorbital.ContactsPropertiesProvisioningState("Succeeded")),
// 			ReservationEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T11:10:45.000Z"); return t}()),
// 			ReservationStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T10:58:30.000Z"); return t}()),
// 			RxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T11:10:45.000Z"); return t}()),
// 			RxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T10:58:30.000Z"); return t}()),
// 			StartAzimuthDegrees: to.Ptr[float32](165.758896),
// 			StartElevationDegrees: to.Ptr[float32](5),
// 			Status: to.Ptr(armorbital.ContactsStatusScheduled),
// 			TxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T11:10:45.000Z"); return t}()),
// 			TxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T10:58:30.000Z"); return t}()),
// 		},
// 	}

Output:

func (*ContactsClient) NewListPager 

func (client *ContactsClient) NewListPager(resourceGroupName string, spacecraftName string, options *ContactsClientListOptions) *runtime.Pager[ContactsClientListResponse]

NewListPager - Returns list of contacts by spacecraftName.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • spacecraftName - Spacecraft ID.
  • options - ContactsClientListOptions contains the optional parameters for the ContactsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/ContactsBySpacecraftNameList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewContactsClient().NewListPager("contoso-Rgp", "CONTOSO_SAT", &armorbital.ContactsClientListOptions{Skiptoken: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.ContactListResult = armorbital.ContactListResult{
	// 	Value: []*armorbital.Contact{
	// 		{
	// 			Name: to.Ptr("contact1"),
	// 			Type: to.Ptr("Microsoft.Orbital/spacecrafts/contacts"),
	// 			ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact2"),
	// 			Properties: &armorbital.ContactsProperties{
	// 				AntennaConfiguration: &armorbital.ContactsPropertiesAntennaConfiguration{
	// 					DestinationIP: to.Ptr("10.1.1.171"),
	// 					SourceIPs: []*string{
	// 						to.Ptr("10.1.1.4"),
	// 						to.Ptr("10.1.1.5")},
	// 					},
	// 					ContactProfile: &armorbital.ContactsPropertiesContactProfile{
	// 						ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
	// 					},
	// 					EndAzimuthDegrees: to.Ptr[float32](330.489627),
	// 					EndElevationDegrees: to.Ptr[float32](5.040625),
	// 					GroundStationName: to.Ptr("EASTUS2_0"),
	// 					MaximumElevationDegrees: to.Ptr[float32](26.617297),
	// 					ProvisioningState: to.Ptr(armorbital.ContactsPropertiesProvisioningState("Succeeded")),
	// 					ReservationEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-01T12:05:25.000Z"); return t}()),
	// 					ReservationStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-01T11:55:01.000Z"); return t}()),
	// 					RxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-01T12:05:25.000Z"); return t}()),
	// 					RxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-01T11:55:01.000Z"); return t}()),
	// 					StartAzimuthDegrees: to.Ptr[float32](201.340472),
	// 					StartElevationDegrees: to.Ptr[float32](5),
	// 					Status: to.Ptr(armorbital.ContactsStatusSucceeded),
	// 					TxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-01T12:05:25.000Z"); return t}()),
	// 					TxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-01T11:55:01.000Z"); return t}()),
	// 				},
	// 			},
	// 			{
	// 				Name: to.Ptr("contact2"),
	// 				Type: to.Ptr("Microsoft.Orbital/spacecrafts/contacts"),
	// 				ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT/contacts/contact1"),
	// 				Properties: &armorbital.ContactsProperties{
	// 					AntennaConfiguration: &armorbital.ContactsPropertiesAntennaConfiguration{
	// 						DestinationIP: to.Ptr("10.1.1.171"),
	// 						SourceIPs: []*string{
	// 							to.Ptr("10.1.1.4"),
	// 							to.Ptr("10.1.1.5")},
	// 						},
	// 						ContactProfile: &armorbital.ContactsPropertiesContactProfile{
	// 							ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
	// 						},
	// 						EndAzimuthDegrees: to.Ptr[float32](345.848482),
	// 						EndElevationDegrees: to.Ptr[float32](5.048656),
	// 						GroundStationName: to.Ptr("EASTUS2_0"),
	// 						MaximumElevationDegrees: to.Ptr[float32](85.9796),
	// 						ProvisioningState: to.Ptr(armorbital.ContactsPropertiesProvisioningState("Succeeded")),
	// 						ReservationEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T11:10:45.000Z"); return t}()),
	// 						ReservationStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T10:58:30.000Z"); return t}()),
	// 						RxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T11:10:45.000Z"); return t}()),
	// 						RxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T10:58:30.000Z"); return t}()),
	// 						StartAzimuthDegrees: to.Ptr[float32](165.758896),
	// 						StartElevationDegrees: to.Ptr[float32](5),
	// 						Status: to.Ptr(armorbital.ContactsStatusSucceeded),
	// 						TxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T11:10:45.000Z"); return t}()),
	// 						TxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-03-02T10:58:30.000Z"); return t}()),
	// 					},
	// 			}},
	// 		}
}

Output:

type ContactsClientBeginCreateOptions 

type ContactsClientBeginCreateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContactsClientBeginCreateOptions contains the optional parameters for the ContactsClient.BeginCreate method.

type ContactsClientBeginDeleteOptions 

type ContactsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ContactsClientBeginDeleteOptions contains the optional parameters for the ContactsClient.BeginDelete method.

type ContactsClientCreateResponse 

type ContactsClientCreateResponse struct {
	// Customer creates a contact resource for a spacecraft resource.
	Contact
}

ContactsClientCreateResponse contains the response from method ContactsClient.BeginCreate.

type ContactsClientDeleteResponse 

type ContactsClientDeleteResponse struct {
}

ContactsClientDeleteResponse contains the response from method ContactsClient.BeginDelete.

type ContactsClientGetOptions 

type ContactsClientGetOptions struct {
}

ContactsClientGetOptions contains the optional parameters for the ContactsClient.Get method.

type ContactsClientGetResponse 

type ContactsClientGetResponse struct {
	// Customer creates a contact resource for a spacecraft resource.
	Contact
}

ContactsClientGetResponse contains the response from method ContactsClient.Get.

type ContactsClientListOptions 

type ContactsClientListOptions struct {
	// An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous
	// list operation call returned a partial result. If a previous response contains a
	// nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point
	// to use for subsequent calls.
	Skiptoken *string
}

ContactsClientListOptions contains the optional parameters for the ContactsClient.NewListPager method.

type ContactsClientListResponse 

type ContactsClientListResponse struct {
	// Response for the ListContacts API service call.
	ContactListResult
}

ContactsClientListResponse contains the response from method ContactsClient.NewListPager.

type ContactsProperties 

type ContactsProperties struct {
	// REQUIRED; The reference to the contact profile resource.
	ContactProfile *ContactsPropertiesContactProfile

	// REQUIRED; Azure Ground Station name.
	GroundStationName *string

	// REQUIRED; Reservation end time of a contact (ISO 8601 UTC standard).
	ReservationEndTime *time.Time

	// REQUIRED; Reservation start time of a contact (ISO 8601 UTC standard).
	ReservationStartTime *time.Time

	// The current state of the resource's creation, deletion, or modification.
	ProvisioningState *ContactsPropertiesProvisioningState

	// READ-ONLY; The configuration associated with the allocated antenna.
	AntennaConfiguration *ContactsPropertiesAntennaConfiguration

	// READ-ONLY; Azimuth of the antenna at the end of the contact in decimal degrees.
	EndAzimuthDegrees *float32

	// READ-ONLY; Spacecraft elevation above the horizon at contact end.
	EndElevationDegrees *float32

	// READ-ONLY; Any error message while scheduling a contact.
	ErrorMessage *string

	// READ-ONLY; Maximum elevation of the antenna during the contact in decimal degrees.
	MaximumElevationDegrees *float32

	// READ-ONLY; Receive end time of a contact (ISO 8601 UTC standard).
	RxEndTime *time.Time

	// READ-ONLY; Receive start time of a contact (ISO 8601 UTC standard).
	RxStartTime *time.Time

	// READ-ONLY; Azimuth of the antenna at the start of the contact in decimal degrees.
	StartAzimuthDegrees *float32

	// READ-ONLY; Spacecraft elevation above the horizon at contact start.
	StartElevationDegrees *float32

	// READ-ONLY; Status of a contact.
	Status *ContactsStatus

	// READ-ONLY; Transmit end time of a contact (ISO 8601 UTC standard).
	TxEndTime *time.Time

	// READ-ONLY; Transmit start time of a contact (ISO 8601 UTC standard).
	TxStartTime *time.Time
}

ContactsProperties - Properties of the Contact Resource.

func (ContactsProperties) MarshalJSON 

func (c ContactsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactsProperties.

func (*ContactsProperties) UnmarshalJSON 

func (c *ContactsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactsProperties.

type ContactsPropertiesAntennaConfiguration 

type ContactsPropertiesAntennaConfiguration struct {
	// The destination IP a packet can be sent to. This would for example be the TCP endpoint you would send data to.
	DestinationIP *string

	// List of Source IP
	SourceIPs []*string
}

ContactsPropertiesAntennaConfiguration - The configuration associated with the allocated antenna.

func (ContactsPropertiesAntennaConfiguration) MarshalJSON 

func (c ContactsPropertiesAntennaConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactsPropertiesAntennaConfiguration.

func (*ContactsPropertiesAntennaConfiguration) UnmarshalJSON 

func (c *ContactsPropertiesAntennaConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactsPropertiesAntennaConfiguration.

type ContactsPropertiesContactProfile 

type ContactsPropertiesContactProfile struct {
	// REQUIRED; Resource ID.
	ID *string
}

ContactsPropertiesContactProfile - The reference to the contact profile resource.

func (ContactsPropertiesContactProfile) MarshalJSON 

func (c ContactsPropertiesContactProfile) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContactsPropertiesContactProfile.

func (*ContactsPropertiesContactProfile) UnmarshalJSON 

func (c *ContactsPropertiesContactProfile) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContactsPropertiesContactProfile.

type ContactsPropertiesProvisioningState 

type ContactsPropertiesProvisioningState string

ContactsPropertiesProvisioningState - The current state of the resource's creation, deletion, or modification. 

const (
	ContactsPropertiesProvisioningStateCanceled  ContactsPropertiesProvisioningState = "canceled"
	ContactsPropertiesProvisioningStateCreating  ContactsPropertiesProvisioningState = "creating"
	ContactsPropertiesProvisioningStateDeleting  ContactsPropertiesProvisioningState = "deleting"
	ContactsPropertiesProvisioningStateFailed    ContactsPropertiesProvisioningState = "failed"
	ContactsPropertiesProvisioningStateSucceeded ContactsPropertiesProvisioningState = "succeeded"
	ContactsPropertiesProvisioningStateUpdating  ContactsPropertiesProvisioningState = "updating"
)

func PossibleContactsPropertiesProvisioningStateValues 

func PossibleContactsPropertiesProvisioningStateValues() []ContactsPropertiesProvisioningState

PossibleContactsPropertiesProvisioningStateValues returns the possible values for the ContactsPropertiesProvisioningState const type.

type ContactsStatus 

type ContactsStatus string

ContactsStatus - Status of a contact. 

const (
	ContactsStatusCancelled         ContactsStatus = "cancelled"
	ContactsStatusFailed            ContactsStatus = "failed"
	ContactsStatusProviderCancelled ContactsStatus = "providerCancelled"
	ContactsStatusScheduled         ContactsStatus = "scheduled"
	ContactsStatusSucceeded         ContactsStatus = "succeeded"
)

func PossibleContactsStatusValues 

func PossibleContactsStatusValues() []ContactsStatus

PossibleContactsStatusValues returns the possible values for the ContactsStatus const type.

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type Direction 

type Direction string

Direction - Direction (Uplink or Downlink). 

const (
	DirectionDownlink Direction = "Downlink"
	DirectionUplink   Direction = "Uplink"
)

func PossibleDirectionValues 

func PossibleDirectionValues() []Direction

PossibleDirectionValues returns the possible values for the Direction const type.

type EndPoint 

type EndPoint struct {
	// REQUIRED; Name of an end point.
	EndPointName *string

	// REQUIRED; IP Address (IPv4).
	IPAddress *string

	// REQUIRED; TCP port to listen on to receive data.
	Port *string

	// REQUIRED; Protocol either UDP or TCP.
	Protocol *Protocol
}

EndPoint - Customer end point to store and retrieve data during a contact with the spacecraft.

func (EndPoint) MarshalJSON 

func (e EndPoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EndPoint.

func (*EndPoint) UnmarshalJSON 

func (e *EndPoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EndPoint.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info any

	// READ-ONLY; The additional info type.
	Type *string
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON 

func (e ErrorAdditionalInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON 

func (e *ErrorAdditionalInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorDetail 

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error details.
	Details []*ErrorDetail

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error target.
	Target *string
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON 

func (e ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON 

func (e *ErrorDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

func (ErrorResponse) MarshalJSON 

func (e ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON 

func (e *ErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type Operation 

type Operation struct {
	// Localized display information for this particular operation.
	Display *OperationDisplay

	// READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
	ActionType *ActionType

	// READ-ONLY; Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane
	// operations.
	IsDataAction *bool

	// READ-ONLY; The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write",
	// "Microsoft.Compute/virtualMachines/capture/action"
	Name *string

	// READ-ONLY; The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default
	// value is "user,system"
	Origin *Origin
}

Operation - Details of a REST API operation, returned from the Resource Provider Operations API

func (Operation) MarshalJSON 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON 

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationDisplay 

type OperationDisplay struct {
	// READ-ONLY; The short, localized friendly description of the operation; suitable for tool tips and detailed views.
	Description *string

	// READ-ONLY; The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual
	// Machine", "Restart Virtual Machine".
	Operation *string

	// READ-ONLY; The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft
	// Compute".
	Provider *string

	// READ-ONLY; The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job
	// Schedule Collections".
	Resource *string
}

OperationDisplay - Localized display information for this particular operation.

func (OperationDisplay) MarshalJSON 

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON 

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationListResult 

type OperationListResult struct {
	// READ-ONLY; URL to get the next set of operation list results (if there are any).
	NextLink *string

	// READ-ONLY; List of operations supported by the resource provider
	Value []*Operation
}

OperationListResult - A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

func (OperationListResult) MarshalJSON 

func (o OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

func (*OperationListResult) UnmarshalJSON 

func (o *OperationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.

type OperationResult 

type OperationResult struct {
	// Operation result error properties.
	Error *OperationResultErrorProperties

	// Operation result properties.
	Properties any

	// READ-ONLY; The operation end time (ISO 8601 UTC standard).
	EndTime *time.Time

	// READ-ONLY; ID of the resource.
	ID *string

	// READ-ONLY; Name of the resource.
	Name *string

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string

	// READ-ONLY; Percentage completed.
	PercentComplete *float64

	// READ-ONLY; The operation start time (ISO 8601 UTC standard).
	StartTime *time.Time

	// READ-ONLY; The status of operation.
	Status *Status

	// READ-ONLY; A list of results when the operation returns multiple results.
	Value []any
}

OperationResult - Operation Result Entity.

func (OperationResult) MarshalJSON 

func (o OperationResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationResult.

func (*OperationResult) UnmarshalJSON 

func (o *OperationResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationResult.

type OperationResultErrorProperties 

type OperationResultErrorProperties struct {
	// READ-ONLY; The code of the error.
	Code *string

	// READ-ONLY; The error message.
	Message *string
}

OperationResultErrorProperties - Operation result error properties.

func (OperationResultErrorProperties) MarshalJSON 

func (o OperationResultErrorProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationResultErrorProperties.

func (*OperationResultErrorProperties) UnmarshalJSON 

func (o *OperationResultErrorProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationResultErrorProperties.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsClient) NewListPager 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Lists all of the available Orbital Rest API operations.

Generated from API version 2022-11-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/OperationsList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOperationsClient().NewListPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.OperationListResult = armorbital.OperationListResult{
	// 	Value: []*armorbital.Operation{
	// 		{
	// 			Name: to.Ptr("Microsoft.Orbital/spacecrafts/write"),
	// 			Display: &armorbital.OperationDisplay{
	// 				Description: to.Ptr("Creates or Update a spacecraft."),
	// 				Operation: to.Ptr("Create/Update a spacecraft"),
	// 				Provider: to.Ptr("Microsoft Orbital"),
	// 				Resource: to.Ptr("Spacecraft"),
	// 			},
	// 	}},
	// }
}

Output:

type OperationsClientListOptions 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse 

type OperationsClientListResponse struct {
	// A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type OperationsResultsClient 

type OperationsResultsClient struct {
	// contains filtered or unexported fields
}

OperationsResultsClient contains the methods for the OperationsResults group. Don't use this type directly, use NewOperationsResultsClient() instead.

func NewOperationsResultsClient 

func NewOperationsResultsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsResultsClient, error)

NewOperationsResultsClient creates a new instance of OperationsResultsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsResultsClient) BeginGet 

func (client *OperationsResultsClient) BeginGet(ctx context.Context, location string, operationID string, options *OperationsResultsClientBeginGetOptions) (*runtime.Poller[OperationsResultsClientGetResponse], error)

BeginGet - Returns operation results. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-11-01

  • location - The name of Azure region.
  • operationID - The ID of an ongoing async operation.
  • options - OperationsResultsClientBeginGetOptions contains the optional parameters for the OperationsResultsClient.BeginGet method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/OperationResultsGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewOperationsResultsClient().BeginGet(ctx, "eastus2", "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.OperationResult = armorbital.OperationResult{
// 	Name: to.Ptr("30972f1b-b61d-4fd8-bd34-3dcfa24670f3"),
// 	EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-06-10T13:54:55.702Z"); return t}()),
// 	Error: &armorbital.OperationResultErrorProperties{
// 		Code: to.Ptr("ReadOnlyPropertyError"),
// 		Message: to.Ptr("Cannot write to property, AuthorizationStatus, as it is read-only."),
// 	},
// 	ID: to.Ptr("https://management.azure.com/Microsoft.Orbital/operationResults/4e2ffff7-b331-4fcb-ab11-b5fa49368188?api-version=2022-11-01"),
// 	PercentComplete: to.Ptr[float64](1),
// 	Properties: map[string]any{
// 	},
// 	StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-06-10T13:54:53.655Z"); return t}()),
// 	Status: to.Ptr(armorbital.StatusFailed),
// }

Output:

type OperationsResultsClientBeginGetOptions 

type OperationsResultsClientBeginGetOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

OperationsResultsClientBeginGetOptions contains the optional parameters for the OperationsResultsClient.BeginGet method.

type OperationsResultsClientGetResponse 

type OperationsResultsClientGetResponse struct {
	// Operation Result Entity.
	OperationResult
}

OperationsResultsClientGetResponse contains the response from method OperationsResultsClient.BeginGet.

type Origin 

type Origin string

Origin - The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" 

const (
	OriginSystem     Origin = "system"
	OriginUser       Origin = "user"
	OriginUserSystem Origin = "user,system"
)

func PossibleOriginValues 

func PossibleOriginValues() []Origin

PossibleOriginValues returns the possible values for the Origin const type.

type Polarization 

type Polarization string

Polarization - Polarization. e.g. (RHCP, LHCP). 

const (
	PolarizationLHCP             Polarization = "LHCP"
	PolarizationLinearHorizontal Polarization = "linearHorizontal"
	PolarizationLinearVertical   Polarization = "linearVertical"
	PolarizationRHCP             Polarization = "RHCP"
)

func PossiblePolarizationValues 

func PossiblePolarizationValues() []Polarization

PossiblePolarizationValues returns the possible values for the Polarization const type.

type Protocol 

type Protocol string

Protocol - Protocol either UDP or TCP. 

const (
	ProtocolTCP Protocol = "TCP"
	ProtocolUDP Protocol = "UDP"
)

func PossibleProtocolValues 

func PossibleProtocolValues() []Protocol

PossibleProtocolValues returns the possible values for the Protocol const type.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - The current state of the resource's creation, deletion, or modification. 

const (
	ProvisioningStateCanceled  ProvisioningState = "canceled"
	ProvisioningStateCreating  ProvisioningState = "creating"
	ProvisioningStateDeleting  ProvisioningState = "deleting"
	ProvisioningStateFailed    ProvisioningState = "failed"
	ProvisioningStateSucceeded ProvisioningState = "succeeded"
	ProvisioningStateUpdating  ProvisioningState = "updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ProxyResource 

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

ProxyResource - The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON 

func (p ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProxyResource.

func (*ProxyResource) UnmarshalJSON 

func (p *ProxyResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyResource.

type ReleaseMode 

type ReleaseMode string

ReleaseMode - Release Status of a ground station. 

const (
	ReleaseModeGA      ReleaseMode = "GA"
	ReleaseModePreview ReleaseMode = "Preview"
)

func PossibleReleaseModeValues 

func PossibleReleaseModeValues() []ReleaseMode

PossibleReleaseModeValues returns the possible values for the ReleaseMode const type.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON 

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceIDListResult 

type ResourceIDListResult struct {
	// A list of Azure Resource IDs.
	Value []*ResourceIDListResultValueItem

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

ResourceIDListResult - Response for an API service call that lists the resource IDs of resources associated with another resource.

func (ResourceIDListResult) MarshalJSON 

func (r ResourceIDListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceIDListResult.

func (*ResourceIDListResult) UnmarshalJSON 

func (r *ResourceIDListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceIDListResult.

type ResourceIDListResultValueItem 

type ResourceIDListResultValueItem struct {
	// The Azure Resource ID.
	ID *string
}

func (ResourceIDListResultValueItem) MarshalJSON 

func (r ResourceIDListResultValueItem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceIDListResultValueItem.

func (*ResourceIDListResultValueItem) UnmarshalJSON 

func (r *ResourceIDListResultValueItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceIDListResultValueItem.

type ResourceReference 

type ResourceReference struct {
	// REQUIRED; Resource ID.
	ID *string
}

ResourceReference - Resource Reference.

func (ResourceReference) MarshalJSON 

func (r ResourceReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceReference.

func (*ResourceReference) UnmarshalJSON 

func (r *ResourceReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceReference.

type Spacecraft 

type Spacecraft struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; Spacecraft Properties
	Properties *SpacecraftsProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Spacecraft - Customer creates a spacecraft resource to schedule a contact.

func (Spacecraft) MarshalJSON 

func (s Spacecraft) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Spacecraft.

func (*Spacecraft) UnmarshalJSON 

func (s *Spacecraft) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Spacecraft. 

type SpacecraftLink struct {
	// REQUIRED; Bandwidth in MHz.
	BandwidthMHz *float32

	// REQUIRED; Center Frequency in MHz.
	CenterFrequencyMHz *float32

	// REQUIRED; Direction (Uplink or Downlink).
	Direction *Direction

	// REQUIRED; Link name.
	Name *string

	// REQUIRED; Polarization. e.g. (RHCP, LHCP).
	Polarization *Polarization

	// READ-ONLY; Authorized Ground Stations
	Authorizations []*AuthorizedGroundstation
}

SpacecraftLink - List of authorized spacecraft links per ground station and the expiration date of the authorization.

func (SpacecraftLink) MarshalJSON 

func (s SpacecraftLink) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SpacecraftLink.

func (*SpacecraftLink) UnmarshalJSON 

func (s *SpacecraftLink) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SpacecraftLink.

type SpacecraftListResult 

type SpacecraftListResult struct {
	// A list of spacecraft resources in a resource group.
	Value []*Spacecraft

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string
}

SpacecraftListResult - Response for the ListSpacecrafts API service call.

func (SpacecraftListResult) MarshalJSON 

func (s SpacecraftListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SpacecraftListResult.

func (*SpacecraftListResult) UnmarshalJSON 

func (s *SpacecraftListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SpacecraftListResult.

type SpacecraftsClient 

type SpacecraftsClient struct {
	// contains filtered or unexported fields
}

SpacecraftsClient contains the methods for the Spacecrafts group. Don't use this type directly, use NewSpacecraftsClient() instead.

func NewSpacecraftsClient 

func NewSpacecraftsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SpacecraftsClient, error)

NewSpacecraftsClient creates a new instance of SpacecraftsClient with the specified values.

  • subscriptionID - The ID of the target subscription.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SpacecraftsClient) BeginCreateOrUpdate 

func (client *SpacecraftsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, spacecraftName string, parameters Spacecraft, options *SpacecraftsClientBeginCreateOrUpdateOptions) (*runtime.Poller[SpacecraftsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a spacecraft resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • spacecraftName - Spacecraft ID.
  • parameters - The parameters to provide for the created spacecraft.
  • options - SpacecraftsClientBeginCreateOrUpdateOptions contains the optional parameters for the SpacecraftsClient.BeginCreateOrUpdate method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftCreate.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSpacecraftsClient().BeginCreateOrUpdate(ctx, "contoso-Rgp", "CONTOSO_SAT", armorbital.Spacecraft{
	Location: to.Ptr("eastus2"),
	Properties: &armorbital.SpacecraftsProperties{
		Links: []*armorbital.SpacecraftLink{
			{
				Name:               to.Ptr("uplink_lhcp1"),
				BandwidthMHz:       to.Ptr[float32](2),
				CenterFrequencyMHz: to.Ptr[float32](2250),
				Direction:          to.Ptr(armorbital.DirectionUplink),
				Polarization:       to.Ptr(armorbital.PolarizationLHCP),
			},
			{
				Name:               to.Ptr("downlink_rhcp1"),
				BandwidthMHz:       to.Ptr[float32](15),
				CenterFrequencyMHz: to.Ptr[float32](8160),
				Direction:          to.Ptr(armorbital.DirectionDownlink),
				Polarization:       to.Ptr(armorbital.PolarizationRHCP),
			}},
		NoradID:   to.Ptr("36411"),
		TitleLine: to.Ptr("CONTOSO_SAT"),
		TleLine1:  to.Ptr("1 27424U 02022A   22167.05119303  .00000638  00000+0  15103-3 0  9994"),
		TleLine2:  to.Ptr("2 27424  98.2477 108.9546 0000928  92.9194 327.0802 14.57300770 69982"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Spacecraft = armorbital.Spacecraft{
// 	Name: to.Ptr("CONTOSO_SAT"),
// 	Type: to.Ptr("Microsoft.Orbital/spacecrafts"),
// 	ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"),
// 	Location: to.Ptr("eastus2"),
// 	Properties: &armorbital.SpacecraftsProperties{
// 		Links: []*armorbital.SpacecraftLink{
// 			{
// 				Name: to.Ptr("uplink_lhcp1"),
// 				Authorizations: []*armorbital.AuthorizedGroundstation{
// 					{
// 						ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-02"); return t}()),
// 						GroundStation: to.Ptr("EASTUS2_0"),
// 				}},
// 				BandwidthMHz: to.Ptr[float32](2),
// 				CenterFrequencyMHz: to.Ptr[float32](2250),
// 				Direction: to.Ptr(armorbital.DirectionUplink),
// 				Polarization: to.Ptr(armorbital.PolarizationLHCP),
// 			},
// 			{
// 				Name: to.Ptr("downlink_rhcp1"),
// 				Authorizations: []*armorbital.AuthorizedGroundstation{
// 					{
// 						ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-02"); return t}()),
// 						GroundStation: to.Ptr("EASTUS2_0"),
// 				}},
// 				BandwidthMHz: to.Ptr[float32](15),
// 				CenterFrequencyMHz: to.Ptr[float32](8160),
// 				Direction: to.Ptr(armorbital.DirectionDownlink),
// 				Polarization: to.Ptr(armorbital.PolarizationRHCP),
// 		}},
// 		NoradID: to.Ptr("36411"),
// 		ProvisioningState: to.Ptr(armorbital.SpacecraftsPropertiesProvisioningState("Succeeded")),
// 		TitleLine: to.Ptr("CONTOSO_SAT"),
// 		TleLine1: to.Ptr("1 27424U 02022A   22167.05119303  .00000638  00000+0  15103-3 0  9994"),
// 		TleLine2: to.Ptr("2 27424  98.2477 108.9546 0000928  92.9194 327.0802 14.57300770 69982"),
// 	},
// }

Output:

func (*SpacecraftsClient) BeginDelete 

func (client *SpacecraftsClient) BeginDelete(ctx context.Context, resourceGroupName string, spacecraftName string, options *SpacecraftsClientBeginDeleteOptions) (*runtime.Poller[SpacecraftsClientDeleteResponse], error)

BeginDelete - Deletes a specified spacecraft resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • spacecraftName - Spacecraft ID.
  • options - SpacecraftsClientBeginDeleteOptions contains the optional parameters for the SpacecraftsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftDelete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSpacecraftsClient().BeginDelete(ctx, "contoso-Rgp", "CONTOSO_SAT", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*SpacecraftsClient) BeginListAvailableContacts 

func (client *SpacecraftsClient) BeginListAvailableContacts(ctx context.Context, resourceGroupName string, spacecraftName string, parameters ContactParameters, options *SpacecraftsClientBeginListAvailableContactsOptions) (*runtime.Poller[*runtime.Pager[SpacecraftsClientListAvailableContactsResponse]], error)

BeginListAvailableContacts - Returns list of available contacts. A contact is available if the spacecraft is visible from the ground station for more than the minimum viable contact duration provided in the contact profile.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • spacecraftName - Spacecraft ID.
  • parameters - The parameters to provide for the contacts.
  • options - SpacecraftsClientBeginListAvailableContactsOptions contains the optional parameters for the SpacecraftsClient.BeginListAvailableContacts method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/AvailableContactsList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSpacecraftsClient().BeginListAvailableContacts(ctx, "contoso-Rgp", "CONTOSO_SAT", armorbital.ContactParameters{
	ContactProfile: &armorbital.ContactParametersContactProfile{
		ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/contactProfiles/CONTOSO-CP"),
	},
	EndTime:           to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-02T11:30:00.000Z"); return t }()),
	GroundStationName: to.Ptr("EASTUS2_0"),
	StartTime:         to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-01T11:30:00.000Z"); return t }()),
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
for res.More() {
	page, err := res.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.AvailableContactsListResult = armorbital.AvailableContactsListResult{
	// 	Value: []*armorbital.AvailableContacts{
	// 		{
	// 			GroundStationName: to.Ptr("EASTUS2_0"),
	// 			Properties: &armorbital.AvailableContactsProperties{
	// 				EndAzimuthDegrees: to.Ptr[float32](330.489627),
	// 				EndElevationDegrees: to.Ptr[float32](5.040625),
	// 				MaximumElevationDegrees: to.Ptr[float32](26.617297),
	// 				RxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-01T12:05:25.000Z"); return t}()),
	// 				RxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-01T11:55:01.000Z"); return t}()),
	// 				StartAzimuthDegrees: to.Ptr[float32](201.340472),
	// 				StartElevationDegrees: to.Ptr[float32](5),
	// 				TxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-01T12:05:25.000Z"); return t}()),
	// 				TxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-01T11:55:01.000Z"); return t}()),
	// 			},
	// 			Spacecraft: &armorbital.AvailableContactsSpacecraft{
	// 				ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"),
	// 			},
	// 		},
	// 		{
	// 			GroundStationName: to.Ptr("EASTUS2_0"),
	// 			Properties: &armorbital.AvailableContactsProperties{
	// 				EndAzimuthDegrees: to.Ptr[float32](345.848482),
	// 				EndElevationDegrees: to.Ptr[float32](5.048656),
	// 				MaximumElevationDegrees: to.Ptr[float32](85.9796),
	// 				RxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-02T11:10:45.000Z"); return t}()),
	// 				RxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-02T10:58:30.000Z"); return t}()),
	// 				StartAzimuthDegrees: to.Ptr[float32](165.758896),
	// 				StartElevationDegrees: to.Ptr[float32](5),
	// 				TxEndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-02T11:10:45.000Z"); return t}()),
	// 				TxStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-02T10:58:30.000Z"); return t}()),
	// 			},
	// 			Spacecraft: &armorbital.AvailableContactsSpacecraft{
	// 				ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"),
	// 			},
	// 	}},
	// }
}

Output:

func (*SpacecraftsClient) BeginUpdateTags 

func (client *SpacecraftsClient) BeginUpdateTags(ctx context.Context, resourceGroupName string, spacecraftName string, parameters TagsObject, options *SpacecraftsClientBeginUpdateTagsOptions) (*runtime.Poller[SpacecraftsClientUpdateTagsResponse], error)

BeginUpdateTags - Updates the specified spacecraft tags. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • spacecraftName - Spacecraft ID.
  • parameters - Parameters supplied to update spacecraft tags.
  • options - SpacecraftsClientBeginUpdateTagsOptions contains the optional parameters for the SpacecraftsClient.BeginUpdateTags method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftUpdateTags.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewSpacecraftsClient().BeginUpdateTags(ctx, "contoso-Rgp", "CONTOSO_SAT", armorbital.TagsObject{
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Spacecraft = armorbital.Spacecraft{
// 	Name: to.Ptr("CONTOSO_SAT"),
// 	Type: to.Ptr("Microsoft.Orbital/spacecrafts"),
// 	ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"),
// 	Location: to.Ptr("eastus2"),
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// 	Properties: &armorbital.SpacecraftsProperties{
// 		Links: []*armorbital.SpacecraftLink{
// 			{
// 				Name: to.Ptr("uplink_lhcp1"),
// 				Authorizations: []*armorbital.AuthorizedGroundstation{
// 					{
// 						ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-02"); return t}()),
// 						GroundStation: to.Ptr("EASTUS2_0"),
// 				}},
// 				BandwidthMHz: to.Ptr[float32](2),
// 				CenterFrequencyMHz: to.Ptr[float32](2250),
// 				Direction: to.Ptr(armorbital.DirectionUplink),
// 				Polarization: to.Ptr(armorbital.PolarizationLHCP),
// 			},
// 			{
// 				Name: to.Ptr("downlink_rhcp1"),
// 				Authorizations: []*armorbital.AuthorizedGroundstation{
// 					{
// 						ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-02"); return t}()),
// 						GroundStation: to.Ptr("EASTUS2_0"),
// 				}},
// 				BandwidthMHz: to.Ptr[float32](15),
// 				CenterFrequencyMHz: to.Ptr[float32](8160),
// 				Direction: to.Ptr(armorbital.DirectionDownlink),
// 				Polarization: to.Ptr(armorbital.PolarizationRHCP),
// 		}},
// 		NoradID: to.Ptr("36411"),
// 		ProvisioningState: to.Ptr(armorbital.SpacecraftsPropertiesProvisioningState("Succeeded")),
// 		TitleLine: to.Ptr("CONTOSO_SAT"),
// 		TleLine1: to.Ptr("1 27424U 02022A   22167.05119303  .00000638  00000+0  15103-3 0  9994"),
// 		TleLine2: to.Ptr("2 27424  98.2477 108.9546 0000928  92.9194 327.0802 14.57300770 69982"),
// 	},
// }

Output:

func (*SpacecraftsClient) Get 

func (client *SpacecraftsClient) Get(ctx context.Context, resourceGroupName string, spacecraftName string, options *SpacecraftsClientGetOptions) (SpacecraftsClientGetResponse, error)

Get - Gets the specified spacecraft in a specified resource group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • spacecraftName - Spacecraft ID.
  • options - SpacecraftsClientGetOptions contains the optional parameters for the SpacecraftsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftGet.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSpacecraftsClient().Get(ctx, "contoso-Rgp", "CONTOSO_SAT", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Spacecraft = armorbital.Spacecraft{
// 	Name: to.Ptr("CONTOSO_SAT"),
// 	Type: to.Ptr("Microsoft.Orbital/spacecrafts"),
// 	ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"),
// 	Location: to.Ptr("eastus2"),
// 	Properties: &armorbital.SpacecraftsProperties{
// 		Links: []*armorbital.SpacecraftLink{
// 			{
// 				Name: to.Ptr("uplink_lhcp1"),
// 				Authorizations: []*armorbital.AuthorizedGroundstation{
// 					{
// 						ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-02"); return t}()),
// 						GroundStation: to.Ptr("EASTUS2_0"),
// 				}},
// 				BandwidthMHz: to.Ptr[float32](2),
// 				CenterFrequencyMHz: to.Ptr[float32](2250),
// 				Direction: to.Ptr(armorbital.DirectionUplink),
// 				Polarization: to.Ptr(armorbital.PolarizationLHCP),
// 			},
// 			{
// 				Name: to.Ptr("downlink_rhcp1"),
// 				Authorizations: []*armorbital.AuthorizedGroundstation{
// 					{
// 						ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-02"); return t}()),
// 						GroundStation: to.Ptr("EASTUS2_0"),
// 				}},
// 				BandwidthMHz: to.Ptr[float32](15),
// 				CenterFrequencyMHz: to.Ptr[float32](8160),
// 				Direction: to.Ptr(armorbital.DirectionDownlink),
// 				Polarization: to.Ptr(armorbital.PolarizationRHCP),
// 		}},
// 		NoradID: to.Ptr("36411"),
// 		ProvisioningState: to.Ptr(armorbital.SpacecraftsPropertiesProvisioningState("Succeeded")),
// 		TitleLine: to.Ptr("CONTOSO_SAT"),
// 		TleLine1: to.Ptr("1 27424U 02022A   22167.05119303  .00000638  00000+0  15103-3 0  9994"),
// 		TleLine2: to.Ptr("2 27424  98.2477 108.9546 0000928  92.9194 327.0802 14.57300770 69982"),
// 	},
// }

Output:

func (*SpacecraftsClient) NewListBySubscriptionPager 

func (client *SpacecraftsClient) NewListBySubscriptionPager(options *SpacecraftsClientListBySubscriptionOptions) *runtime.Pager[SpacecraftsClientListBySubscriptionResponse]

NewListBySubscriptionPager - Returns list of spacecrafts by subscription.

Generated from API version 2022-11-01

  • options - SpacecraftsClientListBySubscriptionOptions contains the optional parameters for the SpacecraftsClient.NewListBySubscriptionPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftsBySubscriptionList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSpacecraftsClient().NewListBySubscriptionPager(&armorbital.SpacecraftsClientListBySubscriptionOptions{Skiptoken: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.SpacecraftListResult = armorbital.SpacecraftListResult{
	// 	Value: []*armorbital.Spacecraft{
	// 		{
	// 			Name: to.Ptr("CONTOSO_SAT"),
	// 			Type: to.Ptr("Microsoft.Orbital/spacecrafts"),
	// 			ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"),
	// 			Location: to.Ptr("eastus2"),
	// 			Properties: &armorbital.SpacecraftsProperties{
	// 				Links: []*armorbital.SpacecraftLink{
	// 					{
	// 						Name: to.Ptr("uplink_lhcp1"),
	// 						Authorizations: []*armorbital.AuthorizedGroundstation{
	// 							{
	// 								ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-02"); return t}()),
	// 								GroundStation: to.Ptr("EASTUS2_0"),
	// 						}},
	// 						BandwidthMHz: to.Ptr[float32](2),
	// 						CenterFrequencyMHz: to.Ptr[float32](2250),
	// 						Direction: to.Ptr(armorbital.DirectionUplink),
	// 						Polarization: to.Ptr(armorbital.PolarizationLHCP),
	// 					},
	// 					{
	// 						Name: to.Ptr("downlink_rhcp1"),
	// 						Authorizations: []*armorbital.AuthorizedGroundstation{
	// 							{
	// 								ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-02"); return t}()),
	// 								GroundStation: to.Ptr("EASTUS2_0"),
	// 						}},
	// 						BandwidthMHz: to.Ptr[float32](15),
	// 						CenterFrequencyMHz: to.Ptr[float32](8160),
	// 						Direction: to.Ptr(armorbital.DirectionDownlink),
	// 						Polarization: to.Ptr(armorbital.PolarizationRHCP),
	// 				}},
	// 				NoradID: to.Ptr("36411"),
	// 				ProvisioningState: to.Ptr(armorbital.SpacecraftsPropertiesProvisioningState("Succeeded")),
	// 				TitleLine: to.Ptr("CONTOSO_SAT"),
	// 				TleLine1: to.Ptr("1 27424U 02022A   22167.05119303  .00000638  00000+0  15103-3 0  9994"),
	// 				TleLine2: to.Ptr("2 27424  98.2477 108.9546 0000928  92.9194 327.0802 14.57300770 69982"),
	// 			},
	// 	}},
	// }
}

Output:

func (*SpacecraftsClient) NewListPager 

func (client *SpacecraftsClient) NewListPager(resourceGroupName string, options *SpacecraftsClientListOptions) *runtime.Pager[SpacecraftsClientListResponse]

NewListPager - Returns list of spacecrafts by resource group.

Generated from API version 2022-11-01

  • resourceGroupName - The name of the resource group. The name is case insensitive.
  • options - SpacecraftsClientListOptions contains the optional parameters for the SpacecraftsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1e7b408f3323e7f5424745718fe62c7a043a2337/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-11-01/examples/SpacecraftsByResourceGroupList.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armorbital.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewSpacecraftsClient().NewListPager("contoso-Rgp", &armorbital.SpacecraftsClientListOptions{Skiptoken: nil})
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.SpacecraftListResult = armorbital.SpacecraftListResult{
	// 	Value: []*armorbital.Spacecraft{
	// 		{
	// 			Name: to.Ptr("CONTOSO_SAT"),
	// 			Type: to.Ptr("Microsoft.Orbital/spacecrafts"),
	// 			ID: to.Ptr("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/resourceGroups/contoso-Rgp/providers/Microsoft.Orbital/spacecrafts/CONTOSO_SAT"),
	// 			Location: to.Ptr("eastus2"),
	// 			Properties: &armorbital.SpacecraftsProperties{
	// 				Links: []*armorbital.SpacecraftLink{
	// 					{
	// 						Name: to.Ptr("uplink_lhcp1"),
	// 						Authorizations: []*armorbital.AuthorizedGroundstation{
	// 							{
	// 								ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-02"); return t}()),
	// 								GroundStation: to.Ptr("EASTUS2_0"),
	// 						}},
	// 						BandwidthMHz: to.Ptr[float32](2),
	// 						CenterFrequencyMHz: to.Ptr[float32](2250),
	// 						Direction: to.Ptr(armorbital.DirectionUplink),
	// 						Polarization: to.Ptr(armorbital.PolarizationLHCP),
	// 					},
	// 					{
	// 						Name: to.Ptr("downlink_rhcp1"),
	// 						Authorizations: []*armorbital.AuthorizedGroundstation{
	// 							{
	// 								ExpirationDate: to.Ptr(func() time.Time { t, _ := time.Parse("2006-01-02", "2023-06-02"); return t}()),
	// 								GroundStation: to.Ptr("EASTUS2_0"),
	// 						}},
	// 						BandwidthMHz: to.Ptr[float32](15),
	// 						CenterFrequencyMHz: to.Ptr[float32](8160),
	// 						Direction: to.Ptr(armorbital.DirectionDownlink),
	// 						Polarization: to.Ptr(armorbital.PolarizationRHCP),
	// 				}},
	// 				NoradID: to.Ptr("36411"),
	// 				ProvisioningState: to.Ptr(armorbital.SpacecraftsPropertiesProvisioningState("Succeeded")),
	// 				TitleLine: to.Ptr("CONTOSO_SAT"),
	// 				TleLine1: to.Ptr("1 27424U 02022A   22167.05119303  .00000638  00000+0  15103-3 0  9994"),
	// 				TleLine2: to.Ptr("2 27424  98.2477 108.9546 0000928  92.9194 327.0802 14.57300770 69982"),
	// 			},
	// 	}},
	// }
}

Output:

type SpacecraftsClientBeginCreateOrUpdateOptions 

type SpacecraftsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SpacecraftsClientBeginCreateOrUpdateOptions contains the optional parameters for the SpacecraftsClient.BeginCreateOrUpdate method.

type SpacecraftsClientBeginDeleteOptions 

type SpacecraftsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SpacecraftsClientBeginDeleteOptions contains the optional parameters for the SpacecraftsClient.BeginDelete method.

type SpacecraftsClientBeginListAvailableContactsOptions 

type SpacecraftsClientBeginListAvailableContactsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SpacecraftsClientBeginListAvailableContactsOptions contains the optional parameters for the SpacecraftsClient.BeginListAvailableContacts method.

type SpacecraftsClientBeginUpdateTagsOptions 

type SpacecraftsClientBeginUpdateTagsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SpacecraftsClientBeginUpdateTagsOptions contains the optional parameters for the SpacecraftsClient.BeginUpdateTags method.

type SpacecraftsClientCreateOrUpdateResponse 

type SpacecraftsClientCreateOrUpdateResponse struct {
	// Customer creates a spacecraft resource to schedule a contact.
	Spacecraft
}

SpacecraftsClientCreateOrUpdateResponse contains the response from method SpacecraftsClient.BeginCreateOrUpdate.

type SpacecraftsClientDeleteResponse 

type SpacecraftsClientDeleteResponse struct {
}

SpacecraftsClientDeleteResponse contains the response from method SpacecraftsClient.BeginDelete.

type SpacecraftsClientGetOptions 

type SpacecraftsClientGetOptions struct {
}

SpacecraftsClientGetOptions contains the optional parameters for the SpacecraftsClient.Get method.

type SpacecraftsClientGetResponse 

type SpacecraftsClientGetResponse struct {
	// Customer creates a spacecraft resource to schedule a contact.
	Spacecraft
}

SpacecraftsClientGetResponse contains the response from method SpacecraftsClient.Get.

type SpacecraftsClientListAvailableContactsResponse 

type SpacecraftsClientListAvailableContactsResponse struct {
	// Response for the ListAvailableContacts API service call.
	AvailableContactsListResult
}

SpacecraftsClientListAvailableContactsResponse contains the response from method SpacecraftsClient.BeginListAvailableContacts.

type SpacecraftsClientListBySubscriptionOptions 

type SpacecraftsClientListBySubscriptionOptions struct {
	// An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous
	// list operation call returned a partial result. If a previous response contains a
	// nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point
	// to use for subsequent calls.
	Skiptoken *string
}

SpacecraftsClientListBySubscriptionOptions contains the optional parameters for the SpacecraftsClient.NewListBySubscriptionPager method.

type SpacecraftsClientListBySubscriptionResponse 

type SpacecraftsClientListBySubscriptionResponse struct {
	// Response for the ListSpacecrafts API service call.
	SpacecraftListResult
}

SpacecraftsClientListBySubscriptionResponse contains the response from method SpacecraftsClient.NewListBySubscriptionPager.

type SpacecraftsClientListOptions 

type SpacecraftsClientListOptions struct {
	// An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous
	// list operation call returned a partial result. If a previous response contains a
	// nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point
	// to use for subsequent calls.
	Skiptoken *string
}

SpacecraftsClientListOptions contains the optional parameters for the SpacecraftsClient.NewListPager method.

type SpacecraftsClientListResponse 

type SpacecraftsClientListResponse struct {
	// Response for the ListSpacecrafts API service call.
	SpacecraftListResult
}

SpacecraftsClientListResponse contains the response from method SpacecraftsClient.NewListPager.

type SpacecraftsClientUpdateTagsResponse 

type SpacecraftsClientUpdateTagsResponse struct {
	// Customer creates a spacecraft resource to schedule a contact.
	Spacecraft
}

SpacecraftsClientUpdateTagsResponse contains the response from method SpacecraftsClient.BeginUpdateTags.

type SpacecraftsProperties 

type SpacecraftsProperties struct {
	// REQUIRED; Immutable list of Spacecraft links.
	Links []*SpacecraftLink

	// REQUIRED; Title line of the two-line element set (TLE).
	TitleLine *string

	// REQUIRED; Line 1 of the two-line element set (TLE).
	TleLine1 *string

	// REQUIRED; Line 2 of the two-line element set (TLE).
	TleLine2 *string

	// NORAD ID of the spacecraft.
	NoradID *string

	// The current state of the resource's creation, deletion, or modification.
	ProvisioningState *SpacecraftsPropertiesProvisioningState
}

SpacecraftsProperties - List of Spacecraft Resource Properties.

func (SpacecraftsProperties) MarshalJSON 

func (s SpacecraftsProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SpacecraftsProperties.

func (*SpacecraftsProperties) UnmarshalJSON 

func (s *SpacecraftsProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SpacecraftsProperties.

type SpacecraftsPropertiesProvisioningState 

type SpacecraftsPropertiesProvisioningState string

SpacecraftsPropertiesProvisioningState - The current state of the resource's creation, deletion, or modification. 

const (
	SpacecraftsPropertiesProvisioningStateCanceled  SpacecraftsPropertiesProvisioningState = "canceled"
	SpacecraftsPropertiesProvisioningStateCreating  SpacecraftsPropertiesProvisioningState = "creating"
	SpacecraftsPropertiesProvisioningStateDeleting  SpacecraftsPropertiesProvisioningState = "deleting"
	SpacecraftsPropertiesProvisioningStateFailed    SpacecraftsPropertiesProvisioningState = "failed"
	SpacecraftsPropertiesProvisioningStateSucceeded SpacecraftsPropertiesProvisioningState = "succeeded"
	SpacecraftsPropertiesProvisioningStateUpdating  SpacecraftsPropertiesProvisioningState = "updating"
)

func PossibleSpacecraftsPropertiesProvisioningStateValues 

func PossibleSpacecraftsPropertiesProvisioningStateValues() []SpacecraftsPropertiesProvisioningState

PossibleSpacecraftsPropertiesProvisioningStateValues returns the possible values for the SpacecraftsPropertiesProvisioningState const type.

type Status 

type Status string

Status - The status of operation. 

const (
	StatusCanceled  Status = "Canceled"
	StatusFailed    Status = "Failed"
	StatusRunning   Status = "Running"
	StatusSucceeded Status = "Succeeded"
)

func PossibleStatusValues 

func PossibleStatusValues() []Status

PossibleStatusValues returns the possible values for the Status const type.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TagsObject 

type TagsObject struct {
	// Resource tags.
	Tags map[string]*string
}

TagsObject - Tags object for patch operations.

func (TagsObject) MarshalJSON 

func (t TagsObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagsObject.

func (*TagsObject) UnmarshalJSON 

func (t *TagsObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TagsObject.

type TrackedResource 

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON 

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

func (*TrackedResource) UnmarshalJSON 

func (t *TrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.