armorbital

package module
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: May 19, 2022 License: MIT Imports: 16 Imported by: 2

README

Azure Orbital Module for Go

PkgGoDev

The armorbital module provides operations for working with Azure Orbital.

Source code

Getting started

Prerequisites

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.

Clients

Azure Orbital modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armorbital.NewContactsClient(<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,
    },
}
client, err := armorbital.NewContactsClient(<subscription ID>, cred, &options)

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 APIVersionParameter added in v1.0.0

type APIVersionParameter string
const (
	APIVersionParameterTwoThousandTwenty0901Preview    APIVersionParameter = "2020-09-01-preview"
	APIVersionParameterTwoThousandTwentyOne0404Preview APIVersionParameter = "2021-04-04-preview"
	APIVersionParameterTwoThousandTwentyTwo0301        APIVersionParameter = "2022-03-01"
)

func PossibleAPIVersionParameterValues added in v1.0.0

func PossibleAPIVersionParameterValues() []APIVersionParameter

PossibleAPIVersionParameterValues returns the possible values for the APIVersionParameter const type.

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 added in v1.0.0

type AuthorizedGroundstation struct {
	// Date of authorization expiration
	ExpirationDate *time.Time `json:"expirationDate,omitempty"`

	// Groundstation name
	GroundStation *string `json:"groundStation,omitempty"`
}

AuthorizedGroundstation - Authorized groundstation

func (AuthorizedGroundstation) MarshalJSON added in v1.0.0

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

MarshalJSON implements the json.Marshaller interface for type AuthorizedGroundstation.

func (*AuthorizedGroundstation) UnmarshalJSON added in v1.0.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type AuthorizedGroundstation.

type AutoTrackingConfiguration

type AutoTrackingConfiguration string

AutoTrackingConfiguration - Auto track configuration.

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

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 `json:"properties,omitempty"`

	// The reference to the spacecraft resource.
	Spacecraft *AvailableContactsSpacecraft `json:"spacecraft,omitempty"`

	// READ-ONLY; Name of Azure Ground Station.
	GroundStationName *string `json:"groundStationName,omitempty" azure:"ro"`
}

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

type AvailableContactsListResult

type AvailableContactsListResult struct {
	// A list of available contacts
	Value []*AvailableContacts `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

AvailableContactsListResult - Response for the ListAvailableContacts API service call.

type AvailableContactsProperties added in v1.0.0

type AvailableContactsProperties struct {
	// READ-ONLY; Azimuth of the antenna at the end of the contact in decimal degrees.
	EndAzimuthDegrees *float32 `json:"endAzimuthDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Spacecraft elevation above the horizon at contact end.
	EndElevationDegrees *float32 `json:"endElevationDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Maximum elevation of the antenna during the contact in decimal degrees.
	MaximumElevationDegrees *float32 `json:"maximumElevationDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Time to lost receiving a signal.
	RxEndTime *time.Time `json:"rxEndTime,omitempty" azure:"ro"`

	// READ-ONLY; Earliest time to receive a signal.
	RxStartTime *time.Time `json:"rxStartTime,omitempty" azure:"ro"`

	// READ-ONLY; Azimuth of the antenna at the start of the contact in decimal degrees.
	StartAzimuthDegrees *float32 `json:"startAzimuthDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Spacecraft elevation above the horizon at contact start.
	StartElevationDegrees *float32 `json:"startElevationDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Time at which antenna transmit will be disabled.
	TxEndTime *time.Time `json:"txEndTime,omitempty" azure:"ro"`

	// READ-ONLY; Time at which antenna transmit will be enabled.
	TxStartTime *time.Time `json:"txStartTime,omitempty" azure:"ro"`
}

AvailableContactsProperties - Properties of Contact resource.

func (*AvailableContactsProperties) UnmarshalJSON added in v1.0.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type AvailableContactsProperties.

type AvailableContactsSpacecraft added in v1.0.0

type AvailableContactsSpacecraft struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`
}

AvailableContactsSpacecraft - The reference to the spacecraft resource.

type AvailableGroundStation

type AvailableGroundStation struct {
	// Azure region
	Location *string `json:"location,omitempty"`

	// The properties bag for this resource
	Properties *AvailableGroundStationProperties `json:"properties,omitempty"`

	// READ-ONLY; Id of groundStation
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the ground station.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Resource type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

AvailableGroundStation - GroundStations available to schedule Contacts

type AvailableGroundStationListResult

type AvailableGroundStationListResult struct {
	// A list of ground station resources.
	Value []*AvailableGroundStation `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

AvailableGroundStationListResult - Response for the AvailableGroundStations API service call.

type AvailableGroundStationProperties

type AvailableGroundStationProperties struct {
	// Altitude of the ground station
	AltitudeMeters *float32 `json:"altitudeMeters,omitempty"`

	// City of ground station.
	City *string `json:"city,omitempty"`

	// Latitude of the ground station in decimal degrees.
	LatitudeDegrees *float32 `json:"latitudeDegrees,omitempty"`

	// Longitude of the ground station in decimal degrees.
	LongitudeDegrees *float32 `json:"longitudeDegrees,omitempty"`

	// Ground station provider name.
	ProviderName *string `json:"providerName,omitempty"`

	// Release Status of a ground station
	ReleaseMode *ReleaseMode `json:"releaseMode,omitempty"`
}

AvailableGroundStationProperties - The properties bag for this resource

type AvailableGroundStationPropertiesAutoGenerated added in v1.0.0

type AvailableGroundStationPropertiesAutoGenerated struct {
	// Altitude of the ground station
	AltitudeMeters *float32 `json:"altitudeMeters,omitempty"`

	// City of ground station.
	City *string `json:"city,omitempty"`

	// Latitude of the ground station in decimal degrees.
	LatitudeDegrees *float32 `json:"latitudeDegrees,omitempty"`

	// Longitude of the ground station in decimal degrees.
	LongitudeDegrees *float32 `json:"longitudeDegrees,omitempty"`

	// Ground station provider name.
	ProviderName *string `json:"providerName,omitempty"`

	// Release Status of a ground station
	ReleaseMode *ReleaseMode `json:"releaseMode,omitempty"`
}

AvailableGroundStationPropertiesAutoGenerated - Properties object for Available groundstation.

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) Get

Get - Gets the specified available ground station If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-03-01 groundStationName - Ground Station name options - AvailableGroundStationsClientGetOptions contains the optional parameters for the AvailableGroundStationsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableGroundStationGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewAvailableGroundStationsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"westus_gs1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*AvailableGroundStationsClient) NewListByCapabilityPager added in v0.4.0

NewListByCapabilityPager - Returns list of available ground stations If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-03-01 capability - Ground Station Capability options - AvailableGroundStationsClientListByCapabilityOptions contains the optional parameters for the AvailableGroundStationsClient.ListByCapability method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewAvailableGroundStationsClient("subId", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByCapabilityPager(armorbital.CapabilityParameterEarthObservation,
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

type AvailableGroundStationsClientGetOptions added in v0.2.0

type AvailableGroundStationsClientGetOptions struct {
}

AvailableGroundStationsClientGetOptions contains the optional parameters for the AvailableGroundStationsClient.Get method.

type AvailableGroundStationsClientGetResponse added in v0.2.0

type AvailableGroundStationsClientGetResponse struct {
	AvailableGroundStation
}

AvailableGroundStationsClientGetResponse contains the response from method AvailableGroundStationsClient.Get.

type AvailableGroundStationsClientListByCapabilityOptions added in v0.2.0

type AvailableGroundStationsClientListByCapabilityOptions struct {
}

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

type AvailableGroundStationsClientListByCapabilityResponse added in v0.2.0

type AvailableGroundStationsClientListByCapabilityResponse struct {
	AvailableGroundStationListResult
}

AvailableGroundStationsClientListByCapabilityResponse contains the response from method AvailableGroundStationsClient.ListByCapability.

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 added in v1.0.0

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

func PossibleCapabilityParameterValues added in v1.0.0

func PossibleCapabilityParameterValues() []CapabilityParameter

PossibleCapabilityParameterValues returns the possible values for the CapabilityParameter const type.

type CloudError

type CloudError struct {
	// An error response from the service.
	Error *CloudErrorBody `json:"error,omitempty"`
}

CloudError - An error response from the service.

type CloudErrorBody

type CloudErrorBody struct {
	// An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
	Code *string `json:"code,omitempty"`

	// A list of additional details about the error.
	Details []*CloudErrorBody `json:"details,omitempty"`

	// A message describing the error, intended to be suitable for display in a user interface.
	Message *string `json:"message,omitempty"`

	// The target of the particular error. For example, the name of the property in error.
	Target *string `json:"target,omitempty"`
}

CloudErrorBody - An error response from the service.

type Contact

type Contact struct {
	// Properties of the Contact Resource.
	Properties *ContactsProperties `json:"properties,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

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

type ContactInstanceProperties

type ContactInstanceProperties struct {
	// READ-ONLY; Azimuth of the antenna at the end of the contact in decimal degrees.
	EndAzimuthDegrees *float32 `json:"endAzimuthDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Spacecraft elevation above the horizon at contact end.
	EndElevationDegrees *float32 `json:"endElevationDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Maximum elevation of the antenna during the contact in decimal degrees.
	MaximumElevationDegrees *float32 `json:"maximumElevationDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Time to lost receiving a signal.
	RxEndTime *time.Time `json:"rxEndTime,omitempty" azure:"ro"`

	// READ-ONLY; Earliest time to receive a signal.
	RxStartTime *time.Time `json:"rxStartTime,omitempty" azure:"ro"`

	// READ-ONLY; Azimuth of the antenna at the start of the contact in decimal degrees.
	StartAzimuthDegrees *float32 `json:"startAzimuthDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Spacecraft elevation above the horizon at contact start.
	StartElevationDegrees *float32 `json:"startElevationDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Time at which antenna transmit will be disabled.
	TxEndTime *time.Time `json:"txEndTime,omitempty" azure:"ro"`

	// READ-ONLY; Time at which antenna transmit will be enabled.
	TxStartTime *time.Time `json:"txStartTime,omitempty" azure:"ro"`
}

ContactInstanceProperties - Contact Instance Properties

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 `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ContactListResult - Response for the ListContacts API service call.

type ContactParameters

type ContactParameters struct {
	// REQUIRED; The reference to the contact profile resource.
	ContactProfile *ContactParametersContactProfile `json:"contactProfile,omitempty"`

	// REQUIRED; End time of a contact.
	EndTime *time.Time `json:"endTime,omitempty"`

	// REQUIRED; Name of Azure Ground Station.
	GroundStationName *string `json:"groundStationName,omitempty"`

	// REQUIRED; Start time of a contact.
	StartTime *time.Time `json:"startTime,omitempty"`
}

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 added in v1.0.0

type ContactParametersContactProfile struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`
}

ContactParametersContactProfile - The reference to the contact profile resource.

type ContactProfile

type ContactProfile struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Properties of the contact profile resource.
	Properties *ContactProfileProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

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.

type ContactProfileLink struct {
	// REQUIRED; Contact Profile Link Channel
	Channels []*ContactProfileLinkChannel `json:"channels,omitempty"`

	// REQUIRED; Direction (uplink or downlink)
	Direction *Direction `json:"direction,omitempty"`

	// REQUIRED; Link name
	Name *string `json:"name,omitempty"`

	// REQUIRED; polarization. eg (RHCP, LHCP)
	Polarization *Polarization `json:"polarization,omitempty"`

	// Effective Isotropic Radiated Power (EIRP) in dBW.
	EirpdBW *float32 `json:"eirpdBW,omitempty"`

	// Gain To Noise Temperature in db/K.
	GainOverTemperature *float32 `json:"gainOverTemperature,omitempty"`
}

ContactProfileLink - Contact Profile Link

func (ContactProfileLink) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type ContactProfileLink.

type ContactProfileLinkChannel

type ContactProfileLinkChannel struct {
	// REQUIRED; Bandwidth in MHz
	BandwidthMHz *float32 `json:"bandwidthMHz,omitempty"`

	// REQUIRED; Center Frequency in MHz
	CenterFrequencyMHz *float32 `json:"centerFrequencyMHz,omitempty"`

	// REQUIRED; Customer End point to store/retrieve data during a contact.
	EndPoint *EndPoint `json:"endPoint,omitempty"`

	// REQUIRED; Channel name
	Name *string `json:"name,omitempty"`

	// Configuration for decoding
	DecodingConfiguration *string `json:"decodingConfiguration,omitempty"`

	// Configuration for demodulation
	DemodulationConfiguration *string `json:"demodulationConfiguration,omitempty"`

	// Configuration for encoding
	EncodingConfiguration *string `json:"encodingConfiguration,omitempty"`

	// Configuration for modulation
	ModulationConfiguration *string `json:"modulationConfiguration,omitempty"`
}

ContactProfileLinkChannel - Contact Profile Link Channel

type ContactProfileListResult

type ContactProfileListResult struct {
	// A list of contact profile resources in a resource group.
	Value []*ContactProfile `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ContactProfileListResult - Response for the ListContactProfiles API service call.

type ContactProfileProperties added in v1.0.0

type ContactProfileProperties struct {
	// REQUIRED; Links of the Contact Profile
	Links []*ContactProfileLink `json:"links,omitempty"`

	// REQUIRED; Network configuration of customer virtual network.
	NetworkConfiguration *ContactProfilesPropertiesNetworkConfiguration `json:"networkConfiguration,omitempty"`

	// Auto track configuration.
	AutoTrackingConfiguration *AutoTrackingConfiguration `json:"autoTrackingConfiguration,omitempty"`

	// The URI of the Event Hub used for telemetry
	EventHubURI *string `json:"eventHubUri,omitempty"`

	// Minimum viable elevation for the contact in decimal degrees.
	MinimumElevationDegrees *float32 `json:"minimumElevationDegrees,omitempty"`

	// Minimum viable contact duration in ISO 8601 format.
	MinimumViableContactDuration *string `json:"minimumViableContactDuration,omitempty"`

	// The current state of the resource's creation, deletion, or modification
	ProvisioningState *ContactProfilesPropertiesProvisioningState `json:"provisioningState,omitempty"`
}

ContactProfileProperties - Properties of the contact profile resource.

func (ContactProfileProperties) MarshalJSON added in v1.0.0

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

MarshalJSON implements the json.Marshaller interface for type ContactProfileProperties.

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-03-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/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileCreate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewContactProfilesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"AQUA_DIRECTPLAYBACK_WITH_UPLINK",
		armorbital.ContactProfile{
			Location: to.Ptr("westus"),
			Properties: &armorbital.ContactProfileProperties{
				AutoTrackingConfiguration: to.Ptr(armorbital.AutoTrackingConfigurationXBand),
				EventHubURI:               to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/orbitalppewestus2-ns/eventhubs/telemetry-hub/"),
				Links: []*armorbital.ContactProfileLink{
					{
						Name: to.Ptr("RHCP_UL"),
						Channels: []*armorbital.ContactProfileLinkChannel{
							{
								Name:                      to.Ptr("channel1"),
								BandwidthMHz:              to.Ptr[float32](0.036),
								CenterFrequencyMHz:        to.Ptr[float32](2106.4063),
								DecodingConfiguration:     to.Ptr("na"),
								DemodulationConfiguration: to.Ptr("na"),
								EncodingConfiguration:     to.Ptr("AQUA_CMD_CCSDS"),
								EndPoint: &armorbital.EndPoint{
									EndPointName: to.Ptr("AQUA_command"),
									IPAddress:    to.Ptr("10.0.1.0"),
									Port:         to.Ptr("4000"),
									Protocol:     to.Ptr(armorbital.ProtocolTCP),
								},
								ModulationConfiguration: to.Ptr("AQUA_UPLINK_BPSK"),
							}},
						Direction:           to.Ptr(armorbital.DirectionUplink),
						EirpdBW:             to.Ptr[float32](45),
						GainOverTemperature: to.Ptr[float32](0),
						Polarization:        to.Ptr(armorbital.PolarizationRHCP),
					},
					{
						Name: to.Ptr("RHCP_DL"),
						Channels: []*armorbital.ContactProfileLinkChannel{
							{
								Name:                      to.Ptr("channel1"),
								BandwidthMHz:              to.Ptr[float32](150),
								CenterFrequencyMHz:        to.Ptr[float32](8160),
								DecodingConfiguration:     to.Ptr("AQUA_DIRECTPLAYBACK_CCSDS"),
								DemodulationConfiguration: to.Ptr("AQUA_DOWNLINK_QPSK"),
								EncodingConfiguration:     to.Ptr("na"),
								EndPoint: &armorbital.EndPoint{
									EndPointName: to.Ptr("AQUA_directplayback"),
									IPAddress:    to.Ptr("10.0.2.0"),
									Port:         to.Ptr("4000"),
									Protocol:     to.Ptr(armorbital.ProtocolTCP),
								},
								ModulationConfiguration: to.Ptr("na"),
							}},
						Direction:           to.Ptr(armorbital.DirectionDownlink),
						EirpdBW:             to.Ptr[float32](0),
						GainOverTemperature: to.Ptr[float32](25),
						Polarization:        to.Ptr(armorbital.PolarizationRHCP),
					}},
				MinimumElevationDegrees:      to.Ptr[float32](10),
				MinimumViableContactDuration: to.Ptr("PT1M"),
				NetworkConfiguration: &armorbital.ContactProfilesPropertiesNetworkConfiguration{
					SubnetID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnetName"),
				},
			},
		},
		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)
	}
	// TODO: use response item
	_ = res
}
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-03-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/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewContactProfilesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"rg1",
		"AQUA_DIRECTPLAYBACK_WITH_UPLINK",
		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 added in v1.0.0

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-03-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/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileUpdateTag.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewContactProfilesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginUpdateTags(ctx,
		"rg1",
		"AQUA_DIRECTPLAYBACK_WITH_UPLINK",
		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)
	}
	// TODO: use response item
	_ = res
}
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-03-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/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactProfileGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewContactProfilesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"AQUA_DIRECTPLAYBACK_WITH_UPLINK",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*ContactProfilesClient) NewListBySubscriptionPager added in v0.4.0

NewListBySubscriptionPager - Returns list of contact profiles by Subscription If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-03-01 options - ContactProfilesClientListBySubscriptionOptions contains the optional parameters for the ContactProfilesClient.ListBySubscription method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewContactProfilesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(&armorbital.ContactProfilesClientListBySubscriptionOptions{Skiptoken: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*ContactProfilesClient) NewListPager added in v0.4.0

NewListPager - Returns list of contact profiles by Resource Group If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-03-01 resourceGroupName - The name of the resource group. The name is case insensitive. options - ContactProfilesClientListOptions contains the optional parameters for the ContactProfilesClient.List method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewContactProfilesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("rg1",
		&armorbital.ContactProfilesClientListOptions{Skiptoken: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

type ContactProfilesClientBeginCreateOrUpdateOptions added in v0.2.0

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

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

type ContactProfilesClientBeginDeleteOptions added in v0.2.0

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

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

type ContactProfilesClientBeginUpdateTagsOptions added in v1.0.0

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

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

type ContactProfilesClientCreateOrUpdateResponse added in v0.2.0

type ContactProfilesClientCreateOrUpdateResponse struct {
	ContactProfile
}

ContactProfilesClientCreateOrUpdateResponse contains the response from method ContactProfilesClient.CreateOrUpdate.

type ContactProfilesClientDeleteResponse added in v0.2.0

type ContactProfilesClientDeleteResponse struct {
}

ContactProfilesClientDeleteResponse contains the response from method ContactProfilesClient.Delete.

type ContactProfilesClientGetOptions added in v0.2.0

type ContactProfilesClientGetOptions struct {
}

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

type ContactProfilesClientGetResponse added in v0.2.0

type ContactProfilesClientGetResponse struct {
	ContactProfile
}

ContactProfilesClientGetResponse contains the response from method ContactProfilesClient.Get.

type ContactProfilesClientListBySubscriptionOptions added in v0.2.0

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.ListBySubscription method.

type ContactProfilesClientListBySubscriptionResponse added in v0.2.0

type ContactProfilesClientListBySubscriptionResponse struct {
	ContactProfileListResult
}

ContactProfilesClientListBySubscriptionResponse contains the response from method ContactProfilesClient.ListBySubscription.

type ContactProfilesClientListOptions added in v0.2.0

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.List method.

type ContactProfilesClientListResponse added in v0.2.0

type ContactProfilesClientListResponse struct {
	ContactProfileListResult
}

ContactProfilesClientListResponse contains the response from method ContactProfilesClient.List.

type ContactProfilesClientUpdateTagsResponse added in v0.2.0

type ContactProfilesClientUpdateTagsResponse struct {
	ContactProfile
}

ContactProfilesClientUpdateTagsResponse contains the response from method ContactProfilesClient.UpdateTags.

type ContactProfilesProperties

type ContactProfilesProperties struct {
	// REQUIRED; Links of the Contact Profile
	Links []*ContactProfileLink `json:"links,omitempty"`

	// REQUIRED; Network configuration of customer virtual network.
	NetworkConfiguration *ContactProfilesPropertiesNetworkConfiguration `json:"networkConfiguration,omitempty"`

	// Auto track configuration.
	AutoTrackingConfiguration *AutoTrackingConfiguration `json:"autoTrackingConfiguration,omitempty"`

	// The URI of the Event Hub used for telemetry
	EventHubURI *string `json:"eventHubUri,omitempty"`

	// Minimum viable elevation for the contact in decimal degrees.
	MinimumElevationDegrees *float32 `json:"minimumElevationDegrees,omitempty"`

	// Minimum viable contact duration in ISO 8601 format.
	MinimumViableContactDuration *string `json:"minimumViableContactDuration,omitempty"`

	// The current state of the resource's creation, deletion, or modification
	ProvisioningState *ContactProfilesPropertiesProvisioningState `json:"provisioningState,omitempty"`
}

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.

type ContactProfilesPropertiesNetworkConfiguration added in v1.0.0

type ContactProfilesPropertiesNetworkConfiguration struct {
	// REQUIRED; Customer subnet ARM resource identifier.
	SubnetID *string `json:"subnetId,omitempty"`
}

ContactProfilesPropertiesNetworkConfiguration - Network configuration of customer virtual network.

type ContactProfilesPropertiesProvisioningState added in v1.0.0

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 added in v1.0.0

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-03-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/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactCreate.json

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewContactsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreate(ctx,
		"rg1",
		"AQUA",
		"contact1",
		armorbital.Contact{
			Properties: &armorbital.ContactsProperties{
				ContactProfile: &armorbital.ContactsPropertiesContactProfile{
					ID: to.Ptr("/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK"),
				},
				GroundStationName:    to.Ptr("westus_gs1"),
				ReservationEndTime:   to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-07-16T20:55:00.00Z"); return t }()),
				ReservationStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-07-16T20:35:00.00Z"); 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)
	}
	// TODO: use response item
	_ = res
}
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-03-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/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewContactsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"rg1",
		"AQUA",
		"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-03-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/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/ContactGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewContactsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"AQUA",
		"contact1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*ContactsClient) NewListPager added in v0.4.0

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

NewListPager - Returns list of contacts by spacecraftName If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-03-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.List method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewContactsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("rg1",
		"AQUA",
		&armorbital.ContactsClientListOptions{Skiptoken: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

type ContactsClientBeginCreateOptions added in v0.2.0

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

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

type ContactsClientBeginDeleteOptions added in v0.2.0

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

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

type ContactsClientCreateResponse added in v0.2.0

type ContactsClientCreateResponse struct {
	Contact
}

ContactsClientCreateResponse contains the response from method ContactsClient.Create.

type ContactsClientDeleteResponse added in v0.2.0

type ContactsClientDeleteResponse struct {
}

ContactsClientDeleteResponse contains the response from method ContactsClient.Delete.

type ContactsClientGetOptions added in v0.2.0

type ContactsClientGetOptions struct {
}

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

type ContactsClientGetResponse added in v0.2.0

type ContactsClientGetResponse struct {
	Contact
}

ContactsClientGetResponse contains the response from method ContactsClient.Get.

type ContactsClientListOptions added in v0.2.0

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.List method.

type ContactsClientListResponse added in v0.2.0

type ContactsClientListResponse struct {
	ContactListResult
}

ContactsClientListResponse contains the response from method ContactsClient.List.

type ContactsProperties

type ContactsProperties struct {
	// REQUIRED; The reference to the contact profile resource.
	ContactProfile *ContactsPropertiesContactProfile `json:"contactProfile,omitempty"`

	// REQUIRED; Azure Ground Station name.
	GroundStationName *string `json:"groundStationName,omitempty"`

	// REQUIRED; Reservation end time of a contact.
	ReservationEndTime *time.Time `json:"reservationEndTime,omitempty"`

	// REQUIRED; Reservation start time of a contact.
	ReservationStartTime *time.Time `json:"reservationStartTime,omitempty"`

	// The current state of the resource's creation, deletion, or modification
	ProvisioningState *ContactsPropertiesProvisioningState `json:"provisioningState,omitempty"`

	// READ-ONLY; The configuration associated with the allocated antenna.
	AntennaConfiguration *ContactsPropertiesAntennaConfiguration `json:"antennaConfiguration,omitempty" azure:"ro"`

	// READ-ONLY; Azimuth of the antenna at the end of the contact in decimal degrees.
	EndAzimuthDegrees *float32 `json:"endAzimuthDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Spacecraft elevation above the horizon at contact end.
	EndElevationDegrees *float32 `json:"endElevationDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Any error message while scheduling a contact.
	ErrorMessage *string `json:"errorMessage,omitempty" azure:"ro"`

	// READ-ONLY; Maximum elevation of the antenna during the contact in decimal degrees.
	MaximumElevationDegrees *float32 `json:"maximumElevationDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Receive end time of a contact.
	RxEndTime *time.Time `json:"rxEndTime,omitempty" azure:"ro"`

	// READ-ONLY; Receive start time of a contact.
	RxStartTime *time.Time `json:"rxStartTime,omitempty" azure:"ro"`

	// READ-ONLY; Azimuth of the antenna at the start of the contact in decimal degrees.
	StartAzimuthDegrees *float32 `json:"startAzimuthDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Spacecraft elevation above the horizon at contact start.
	StartElevationDegrees *float32 `json:"startElevationDegrees,omitempty" azure:"ro"`

	// READ-ONLY; Status of a contact.
	Status *ContactsStatus `json:"status,omitempty" azure:"ro"`

	// READ-ONLY; Transmit end time of a contact.
	TxEndTime *time.Time `json:"txEndTime,omitempty" azure:"ro"`

	// READ-ONLY; Transmit start time of a contact.
	TxStartTime *time.Time `json:"txStartTime,omitempty" azure:"ro"`
}

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 added in v1.0.0

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 `json:"destinationIp,omitempty"`

	// List of Source IP
	SourceIPs []*string `json:"sourceIps,omitempty"`
}

ContactsPropertiesAntennaConfiguration - The configuration associated with the allocated antenna.

func (ContactsPropertiesAntennaConfiguration) MarshalJSON added in v1.0.0

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

MarshalJSON implements the json.Marshaller interface for type ContactsPropertiesAntennaConfiguration.

type ContactsPropertiesContactProfile added in v1.0.0

type ContactsPropertiesContactProfile struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`
}

ContactsPropertiesContactProfile - The reference to the contact profile resource.

type ContactsPropertiesProvisioningState added in v1.0.0

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 added in v1.0.0

func PossibleContactsPropertiesProvisioningStateValues() []ContactsPropertiesProvisioningState

PossibleContactsPropertiesProvisioningStateValues returns the possible values for the ContactsPropertiesProvisioningState const type.

type ContactsStatus added in v1.0.0

type ContactsStatus string

ContactsStatus - Status of a contact.

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

func PossibleContactsStatusValues added in v1.0.0

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 `json:"endPointName,omitempty"`

	// REQUIRED; IP Address.
	IPAddress *string `json:"ipAddress,omitempty"`

	// REQUIRED; TCP port to listen on to receive data.
	Port *string `json:"port,omitempty"`

	// REQUIRED; Protocol either UDP or TCP.
	Protocol *Protocol `json:"protocol,omitempty"`
}

EndPoint - Customer End point to store/retrieve data during a contact.

type Operation

type Operation struct {
	// Localized display information for this particular operation.
	Display *OperationDisplay `json:"display,omitempty"`

	// READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
	ActionType *ActionType `json:"actionType,omitempty" azure:"ro"`

	// 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 `json:"isDataAction,omitempty" azure:"ro"`

	// 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 `json:"name,omitempty" azure:"ro"`

	// 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 `json:"origin,omitempty" azure:"ro"`
}

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

type OperationDisplay

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

	// 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 `json:"operation,omitempty" azure:"ro"`

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

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

OperationDisplay - Localized display information for this particular operation.

type OperationListResult

type OperationListResult struct {
	// READ-ONLY; URL to get the next set of operation list results (if there are any).
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List of operations supported by the resource provider
	Value []*Operation `json:"value,omitempty" azure:"ro"`
}

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.

type OperationResult added in v1.0.0

type OperationResult struct {
	// Operation result error properties
	Error *OperationResultErrorProperties `json:"error,omitempty"`

	// Operation result properties
	Properties interface{} `json:"properties,omitempty"`

	// READ-ONLY; The operation end time
	EndTime *time.Time `json:"endTime,omitempty" azure:"ro"`

	// READ-ONLY; ID of the resource.
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; Name of the resource.
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Percentage completed.
	PercentComplete *float64 `json:"percentComplete,omitempty" azure:"ro"`

	// READ-ONLY; The operation start time
	StartTime *time.Time `json:"startTime,omitempty" azure:"ro"`

	// READ-ONLY; The status of operation.
	Status *Status `json:"status,omitempty" azure:"ro"`
}

OperationResult - Operation Result Entity.

func (*OperationResult) UnmarshalJSON added in v1.0.0

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationResult.

type OperationResultErrorProperties added in v1.0.0

type OperationResultErrorProperties struct {
	// READ-ONLY; The code of the error.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`
}

OperationResultErrorProperties - Operation result error properties

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 added in v0.4.0

NewListPager - Lists all of the available Orbital Rest API operations. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-03-01 options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewOperationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

type OperationsClientListOptions added in v0.2.0

type OperationsClientListOptions struct {
}

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

type OperationsClientListResponse added in v0.2.0

type OperationsClientListResponse struct {
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type OperationsResultsClient added in v1.0.0

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 added in v1.0.0

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 added in v1.0.0

BeginGet - Returns operation results. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-03-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/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/OperationResultsGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewOperationsResultsClient("12345678-1234-1234-1234-123456789098", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginGet(ctx,
		"westus",
		"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)
	}
	// TODO: use response item
	_ = res
}
Output:

type OperationsResultsClientBeginGetOptions added in v1.0.0

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

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

type OperationsResultsClientGetResponse added in v1.0.0

type OperationsResultsClientGetResponse struct {
	OperationResult
}

OperationsResultsClientGetResponse contains the response from method OperationsResultsClient.Get.

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. eg (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 added in v1.0.0

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 added in v1.0.0

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 `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

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

type ReleaseMode added in v1.0.0

type ReleaseMode string

ReleaseMode - Release Status of a ground station

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

func PossibleReleaseModeValues added in v1.0.0

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 `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

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

type ResourceIDListResult

type ResourceIDListResult struct {
	// A list of Azure Resource IDs.
	Value []*ResourceIDListResultValueItem `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

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

type ResourceIDListResultValueItem

type ResourceIDListResultValueItem struct {
	// The Azure Resource ID
	ID *string `json:"id,omitempty"`
}

type ResourceReference

type ResourceReference struct {
	// Resource ID.
	ID *string `json:"id,omitempty"`
}

ResourceReference - Resource Reference

type Spacecraft

type Spacecraft struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Spacecraft Properties
	Properties *SpacecraftsProperties `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; A unique read-only string that changes whenever the resource is updated.
	Etag *string `json:"etag,omitempty" azure:"ro"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

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.

type SpacecraftLink struct {
	// REQUIRED; Bandwidth in MHz
	BandwidthMHz *float32 `json:"bandwidthMHz,omitempty"`

	// REQUIRED; Center Frequency in MHz
	CenterFrequencyMHz *float32 `json:"centerFrequencyMHz,omitempty"`

	// REQUIRED; Direction (uplink or downlink)
	Direction *Direction `json:"direction,omitempty"`

	// REQUIRED; Link name
	Name *string `json:"name,omitempty"`

	// REQUIRED; polarization. eg (RHCP, LHCP)
	Polarization *Polarization `json:"polarization,omitempty"`

	// READ-ONLY; Authorized Ground Stations
	Authorizations []*AuthorizedGroundstation `json:"authorizations,omitempty" azure:"ro"`
}

SpacecraftLink - Authorized Ground Stations for the link

func (SpacecraftLink) MarshalJSON added in v1.0.0

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

MarshalJSON implements the json.Marshaller interface for type SpacecraftLink.

type SpacecraftListResult

type SpacecraftListResult struct {
	// A list of spacecraft resources in a resource group.
	Value []*Spacecraft `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

SpacecraftListResult - Response for the ListSpacecrafts API service call.

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-03-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/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftCreate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewSpacecraftsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"AQUA",
		armorbital.Spacecraft{
			Location: to.Ptr("westus"),
			Properties: &armorbital.SpacecraftsProperties{
				Links: []*armorbital.SpacecraftLink{
					{
						Name:               to.Ptr("S_RHCP_UL"),
						BandwidthMHz:       to.Ptr[float32](0.036),
						CenterFrequencyMHz: to.Ptr[float32](2106.4063),
						Direction:          to.Ptr(armorbital.DirectionUplink),
						Polarization:       to.Ptr(armorbital.PolarizationRHCP),
					},
					{
						Name:               to.Ptr("X_RHCP_DL"),
						BandwidthMHz:       to.Ptr[float32](150),
						CenterFrequencyMHz: to.Ptr[float32](8125),
						Direction:          to.Ptr(armorbital.DirectionDownlink),
						Polarization:       to.Ptr(armorbital.PolarizationRHCP),
					}},
				NoradID:   to.Ptr("27424"),
				TitleLine: to.Ptr("(AQUA)"),
				TleLine1:  to.Ptr("1 27424U 02022A   20195.59202355  .00000039  00000-0  18634-4 0  9991"),
				TleLine2:  to.Ptr("2 27424  98.2098 135.8486 0000176  28.4050 144.5909 14.57108832967671"),
			},
		},
		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)
	}
	// TODO: use response item
	_ = res
}
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-03-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/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewSpacecraftsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"rg1",
		"AQUA",
		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 - Return list of available contacts If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-03-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/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/AvailableContactsList.json

package main

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewSpacecraftsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginListAvailableContacts(ctx,
		"rgName",
		"AQUA",
		armorbital.ContactParameters{
			ContactProfile: &armorbital.ContactParametersContactProfile{
				ID: to.Ptr("/subscriptions/subId/resourceGroups/rg/Microsoft.Orbital/contactProfiles/AQUA_DIRECTPLAYBACK_WITH_UPLINK"),
			},
			EndTime:           to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-07-17T23:49:40.00Z"); return t }()),
			GroundStationName: to.Ptr("westus_gs1"),
			StartTime:         to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-07-16T05:40:21.00Z"); 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() {
		nextResult, err := res.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*SpacecraftsClient) BeginUpdateTags added in v1.0.0

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-03-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/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftUpdateTags.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewSpacecraftsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginUpdateTags(ctx,
		"rg1",
		"AQUA",
		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)
	}
	// TODO: use response item
	_ = res
}
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-03-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/tree/main/specification/orbital/resource-manager/Microsoft.Orbital/stable/2022-03-01/examples/SpacecraftGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewSpacecraftsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"AQUA",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*SpacecraftsClient) NewListBySubscriptionPager added in v0.4.0

NewListBySubscriptionPager - Return list of spacecrafts If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-03-01 options - SpacecraftsClientListBySubscriptionOptions contains the optional parameters for the SpacecraftsClient.ListBySubscription method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewSpacecraftsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(&armorbital.SpacecraftsClientListBySubscriptionOptions{Skiptoken: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*SpacecraftsClient) NewListPager added in v0.4.0

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

NewListPager - Return list of spacecrafts If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-03-01 resourceGroupName - The name of the resource group. The name is case insensitive. options - SpacecraftsClientListOptions contains the optional parameters for the SpacecraftsClient.List method.

Example

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

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/orbital/armorbital"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armorbital.NewSpacecraftsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager("rg1",
		&armorbital.SpacecraftsClientListOptions{Skiptoken: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

type SpacecraftsClientBeginCreateOrUpdateOptions added in v0.2.0

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

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

type SpacecraftsClientBeginDeleteOptions added in v0.2.0

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

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

type SpacecraftsClientBeginListAvailableContactsOptions added in v0.2.0

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

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

type SpacecraftsClientBeginUpdateTagsOptions added in v1.0.0

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

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

type SpacecraftsClientCreateOrUpdateResponse added in v0.2.0

type SpacecraftsClientCreateOrUpdateResponse struct {
	Spacecraft
}

SpacecraftsClientCreateOrUpdateResponse contains the response from method SpacecraftsClient.CreateOrUpdate.

type SpacecraftsClientDeleteResponse added in v0.2.0

type SpacecraftsClientDeleteResponse struct {
}

SpacecraftsClientDeleteResponse contains the response from method SpacecraftsClient.Delete.

type SpacecraftsClientGetOptions added in v0.2.0

type SpacecraftsClientGetOptions struct {
}

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

type SpacecraftsClientGetResponse added in v0.2.0

type SpacecraftsClientGetResponse struct {
	Spacecraft
}

SpacecraftsClientGetResponse contains the response from method SpacecraftsClient.Get.

type SpacecraftsClientListAvailableContactsResponse added in v0.2.0

type SpacecraftsClientListAvailableContactsResponse struct {
	AvailableContactsListResult
}

SpacecraftsClientListAvailableContactsResponse contains the response from method SpacecraftsClient.ListAvailableContacts.

type SpacecraftsClientListBySubscriptionOptions added in v0.2.0

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.ListBySubscription method.

type SpacecraftsClientListBySubscriptionResponse added in v0.2.0

type SpacecraftsClientListBySubscriptionResponse struct {
	SpacecraftListResult
}

SpacecraftsClientListBySubscriptionResponse contains the response from method SpacecraftsClient.ListBySubscription.

type SpacecraftsClientListOptions added in v0.2.0

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.List method.

type SpacecraftsClientListResponse added in v0.2.0

type SpacecraftsClientListResponse struct {
	SpacecraftListResult
}

SpacecraftsClientListResponse contains the response from method SpacecraftsClient.List.

type SpacecraftsClientUpdateTagsResponse added in v0.2.0

type SpacecraftsClientUpdateTagsResponse struct {
	Spacecraft
}

SpacecraftsClientUpdateTagsResponse contains the response from method SpacecraftsClient.UpdateTags.

type SpacecraftsProperties

type SpacecraftsProperties struct {
	// REQUIRED; NORAD ID of the spacecraft.
	NoradID *string `json:"noradId,omitempty"`

	// Links of the Spacecraft
	Links []*SpacecraftLink `json:"links,omitempty"`

	// The current state of the resource's creation, deletion, or modification
	ProvisioningState *SpacecraftsPropertiesProvisioningState `json:"provisioningState,omitempty"`

	// Title line of Two Line Element (TLE).
	TitleLine *string `json:"titleLine,omitempty"`

	// Line 1 of Two Line Element (TLE).
	TleLine1 *string `json:"tleLine1,omitempty"`

	// Line 2 of Two Line Element (TLE).
	TleLine2 *string `json:"tleLine2,omitempty"`
}

SpacecraftsProperties - List of Spacecraft Resource Properties.

func (SpacecraftsProperties) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type SpacecraftsProperties.

type SpacecraftsPropertiesProvisioningState added in v1.0.0

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 added in v1.0.0

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 `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

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 `json:"tags,omitempty"`
}

TagsObject - Tags object for patch operations.

func (TagsObject) MarshalJSON

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

MarshalJSON implements the json.Marshaller interface for type TagsObject.

type TrackedResource

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL