README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/mobilenetwork/2024-02-01/service
Documentation
The service
SDK allows for interaction with the Azure Resource Manager Service mobilenetwork
(API Version 2024-02-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/mobilenetwork/2024-02-01/service"
Client Initialization
client := service.NewServiceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: ServiceClient.CreateOrUpdate
ctx := context.TODO()
id := service.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mobileNetworkValue", "serviceValue")
payload := service.Service{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: ServiceClient.Delete
ctx := context.TODO()
id := service.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mobileNetworkValue", "serviceValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: ServiceClient.Get
ctx := context.TODO()
id := service.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mobileNetworkValue", "serviceValue")
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: ServiceClient.UpdateTags
ctx := context.TODO()
id := service.NewServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mobileNetworkValue", "serviceValue")
payload := service.TagsObject{
// ...
}
read, err := client.UpdateTags(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation ¶
Index ¶
- func PossibleValuesForPreemptionCapability() []string
- func PossibleValuesForPreemptionVulnerability() []string
- func PossibleValuesForProvisioningState() []string
- func PossibleValuesForSdfDirection() []string
- func PossibleValuesForTrafficControlPermission() []string
- func ValidateServiceID(input interface{}, key string) (warnings []string, errors []error)
- type Ambr
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type PccRuleConfiguration
- type PccRuleQosPolicy
- type PreemptionCapability
- type PreemptionVulnerability
- type ProvisioningState
- type QosPolicy
- type SdfDirection
- type Service
- type ServiceClient
- func (c ServiceClient) CreateOrUpdate(ctx context.Context, id ServiceId, input Service) (result CreateOrUpdateOperationResponse, err error)
- func (c ServiceClient) CreateOrUpdateThenPoll(ctx context.Context, id ServiceId, input Service) error
- func (c ServiceClient) Delete(ctx context.Context, id ServiceId) (result DeleteOperationResponse, err error)
- func (c ServiceClient) DeleteThenPoll(ctx context.Context, id ServiceId) error
- func (c ServiceClient) Get(ctx context.Context, id ServiceId) (result GetOperationResponse, err error)
- func (c ServiceClient) UpdateTags(ctx context.Context, id ServiceId, input TagsObject) (result UpdateTagsOperationResponse, err error)
- type ServiceDataFlowTemplate
- type ServiceId
- type ServicePropertiesFormat
- type TagsObject
- type TrafficControlPermission
- type UpdateTagsOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForPreemptionCapability ¶
func PossibleValuesForPreemptionCapability() []string
func PossibleValuesForPreemptionVulnerability ¶
func PossibleValuesForPreemptionVulnerability() []string
func PossibleValuesForProvisioningState ¶
func PossibleValuesForProvisioningState() []string
func PossibleValuesForSdfDirection ¶
func PossibleValuesForSdfDirection() []string
func PossibleValuesForTrafficControlPermission ¶
func PossibleValuesForTrafficControlPermission() []string
func ValidateServiceID ¶
ValidateServiceID checks that 'input' can be parsed as a Service ID
Types ¶
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type PccRuleConfiguration ¶
type PccRuleConfiguration struct { RuleName string `json:"ruleName"` RulePrecedence int64 `json:"rulePrecedence"` RuleQosPolicy *PccRuleQosPolicy `json:"ruleQosPolicy,omitempty"` ServiceDataFlowTemplates []ServiceDataFlowTemplate `json:"serviceDataFlowTemplates"` TrafficControl *TrafficControlPermission `json:"trafficControl,omitempty"` }
type PccRuleQosPolicy ¶
type PccRuleQosPolicy struct { AllocationAndRetentionPriorityLevel *int64 `json:"allocationAndRetentionPriorityLevel,omitempty"` Fiveqi *int64 `json:"5qi,omitempty"` GuaranteedBitRate *Ambr `json:"guaranteedBitRate,omitempty"` MaximumBitRate Ambr `json:"maximumBitRate"` PreemptionCapability *PreemptionCapability `json:"preemptionCapability,omitempty"` PreemptionVulnerability *PreemptionVulnerability `json:"preemptionVulnerability,omitempty"` }
type PreemptionCapability ¶
type PreemptionCapability string
const ( PreemptionCapabilityMayPreempt PreemptionCapability = "MayPreempt" PreemptionCapabilityNotPreempt PreemptionCapability = "NotPreempt" )
func (*PreemptionCapability) UnmarshalJSON ¶
func (s *PreemptionCapability) UnmarshalJSON(bytes []byte) error
type PreemptionVulnerability ¶
type PreemptionVulnerability string
const ( PreemptionVulnerabilityNotPreemptable PreemptionVulnerability = "NotPreemptable" PreemptionVulnerabilityPreemptable PreemptionVulnerability = "Preemptable" )
func (*PreemptionVulnerability) UnmarshalJSON ¶
func (s *PreemptionVulnerability) UnmarshalJSON(bytes []byte) error
type ProvisioningState ¶
type ProvisioningState string
const ( ProvisioningStateAccepted ProvisioningState = "Accepted" ProvisioningStateCanceled ProvisioningState = "Canceled" ProvisioningStateDeleted ProvisioningState = "Deleted" ProvisioningStateDeleting ProvisioningState = "Deleting" ProvisioningStateFailed ProvisioningState = "Failed" ProvisioningStateSucceeded ProvisioningState = "Succeeded" ProvisioningStateUnknown ProvisioningState = "Unknown" )
func (*ProvisioningState) UnmarshalJSON ¶
func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
type QosPolicy ¶
type QosPolicy struct { AllocationAndRetentionPriorityLevel *int64 `json:"allocationAndRetentionPriorityLevel,omitempty"` Fiveqi *int64 `json:"5qi,omitempty"` MaximumBitRate Ambr `json:"maximumBitRate"` PreemptionCapability *PreemptionCapability `json:"preemptionCapability,omitempty"` PreemptionVulnerability *PreemptionVulnerability `json:"preemptionVulnerability,omitempty"` }
type SdfDirection ¶
type SdfDirection string
const ( SdfDirectionBidirectional SdfDirection = "Bidirectional" SdfDirectionDownlink SdfDirection = "Downlink" SdfDirectionUplink SdfDirection = "Uplink" )
func (*SdfDirection) UnmarshalJSON ¶
func (s *SdfDirection) UnmarshalJSON(bytes []byte) error
type Service ¶
type Service struct { Id *string `json:"id,omitempty"` Location string `json:"location"` Name *string `json:"name,omitempty"` Properties ServicePropertiesFormat `json:"properties"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type ServiceClient ¶
type ServiceClient struct {
Client *resourcemanager.Client
}
func NewServiceClientWithBaseURI ¶
func NewServiceClientWithBaseURI(sdkApi sdkEnv.Api) (*ServiceClient, error)
func (ServiceClient) CreateOrUpdate ¶
func (c ServiceClient) CreateOrUpdate(ctx context.Context, id ServiceId, input Service) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (ServiceClient) CreateOrUpdateThenPoll ¶
func (c ServiceClient) CreateOrUpdateThenPoll(ctx context.Context, id ServiceId, input Service) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (ServiceClient) Delete ¶
func (c ServiceClient) Delete(ctx context.Context, id ServiceId) (result DeleteOperationResponse, err error)
Delete ...
func (ServiceClient) DeleteThenPoll ¶
func (c ServiceClient) DeleteThenPoll(ctx context.Context, id ServiceId) error
DeleteThenPoll performs Delete then polls until it's completed
func (ServiceClient) Get ¶
func (c ServiceClient) Get(ctx context.Context, id ServiceId) (result GetOperationResponse, err error)
Get ...
func (ServiceClient) UpdateTags ¶
func (c ServiceClient) UpdateTags(ctx context.Context, id ServiceId, input TagsObject) (result UpdateTagsOperationResponse, err error)
UpdateTags ...
type ServiceDataFlowTemplate ¶
type ServiceDataFlowTemplate struct { Direction SdfDirection `json:"direction"` Ports *[]string `json:"ports,omitempty"` Protocol []string `json:"protocol"` RemoteIPList []string `json:"remoteIpList"` TemplateName string `json:"templateName"` }
type ServiceId ¶
type ServiceId struct { SubscriptionId string ResourceGroupName string MobileNetworkName string ServiceName string }
ServiceId is a struct representing the Resource ID for a Service
func NewServiceID ¶
func NewServiceID(subscriptionId string, resourceGroupName string, mobileNetworkName string, serviceName string) ServiceId
NewServiceID returns a new ServiceId struct
func ParseServiceID ¶
ParseServiceID parses 'input' into a ServiceId
func ParseServiceIDInsensitively ¶
ParseServiceIDInsensitively parses 'input' case-insensitively into a ServiceId note: this method should only be used for API response data and not user input
func (*ServiceId) FromParseResult ¶
func (id *ServiceId) FromParseResult(input resourceids.ParseResult) error
func (ServiceId) Segments ¶
func (id ServiceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Service ID
type ServicePropertiesFormat ¶
type ServicePropertiesFormat struct { PccRules []PccRuleConfiguration `json:"pccRules"` ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"` ServicePrecedence int64 `json:"servicePrecedence"` ServiceQosPolicy *QosPolicy `json:"serviceQosPolicy,omitempty"` }
type TagsObject ¶
type TrafficControlPermission ¶
type TrafficControlPermission string
const ( TrafficControlPermissionBlocked TrafficControlPermission = "Blocked" TrafficControlPermissionEnabled TrafficControlPermission = "Enabled" )
func (*TrafficControlPermission) UnmarshalJSON ¶
func (s *TrafficControlPermission) UnmarshalJSON(bytes []byte) error
Source Files ¶
- client.go
- constants.go
- id_service.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_updatetags.go
- model_ambr.go
- model_pccruleconfiguration.go
- model_pccruleqospolicy.go
- model_qospolicy.go
- model_service.go
- model_servicedataflowtemplate.go
- model_servicepropertiesformat.go
- model_tagsobject.go
- version.go