contactprofile

package
v0.20231109.1114643 Latest Latest
Warning

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

Go to latest
Published: Nov 9, 2023 License: MPL-2.0 Imports: 13 Imported by: 1

README

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

The contactprofile 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-sdk/resource-manager/orbital/2022-11-01/contactprofile"

Client Initialization

client := contactprofile.NewContactProfileClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ContactProfileClient.CreateOrUpdate

ctx := context.TODO()
id := contactprofile.NewContactProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "contactProfileValue")

payload := contactprofile.ContactProfile{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ContactProfileClient.Delete

ctx := context.TODO()
id := contactprofile.NewContactProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "contactProfileValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ContactProfileClient.Get

ctx := context.TODO()
id := contactprofile.NewContactProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "contactProfileValue")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ContactProfileClient.List

ctx := context.TODO()
id := contactprofile.NewResourceGroupID("12345678-1234-9876-4563-123456789012", "example-resource-group")

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

Example Usage: ContactProfileClient.ListBySubscription

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

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

Example Usage: ContactProfileClient.UpdateTags

ctx := context.TODO()
id := contactprofile.NewContactProfileID("12345678-1234-9876-4563-123456789012", "example-resource-group", "contactProfileValue")

payload := contactprofile.TagsObject{
	// ...
}


if err := client.UpdateTagsThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAutoTrackingConfiguration

func PossibleValuesForAutoTrackingConfiguration() []string

func PossibleValuesForDirection

func PossibleValuesForDirection() []string

func PossibleValuesForPolarization

func PossibleValuesForPolarization() []string

func PossibleValuesForProtocol

func PossibleValuesForProtocol() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateContactProfileID

func ValidateContactProfileID(input interface{}, key string) (warnings []string, errors []error)

ValidateContactProfileID checks that 'input' can be parsed as a Contact Profile ID

Types

type AutoTrackingConfiguration

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

func (*AutoTrackingConfiguration) UnmarshalJSON added in v0.20230725.1205316

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

type ContactProfile

type ContactProfile struct {
	Id         *string                   `json:"id,omitempty"`
	Location   string                    `json:"location"`
	Name       *string                   `json:"name,omitempty"`
	Properties ContactProfilesProperties `json:"properties"`
	SystemData *systemdata.SystemData    `json:"systemData,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type ContactProfileClient

type ContactProfileClient struct {
	Client *resourcemanager.Client
}

func NewContactProfileClientWithBaseURI

func NewContactProfileClientWithBaseURI(sdkApi sdkEnv.Api) (*ContactProfileClient, error)

func (ContactProfileClient) CreateOrUpdate added in v0.20230906.1160501

CreateOrUpdate ...

func (ContactProfileClient) CreateOrUpdateThenPoll added in v0.20230906.1160501

func (c ContactProfileClient) CreateOrUpdateThenPoll(ctx context.Context, id ContactProfileId, input ContactProfile) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ContactProfileClient) Delete added in v0.20230906.1160501

Delete ...

func (ContactProfileClient) DeleteThenPoll added in v0.20230906.1160501

func (c ContactProfileClient) DeleteThenPoll(ctx context.Context, id ContactProfileId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ContactProfileClient) Get added in v0.20230906.1160501

Get ...

func (ContactProfileClient) List added in v0.20230906.1160501

List ...

func (ContactProfileClient) ListBySubscription added in v0.20230906.1160501

ListBySubscription ...

func (ContactProfileClient) ListBySubscriptionComplete added in v0.20230906.1160501

ListBySubscriptionComplete retrieves all the results into a single object

func (ContactProfileClient) ListBySubscriptionCompleteMatchingPredicate added in v0.20230906.1160501

func (c ContactProfileClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ContactProfileOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ContactProfileClient) ListComplete added in v0.20230906.1160501

ListComplete retrieves all the results into a single object

func (ContactProfileClient) ListCompleteMatchingPredicate added in v0.20230906.1160501

func (c ContactProfileClient) ListCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ContactProfileOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ContactProfileClient) UpdateTags added in v0.20230906.1160501

UpdateTags ...

func (ContactProfileClient) UpdateTagsThenPoll added in v0.20230906.1160501

func (c ContactProfileClient) UpdateTagsThenPoll(ctx context.Context, id ContactProfileId, input TagsObject) error

UpdateTagsThenPoll performs UpdateTags then polls until it's completed

type ContactProfileId

type ContactProfileId struct {
	SubscriptionId     string
	ResourceGroupName  string
	ContactProfileName string
}

ContactProfileId is a struct representing the Resource ID for a Contact Profile

func NewContactProfileID

func NewContactProfileID(subscriptionId string, resourceGroupName string, contactProfileName string) ContactProfileId

NewContactProfileID returns a new ContactProfileId struct

func ParseContactProfileID

func ParseContactProfileID(input string) (*ContactProfileId, error)

ParseContactProfileID parses 'input' into a ContactProfileId

func ParseContactProfileIDInsensitively

func ParseContactProfileIDInsensitively(input string) (*ContactProfileId, error)

ParseContactProfileIDInsensitively parses 'input' case-insensitively into a ContactProfileId note: this method should only be used for API response data and not user input

func (ContactProfileId) ID

func (id ContactProfileId) ID() string

ID returns the formatted Contact Profile ID

func (ContactProfileId) Segments

func (id ContactProfileId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Contact Profile ID

func (ContactProfileId) String

func (id ContactProfileId) String() string

String returns a human-readable description of this Contact Profile ID

type ContactProfileLink struct {
	Channels            []ContactProfileLinkChannel `json:"channels"`
	Direction           Direction                   `json:"direction"`
	EirpdBW             *float64                    `json:"eirpdBW,omitempty"`
	GainOverTemperature *float64                    `json:"gainOverTemperature,omitempty"`
	Name                string                      `json:"name"`
	Polarization        Polarization                `json:"polarization"`
}

type ContactProfileLinkChannel

type ContactProfileLinkChannel struct {
	BandwidthMHz              float64  `json:"bandwidthMHz"`
	CenterFrequencyMHz        float64  `json:"centerFrequencyMHz"`
	DecodingConfiguration     *string  `json:"decodingConfiguration,omitempty"`
	DemodulationConfiguration *string  `json:"demodulationConfiguration,omitempty"`
	EncodingConfiguration     *string  `json:"encodingConfiguration,omitempty"`
	EndPoint                  EndPoint `json:"endPoint"`
	ModulationConfiguration   *string  `json:"modulationConfiguration,omitempty"`
	Name                      string   `json:"name"`
}

type ContactProfileOperationPredicate

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

func (ContactProfileOperationPredicate) Matches

type ContactProfileThirdPartyConfiguration

type ContactProfileThirdPartyConfiguration struct {
	MissionConfiguration string `json:"missionConfiguration"`
	ProviderName         string `json:"providerName"`
}

type ContactProfilesProperties

type ContactProfilesProperties struct {
	AutoTrackingConfiguration    *AutoTrackingConfiguration                    `json:"autoTrackingConfiguration,omitempty"`
	EventHubUri                  *string                                       `json:"eventHubUri,omitempty"`
	Links                        []ContactProfileLink                          `json:"links"`
	MinimumElevationDegrees      *float64                                      `json:"minimumElevationDegrees,omitempty"`
	MinimumViableContactDuration *string                                       `json:"minimumViableContactDuration,omitempty"`
	NetworkConfiguration         ContactProfilesPropertiesNetworkConfiguration `json:"networkConfiguration"`
	ProvisioningState            *ProvisioningState                            `json:"provisioningState,omitempty"`
	ThirdPartyConfigurations     *[]ContactProfileThirdPartyConfiguration      `json:"thirdPartyConfigurations,omitempty"`
}

type ContactProfilesPropertiesNetworkConfiguration

type ContactProfilesPropertiesNetworkConfiguration struct {
	SubnetId string `json:"subnetId"`
}

type CreateOrUpdateOperationResponse added in v0.20230906.1160501

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeleteOperationResponse added in v0.20230906.1160501

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type Direction

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

func (*Direction) UnmarshalJSON added in v0.20230725.1205316

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

type EndPoint

type EndPoint struct {
	EndPointName string   `json:"endPointName"`
	IPAddress    string   `json:"ipAddress"`
	Port         string   `json:"port"`
	Protocol     Protocol `json:"protocol"`
}

type GetOperationResponse added in v0.20230906.1160501

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ContactProfile
}

type ListBySubscriptionCompleteResult added in v0.20230906.1160501

type ListBySubscriptionCompleteResult struct {
	Items []ContactProfile
}

type ListBySubscriptionOperationResponse added in v0.20230906.1160501

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ContactProfile
}

type ListCompleteResult added in v0.20230906.1160501

type ListCompleteResult struct {
	Items []ContactProfile
}

type ListOperationResponse added in v0.20230906.1160501

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ContactProfile
}

type Polarization

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

func (*Polarization) UnmarshalJSON added in v0.20230725.1205316

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

type Protocol

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

func (*Protocol) UnmarshalJSON added in v0.20230725.1205316

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

type ProvisioningState

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

func (*ProvisioningState) UnmarshalJSON added in v0.20230725.1205316

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

type TagsObject

type TagsObject struct {
	Tags *map[string]string `json:"tags,omitempty"`
}

type UpdateTagsOperationResponse added in v0.20230906.1160501

type UpdateTagsOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

Jump to

Keyboard shortcuts

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