datanetwork

README

github.com/hashicorp/go-azure-sdk/resource-manager/mobilenetwork/2024-02-01/datanetwork Documentation

The datanetwork 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/datanetwork"

Client Initialization

client := datanetwork.NewDataNetworkClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DataNetworkClient.CreateOrUpdate

ctx := context.TODO()
id := datanetwork.NewDataNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mobileNetworkValue", "dataNetworkValue")

payload := datanetwork.DataNetwork{
	// ...
}


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

Example Usage: DataNetworkClient.Delete

ctx := context.TODO()
id := datanetwork.NewDataNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mobileNetworkValue", "dataNetworkValue")

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

Example Usage: DataNetworkClient.Get

ctx := context.TODO()
id := datanetwork.NewDataNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mobileNetworkValue", "dataNetworkValue")

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: DataNetworkClient.UpdateTags

ctx := context.TODO()
id := datanetwork.NewDataNetworkID("12345678-1234-9876-4563-123456789012", "example-resource-group", "mobileNetworkValue", "dataNetworkValue")

payload := datanetwork.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 PossibleValuesForProvisioningState() []string
• func ValidateDataNetworkID(input interface{}, key string) (warnings []string, errors []error)
• type CreateOrUpdateOperationResponse
• type DataNetwork
• type DataNetworkClient
  • func NewDataNetworkClientWithBaseURI(sdkApi sdkEnv.Api) (*DataNetworkClient, error)
  • func (c DataNetworkClient) CreateOrUpdate(ctx context.Context, id DataNetworkId, input DataNetwork) (result CreateOrUpdateOperationResponse, err error)
  • func (c DataNetworkClient) CreateOrUpdateThenPoll(ctx context.Context, id DataNetworkId, input DataNetwork) error
  • func (c DataNetworkClient) Delete(ctx context.Context, id DataNetworkId) (result DeleteOperationResponse, err error)
  • func (c DataNetworkClient) DeleteThenPoll(ctx context.Context, id DataNetworkId) error
  • func (c DataNetworkClient) Get(ctx context.Context, id DataNetworkId) (result GetOperationResponse, err error)
  • func (c DataNetworkClient) UpdateTags(ctx context.Context, id DataNetworkId, input TagsObject) (result UpdateTagsOperationResponse, err error)
• type DataNetworkId
  • func NewDataNetworkID(subscriptionId string, resourceGroupName string, mobileNetworkName string, ...) DataNetworkId
  • func ParseDataNetworkID(input string) (*DataNetworkId, error)
  • func ParseDataNetworkIDInsensitively(input string) (*DataNetworkId, error)
  • func (id *DataNetworkId) FromParseResult(input resourceids.ParseResult) error
  • func (id DataNetworkId) ID() string
  • func (id DataNetworkId) Segments() []resourceids.Segment
  • func (id DataNetworkId) String() string
• type DataNetworkPropertiesFormat
• type DeleteOperationResponse
• type GetOperationResponse
• type ProvisioningState
  • func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error
• type TagsObject
• type UpdateTagsOperationResponse

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func ValidateDataNetworkID

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

ValidateDataNetworkID checks that 'input' can be parsed as a Data Network ID

Types

type CreateOrUpdateOperationResponse

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

type DataNetwork

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

type DataNetworkClient

type DataNetworkClient struct {
	Client *resourcemanager.Client
}

func NewDataNetworkClientWithBaseURI

func NewDataNetworkClientWithBaseURI(sdkApi sdkEnv.Api) (*DataNetworkClient, error)

func (DataNetworkClient) CreateOrUpdate

func (c DataNetworkClient) CreateOrUpdate(ctx context.Context, id DataNetworkId, input DataNetwork) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DataNetworkClient) CreateOrUpdateThenPoll

func (c DataNetworkClient) CreateOrUpdateThenPoll(ctx context.Context, id DataNetworkId, input DataNetwork) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DataNetworkClient) Delete

func (c DataNetworkClient) Delete(ctx context.Context, id DataNetworkId) (result DeleteOperationResponse, err error)

Delete ...

func (DataNetworkClient) DeleteThenPoll

func (c DataNetworkClient) DeleteThenPoll(ctx context.Context, id DataNetworkId) error

DeleteThenPoll performs Delete then polls until it's completed

func (DataNetworkClient) Get

func (c DataNetworkClient) Get(ctx context.Context, id DataNetworkId) (result GetOperationResponse, err error)

Get ...

func (DataNetworkClient) UpdateTags

func (c DataNetworkClient) UpdateTags(ctx context.Context, id DataNetworkId, input TagsObject) (result UpdateTagsOperationResponse, err error)

UpdateTags ...

type DataNetworkId

type DataNetworkId struct {
	SubscriptionId    string
	ResourceGroupName string
	MobileNetworkName string
	DataNetworkName   string
}

DataNetworkId is a struct representing the Resource ID for a Data Network

func NewDataNetworkID

func NewDataNetworkID(subscriptionId string, resourceGroupName string, mobileNetworkName string, dataNetworkName string) DataNetworkId

NewDataNetworkID returns a new DataNetworkId struct

func ParseDataNetworkID

func ParseDataNetworkID(input string) (*DataNetworkId, error)

ParseDataNetworkID parses 'input' into a DataNetworkId

func ParseDataNetworkIDInsensitively

func ParseDataNetworkIDInsensitively(input string) (*DataNetworkId, error)

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

func (*DataNetworkId) FromParseResult

func (id *DataNetworkId) FromParseResult(input resourceids.ParseResult) error

func (DataNetworkId) ID

func (id DataNetworkId) ID() string

ID returns the formatted Data Network ID

func (DataNetworkId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Data Network ID

func (DataNetworkId) String

func (id DataNetworkId) String() string

String returns a human-readable description of this Data Network ID

type DataNetworkPropertiesFormat

type DataNetworkPropertiesFormat struct {
	Description       *string            `json:"description,omitempty"`
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
}

type DeleteOperationResponse

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

type GetOperationResponse

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

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 TagsObject

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

type UpdateTagsOperationResponse

type UpdateTagsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DataNetwork
}