groundstation

README

github.com/hashicorp/go-azure-sdk/resource-manager/orbital/2022-11-01/groundstation Documentation

The groundstation SDK allows for interaction with the Azure Resource Manager Service orbital (API Version 2022-11-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/orbital/2022-11-01/groundstation"

Client Initialization

client := groundstation.NewGroundStationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GroundStationClient.AvailableGroundStationsListByCapability

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

// alternatively `client.AvailableGroundStationsListByCapability(ctx, id, groundstation.DefaultAvailableGroundStationsListByCapabilityOperationOptions())` can be used to do batched pagination
items, err := client.AvailableGroundStationsListByCapabilityComplete(ctx, id, groundstation.DefaultAvailableGroundStationsListByCapabilityOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

• func PossibleValuesForCapabilityParameter() []string
• func PossibleValuesForReleaseMode() []string
• type AvailableGroundStation
• type AvailableGroundStationOperationPredicate
  • func (p AvailableGroundStationOperationPredicate) Matches(input AvailableGroundStation) bool
• type AvailableGroundStationProperties
• type AvailableGroundStationsListByCapabilityCompleteResult
• type AvailableGroundStationsListByCapabilityCustomPager
  • func (p *AvailableGroundStationsListByCapabilityCustomPager) NextPageLink() *odata.Link
• type AvailableGroundStationsListByCapabilityOperationOptions
  • func DefaultAvailableGroundStationsListByCapabilityOperationOptions() AvailableGroundStationsListByCapabilityOperationOptions
  • func (o AvailableGroundStationsListByCapabilityOperationOptions) ToHeaders() *client.Headers
  • func (o AvailableGroundStationsListByCapabilityOperationOptions) ToOData() *odata.Query
  • func (o AvailableGroundStationsListByCapabilityOperationOptions) ToQuery() *client.QueryParams
• type AvailableGroundStationsListByCapabilityOperationResponse
• type CapabilityParameter
  • func (s *CapabilityParameter) UnmarshalJSON(bytes []byte) error
• type GroundStationClient
  • func NewGroundStationClientWithBaseURI(sdkApi sdkEnv.Api) (*GroundStationClient, error)
  • func (c GroundStationClient) AvailableGroundStationsListByCapability(ctx context.Context, id commonids.SubscriptionId, ...) (result AvailableGroundStationsListByCapabilityOperationResponse, err error)
  • func (c GroundStationClient) AvailableGroundStationsListByCapabilityComplete(ctx context.Context, id commonids.SubscriptionId, ...) (AvailableGroundStationsListByCapabilityCompleteResult, error)
  • func (c GroundStationClient) AvailableGroundStationsListByCapabilityCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result AvailableGroundStationsListByCapabilityCompleteResult, err error)
• type ReleaseMode
  • func (s *ReleaseMode) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForCapabilityParameter

func PossibleValuesForCapabilityParameter() []string

func PossibleValuesForReleaseMode

func PossibleValuesForReleaseMode() []string

Types

type AvailableGroundStation

type AvailableGroundStation struct {
	Id         *string                          `json:"id,omitempty"`
	Location   *string                          `json:"location,omitempty"`
	Name       *string                          `json:"name,omitempty"`
	Properties AvailableGroundStationProperties `json:"properties"`
	Type       *string                          `json:"type,omitempty"`
}

type AvailableGroundStationOperationPredicate

type AvailableGroundStationOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (AvailableGroundStationOperationPredicate) Matches

func (p AvailableGroundStationOperationPredicate) Matches(input AvailableGroundStation) bool

type AvailableGroundStationProperties

type AvailableGroundStationProperties struct {
	AltitudeMeters   *float64     `json:"altitudeMeters,omitempty"`
	City             *string      `json:"city,omitempty"`
	LatitudeDegrees  *float64     `json:"latitudeDegrees,omitempty"`
	LongitudeDegrees *float64     `json:"longitudeDegrees,omitempty"`
	ProviderName     *string      `json:"providerName,omitempty"`
	ReleaseMode      *ReleaseMode `json:"releaseMode,omitempty"`
}

type AvailableGroundStationsListByCapabilityCompleteResult

type AvailableGroundStationsListByCapabilityCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []AvailableGroundStation
}

type AvailableGroundStationsListByCapabilityCustomPager

type AvailableGroundStationsListByCapabilityCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}

func (*AvailableGroundStationsListByCapabilityCustomPager) NextPageLink

func (p *AvailableGroundStationsListByCapabilityCustomPager) NextPageLink() *odata.Link

type AvailableGroundStationsListByCapabilityOperationOptions

type AvailableGroundStationsListByCapabilityOperationOptions struct {
	Capability *CapabilityParameter
}

func DefaultAvailableGroundStationsListByCapabilityOperationOptions

func DefaultAvailableGroundStationsListByCapabilityOperationOptions() AvailableGroundStationsListByCapabilityOperationOptions

func (AvailableGroundStationsListByCapabilityOperationOptions) ToHeaders

func (o AvailableGroundStationsListByCapabilityOperationOptions) ToHeaders() *client.Headers

func (AvailableGroundStationsListByCapabilityOperationOptions) ToOData

func (o AvailableGroundStationsListByCapabilityOperationOptions) ToOData() *odata.Query

func (AvailableGroundStationsListByCapabilityOperationOptions) ToQuery

func (o AvailableGroundStationsListByCapabilityOperationOptions) ToQuery() *client.QueryParams

type AvailableGroundStationsListByCapabilityOperationResponse

type AvailableGroundStationsListByCapabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AvailableGroundStation
}

type CapabilityParameter

type CapabilityParameter string

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

func (*CapabilityParameter) UnmarshalJSON

func (s *CapabilityParameter) UnmarshalJSON(bytes []byte) error

type GroundStationClient

type GroundStationClient struct {
	Client *resourcemanager.Client
}

func NewGroundStationClientWithBaseURI

func NewGroundStationClientWithBaseURI(sdkApi sdkEnv.Api) (*GroundStationClient, error)

func (GroundStationClient) AvailableGroundStationsListByCapability

func (c GroundStationClient) AvailableGroundStationsListByCapability(ctx context.Context, id commonids.SubscriptionId, options AvailableGroundStationsListByCapabilityOperationOptions) (result AvailableGroundStationsListByCapabilityOperationResponse, err error)

AvailableGroundStationsListByCapability ...

func (GroundStationClient) AvailableGroundStationsListByCapabilityComplete

func (c GroundStationClient) AvailableGroundStationsListByCapabilityComplete(ctx context.Context, id commonids.SubscriptionId, options AvailableGroundStationsListByCapabilityOperationOptions) (AvailableGroundStationsListByCapabilityCompleteResult, error)

AvailableGroundStationsListByCapabilityComplete retrieves all the results into a single object

func (GroundStationClient) AvailableGroundStationsListByCapabilityCompleteMatchingPredicate

func (c GroundStationClient) AvailableGroundStationsListByCapabilityCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, options AvailableGroundStationsListByCapabilityOperationOptions, predicate AvailableGroundStationOperationPredicate) (result AvailableGroundStationsListByCapabilityCompleteResult, err error)

AvailableGroundStationsListByCapabilityCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ReleaseMode

type ReleaseMode string

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

func (*ReleaseMode) UnmarshalJSON

func (s *ReleaseMode) UnmarshalJSON(bytes []byte) error