contactprofile

package
v0.20230728.1130002 Latest Latest
Warning

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

 Go to latest Published: Jul 28, 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.ContactProfilesCreateOrUpdate

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

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


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

Example Usage: ContactProfileClient.ContactProfilesDelete

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

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

Example Usage: ContactProfileClient.ContactProfilesGet

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

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

Example Usage: ContactProfileClient.ContactProfilesList

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

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

Example Usage: ContactProfileClient.ContactProfilesListBySubscription

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

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

Example Usage: ContactProfileClient.ContactProfilesUpdateTags

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

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


if err := client.ContactProfilesUpdateTagsThenPoll(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(api environments.Api) (*ContactProfileClient, error)

func (ContactProfileClient) ContactProfilesCreateOrUpdate 

func (c ContactProfileClient) ContactProfilesCreateOrUpdate(ctx context.Context, id ContactProfileId, input ContactProfile) (result ContactProfilesCreateOrUpdateOperationResponse, err error)

ContactProfilesCreateOrUpdate ...

func (ContactProfileClient) ContactProfilesCreateOrUpdateThenPoll 

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

ContactProfilesCreateOrUpdateThenPoll performs ContactProfilesCreateOrUpdate then polls until it's completed

func (ContactProfileClient) ContactProfilesDelete 

func (c ContactProfileClient) ContactProfilesDelete(ctx context.Context, id ContactProfileId) (result ContactProfilesDeleteOperationResponse, err error)

ContactProfilesDelete ...

func (ContactProfileClient) ContactProfilesDeleteThenPoll 

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

ContactProfilesDeleteThenPoll performs ContactProfilesDelete then polls until it's completed

func (ContactProfileClient) ContactProfilesGet 

func (c ContactProfileClient) ContactProfilesGet(ctx context.Context, id ContactProfileId) (result ContactProfilesGetOperationResponse, err error)

ContactProfilesGet ...

func (ContactProfileClient) ContactProfilesList 

func (c ContactProfileClient) ContactProfilesList(ctx context.Context, id commonids.ResourceGroupId) (result ContactProfilesListOperationResponse, err error)

ContactProfilesList ...

func (ContactProfileClient) ContactProfilesListBySubscription 

func (c ContactProfileClient) ContactProfilesListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ContactProfilesListBySubscriptionOperationResponse, err error)

ContactProfilesListBySubscription ...

func (ContactProfileClient) ContactProfilesListBySubscriptionComplete 

func (c ContactProfileClient) ContactProfilesListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ContactProfilesListBySubscriptionCompleteResult, error)

ContactProfilesListBySubscriptionComplete retrieves all the results into a single object

func (ContactProfileClient) ContactProfilesListBySubscriptionCompleteMatchingPredicate 

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

ContactProfilesListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ContactProfileClient) ContactProfilesListComplete 

func (c ContactProfileClient) ContactProfilesListComplete(ctx context.Context, id commonids.ResourceGroupId) (ContactProfilesListCompleteResult, error)

ContactProfilesListComplete retrieves all the results into a single object

func (ContactProfileClient) ContactProfilesListCompleteMatchingPredicate 

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

ContactProfilesListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (ContactProfileClient) ContactProfilesUpdateTags 

func (c ContactProfileClient) ContactProfilesUpdateTags(ctx context.Context, id ContactProfileId, input TagsObject) (result ContactProfilesUpdateTagsOperationResponse, err error)

ContactProfilesUpdateTags ...

func (ContactProfileClient) ContactProfilesUpdateTagsThenPoll 

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

ContactProfilesUpdateTagsThenPoll performs ContactProfilesUpdateTags 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 

func (p ContactProfileOperationPredicate) Matches(input ContactProfile) bool

type ContactProfileThirdPartyConfiguration 

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

type ContactProfilesCreateOrUpdateOperationResponse 

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

type ContactProfilesDeleteOperationResponse 

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

type ContactProfilesGetOperationResponse 

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

type ContactProfilesListBySubscriptionCompleteResult 

type ContactProfilesListBySubscriptionCompleteResult struct {
	Items []ContactProfile
}

type ContactProfilesListBySubscriptionOperationResponse 

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

type ContactProfilesListCompleteResult 

type ContactProfilesListCompleteResult struct {
	Items []ContactProfile
}

type ContactProfilesListOperationResponse 

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

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 ContactProfilesUpdateTagsOperationResponse 

type ContactProfilesUpdateTagsOperationResponse 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 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"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

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