armmobilenetwork

package module
v0.6.0 Latest Latest
Warning

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

Go to latest
Published: Aug 1, 2022 License: MIT Imports: 16 Imported by: 3

README

Azure Private 5G Core Module for Go

PkgGoDev

The armmobilenetwork module provides operations for working with Azure Private 5G Core.

Source code

Getting started

Prerequisites

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Private 5G Core module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Private 5G Core. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Clients

Azure Private 5G Core modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

client, err := armmobilenetwork.NewSlicesClient(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
client := armmobilenetwork.NewSlicesClient(<subscription ID>, cred, &options)

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Private 5G Core label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Ambr

type Ambr struct {
	// REQUIRED; Downlink bit rate.
	Downlink *string `json:"downlink,omitempty"`

	// REQUIRED; Uplink bit rate.
	Uplink *string `json:"uplink,omitempty"`
}

Ambr - Aggregate maximum bit rate.

func (Ambr) MarshalJSON added in v0.6.0

func (a Ambr) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Ambr.

func (*Ambr) UnmarshalJSON added in v0.6.0

func (a *Ambr) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Ambr.

type Arp added in v0.3.0

type Arp struct {
	// REQUIRED; ARP preemption capability.
	PreemptCap *PreemptionCapability `json:"preemptCap,omitempty"`

	// REQUIRED; ARP preemption vulnerability
	PreemptVuln *PreemptionVulnerability `json:"preemptVuln,omitempty"`

	// REQUIRED; ARP priority level.
	PriorityLevel *int32 `json:"priorityLevel,omitempty"`
}

Arp - Allocation and Retention Priority (ARP) parameters.

func (Arp) MarshalJSON added in v0.6.0

func (a Arp) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Arp.

func (*Arp) UnmarshalJSON added in v0.6.0

func (a *Arp) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Arp.

type AttachedDataNetwork

type AttachedDataNetwork struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// REQUIRED; Data network properties.
	Properties *AttachedDataNetworkPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

AttachedDataNetwork - Attached data network resource.

func (AttachedDataNetwork) MarshalJSON

func (a AttachedDataNetwork) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AttachedDataNetwork.

func (*AttachedDataNetwork) UnmarshalJSON added in v0.6.0

func (a *AttachedDataNetwork) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AttachedDataNetwork.

type AttachedDataNetworkListResult

type AttachedDataNetworkListResult struct {
	// A list of data networks in a resource group.
	Value []*AttachedDataNetwork `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

AttachedDataNetworkListResult - Response for attached data network API service call.

func (AttachedDataNetworkListResult) MarshalJSON

func (a AttachedDataNetworkListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AttachedDataNetworkListResult.

func (*AttachedDataNetworkListResult) UnmarshalJSON added in v0.6.0

func (a *AttachedDataNetworkListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AttachedDataNetworkListResult.

type AttachedDataNetworkPropertiesFormat

type AttachedDataNetworkPropertiesFormat struct {
	// REQUIRED; The user plane interface on the data network. For 5G networks, this is the N6 interface. For 4G networks, this
	// is the SGi interface.
	UserPlaneDataInterface *InterfaceProperties `json:"userPlaneDataInterface,omitempty"`

	// The DNS servers to signal to UEs to use for this attached data network.
	DNSAddresses []*string `json:"dnsAddresses,omitempty"`

	// The network address and port translation (NAPT) configuration. If this is not specified, the attached data network will
	// use a default NAPT configuration with NAPT enabled.
	NaptConfiguration *NaptConfiguration `json:"naptConfiguration,omitempty"`

	// The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will dynamically
	// assign IP addresses to UEs. The packet core instance assigns an IP
	// address to a UE when the UE sets up a PDU session. You must define at least one of userEquipmentAddressPoolPrefix and userEquipmentStaticAddressPoolPrefix.
	// If you define both, they must be of the same
	// size.
	UserEquipmentAddressPoolPrefix []*string `json:"userEquipmentAddressPoolPrefix,omitempty"`

	// The user equipment (UE) address pool prefixes for the attached data network from which the packet core instance will assign
	// static IP addresses to UEs. The packet core instance assigns an IP address
	// to a UE when the UE sets up a PDU session. The static IP address for a specific UE is set in StaticIPConfiguration on the
	// corresponding SIM resource. At least one of userEquipmentAddressPoolPrefix and
	// userEquipmentStaticAddressPoolPrefix must be defined. If both are defined, they must be of the same size.
	UserEquipmentStaticAddressPoolPrefix []*string `json:"userEquipmentStaticAddressPoolPrefix,omitempty"`

	// READ-ONLY; The provisioning state of the attached data network resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

AttachedDataNetworkPropertiesFormat - Data network properties.

func (AttachedDataNetworkPropertiesFormat) MarshalJSON

func (a AttachedDataNetworkPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AttachedDataNetworkPropertiesFormat.

func (*AttachedDataNetworkPropertiesFormat) UnmarshalJSON added in v0.6.0

func (a *AttachedDataNetworkPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AttachedDataNetworkPropertiesFormat.

type AttachedDataNetworkResourceID

type AttachedDataNetworkResourceID struct {
	// REQUIRED; Attached data network resource ID.
	ID *string `json:"id,omitempty"`
}

AttachedDataNetworkResourceID - Reference to an attached data network resource.

func (AttachedDataNetworkResourceID) MarshalJSON added in v0.6.0

func (a AttachedDataNetworkResourceID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AttachedDataNetworkResourceID.

func (*AttachedDataNetworkResourceID) UnmarshalJSON added in v0.6.0

func (a *AttachedDataNetworkResourceID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AttachedDataNetworkResourceID.

type AttachedDataNetworksClient

type AttachedDataNetworksClient struct {
	// contains filtered or unexported fields
}

AttachedDataNetworksClient contains the methods for the AttachedDataNetworks group. Don't use this type directly, use NewAttachedDataNetworksClient() instead.

func NewAttachedDataNetworksClient

func NewAttachedDataNetworksClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*AttachedDataNetworksClient, error)

NewAttachedDataNetworksClient creates a new instance of AttachedDataNetworksClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*AttachedDataNetworksClient) BeginCreateOrUpdate

func (client *AttachedDataNetworksClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, packetCoreControlPlaneName string, packetCoreDataPlaneName string, attachedDataNetworkName string, parameters AttachedDataNetwork, options *AttachedDataNetworksClientBeginCreateOrUpdateOptions) (*runtime.Poller[AttachedDataNetworksClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates an attached data network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. packetCoreDataPlaneName - The name of the packet core data plane. attachedDataNetworkName - The name of the attached data network. parameters - Parameters supplied to the create or update attached data network operation. options - AttachedDataNetworksClientBeginCreateOrUpdateOptions contains the optional parameters for the AttachedDataNetworksClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/AttachedDataNetworkCreate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewAttachedDataNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"TestPacketCoreCP",
		"TestPacketCoreDP",
		"TestAttachedDataNetwork",
		armmobilenetwork.AttachedDataNetwork{
			Location: to.Ptr("eastus"),
			Properties: &armmobilenetwork.AttachedDataNetworkPropertiesFormat{
				DNSAddresses: []*string{
					to.Ptr("1.1.1.1")},
				NaptConfiguration: &armmobilenetwork.NaptConfiguration{
					Enabled:       to.Ptr(armmobilenetwork.NaptEnabledEnabled),
					PinholeLimits: to.Ptr[int32](65536),
					PinholeTimeouts: &armmobilenetwork.PinholeTimeouts{
						Icmp: to.Ptr[int32](30),
						TCP:  to.Ptr[int32](180),
						UDP:  to.Ptr[int32](30),
					},
					PortRange: &armmobilenetwork.PortRange{
						MaxPort: to.Ptr[int32](49999),
						MinPort: to.Ptr[int32](1024),
					},
					PortReuseHoldTime: &armmobilenetwork.PortReuseHoldTimes{
						TCP: to.Ptr[int32](120),
						UDP: to.Ptr[int32](60),
					},
				},
				UserEquipmentAddressPoolPrefix: []*string{
					to.Ptr("2.2.0.0/16")},
				UserEquipmentStaticAddressPoolPrefix: []*string{
					to.Ptr("2.4.0.0/16")},
				UserPlaneDataInterface: &armmobilenetwork.InterfaceProperties{
					Name: to.Ptr("N6"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*AttachedDataNetworksClient) BeginDelete

func (client *AttachedDataNetworksClient) BeginDelete(ctx context.Context, resourceGroupName string, packetCoreControlPlaneName string, packetCoreDataPlaneName string, attachedDataNetworkName string, options *AttachedDataNetworksClientBeginDeleteOptions) (*runtime.Poller[AttachedDataNetworksClientDeleteResponse], error)

BeginDelete - Deletes the specified attached data network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. packetCoreDataPlaneName - The name of the packet core data plane. attachedDataNetworkName - The name of the attached data network. options - AttachedDataNetworksClientBeginDeleteOptions contains the optional parameters for the AttachedDataNetworksClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/AttachedDataNetworkDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewAttachedDataNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"rg1",
		"TestPacketCoreCP",
		"TestPacketCoreDP",
		"TestAttachedDataNetwork",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*AttachedDataNetworksClient) Get

func (client *AttachedDataNetworksClient) Get(ctx context.Context, resourceGroupName string, packetCoreControlPlaneName string, packetCoreDataPlaneName string, attachedDataNetworkName string, options *AttachedDataNetworksClientGetOptions) (AttachedDataNetworksClientGetResponse, error)

Get - Gets information about the specified attached data network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. packetCoreDataPlaneName - The name of the packet core data plane. attachedDataNetworkName - The name of the attached data network. options - AttachedDataNetworksClientGetOptions contains the optional parameters for the AttachedDataNetworksClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/AttachedDataNetworkGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewAttachedDataNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"TestPacketCoreCP",
		"TestPacketCoreDP",
		"TestAttachedDataNetwork",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*AttachedDataNetworksClient) NewListByPacketCoreDataPlanePager added in v0.4.0

func (client *AttachedDataNetworksClient) NewListByPacketCoreDataPlanePager(resourceGroupName string, packetCoreControlPlaneName string, packetCoreDataPlaneName string, options *AttachedDataNetworksClientListByPacketCoreDataPlaneOptions) *runtime.Pager[AttachedDataNetworksClientListByPacketCoreDataPlaneResponse]

NewListByPacketCoreDataPlanePager - Gets all the attached data networks associated with a packet core data plane. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. packetCoreDataPlaneName - The name of the packet core data plane. options - AttachedDataNetworksClientListByPacketCoreDataPlaneOptions contains the optional parameters for the AttachedDataNetworksClient.ListByPacketCoreDataPlane method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/AttachedDataNetworkListByPacketCoreDataPlane.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewAttachedDataNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByPacketCoreDataPlanePager("rg1",
		"TestPacketCoreCP",
		"TestPacketCoreDP",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*AttachedDataNetworksClient) UpdateTags

func (client *AttachedDataNetworksClient) UpdateTags(ctx context.Context, resourceGroupName string, packetCoreControlPlaneName string, packetCoreDataPlaneName string, attachedDataNetworkName string, parameters TagsObject, options *AttachedDataNetworksClientUpdateTagsOptions) (AttachedDataNetworksClientUpdateTagsResponse, error)

UpdateTags - Updates an attached data network tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. packetCoreDataPlaneName - The name of the packet core data plane. attachedDataNetworkName - The name of the attached data network. parameters - Parameters supplied to update attached data network tags. options - AttachedDataNetworksClientUpdateTagsOptions contains the optional parameters for the AttachedDataNetworksClient.UpdateTags method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/AttachedDataNetworkUpdateTags.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewAttachedDataNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.UpdateTags(ctx,
		"rg1",
		"TestPacketCoreCP",
		"TestPacketCoreDP",
		"TestAttachedDataNetwork",
		armmobilenetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type AttachedDataNetworksClientBeginCreateOrUpdateOptions

type AttachedDataNetworksClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AttachedDataNetworksClientBeginCreateOrUpdateOptions contains the optional parameters for the AttachedDataNetworksClient.BeginCreateOrUpdate method.

type AttachedDataNetworksClientBeginDeleteOptions

type AttachedDataNetworksClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

AttachedDataNetworksClientBeginDeleteOptions contains the optional parameters for the AttachedDataNetworksClient.BeginDelete method.

type AttachedDataNetworksClientCreateOrUpdateResponse

type AttachedDataNetworksClientCreateOrUpdateResponse struct {
	AttachedDataNetwork
}

AttachedDataNetworksClientCreateOrUpdateResponse contains the response from method AttachedDataNetworksClient.CreateOrUpdate.

type AttachedDataNetworksClientDeleteResponse

type AttachedDataNetworksClientDeleteResponse struct {
}

AttachedDataNetworksClientDeleteResponse contains the response from method AttachedDataNetworksClient.Delete.

type AttachedDataNetworksClientGetOptions

type AttachedDataNetworksClientGetOptions struct {
}

AttachedDataNetworksClientGetOptions contains the optional parameters for the AttachedDataNetworksClient.Get method.

type AttachedDataNetworksClientGetResponse

type AttachedDataNetworksClientGetResponse struct {
	AttachedDataNetwork
}

AttachedDataNetworksClientGetResponse contains the response from method AttachedDataNetworksClient.Get.

type AttachedDataNetworksClientListByPacketCoreDataPlaneOptions

type AttachedDataNetworksClientListByPacketCoreDataPlaneOptions struct {
}

AttachedDataNetworksClientListByPacketCoreDataPlaneOptions contains the optional parameters for the AttachedDataNetworksClient.ListByPacketCoreDataPlane method.

type AttachedDataNetworksClientListByPacketCoreDataPlaneResponse

type AttachedDataNetworksClientListByPacketCoreDataPlaneResponse struct {
	AttachedDataNetworkListResult
}

AttachedDataNetworksClientListByPacketCoreDataPlaneResponse contains the response from method AttachedDataNetworksClient.ListByPacketCoreDataPlane.

type AttachedDataNetworksClientUpdateTagsOptions

type AttachedDataNetworksClientUpdateTagsOptions struct {
}

AttachedDataNetworksClientUpdateTagsOptions contains the optional parameters for the AttachedDataNetworksClient.UpdateTags method.

type AttachedDataNetworksClientUpdateTagsResponse

type AttachedDataNetworksClientUpdateTagsResponse struct {
	AttachedDataNetwork
}

AttachedDataNetworksClientUpdateTagsResponse contains the response from method AttachedDataNetworksClient.UpdateTags.

type AzureStackEdgeDeviceResourceID added in v0.6.0

type AzureStackEdgeDeviceResourceID struct {
	// REQUIRED; Azure Stack Edge device resource ID.
	ID *string `json:"id,omitempty"`
}

AzureStackEdgeDeviceResourceID - Reference to an Azure Arc custom location resource.

func (AzureStackEdgeDeviceResourceID) MarshalJSON added in v0.6.0

func (a AzureStackEdgeDeviceResourceID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureStackEdgeDeviceResourceID.

func (*AzureStackEdgeDeviceResourceID) UnmarshalJSON added in v0.6.0

func (a *AzureStackEdgeDeviceResourceID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureStackEdgeDeviceResourceID.

type BillingSKU added in v0.6.0

type BillingSKU string

BillingSKU - The SKU of the packet core control plane resource. The SKU list may change over time when a new SKU gets added or an exiting SKU gets removed.

const (
	// BillingSKUEdgeSite2GBPS - Edge site 2Gbps plan
	BillingSKUEdgeSite2GBPS BillingSKU = "EdgeSite2GBPS"
	// BillingSKUEdgeSite3GBPS - Edge site 3Gbps plan
	BillingSKUEdgeSite3GBPS BillingSKU = "EdgeSite3GBPS"
	// BillingSKUEdgeSite4GBPS - Edge site 4Gbps plan
	BillingSKUEdgeSite4GBPS BillingSKU = "EdgeSite4GBPS"
	// BillingSKUEvaluationPackage - Evaluation package plan
	BillingSKUEvaluationPackage BillingSKU = "EvaluationPackage"
	// BillingSKUFlagshipStarterPackage - Flagship starter package plan
	BillingSKUFlagshipStarterPackage BillingSKU = "FlagshipStarterPackage"
	// BillingSKULargePackage - Large package plan
	BillingSKULargePackage BillingSKU = "LargePackage"
	// BillingSKUMediumPackage - Medium package plan
	BillingSKUMediumPackage BillingSKU = "MediumPackage"
)

func PossibleBillingSKUValues added in v0.6.0

func PossibleBillingSKUValues() []BillingSKU

PossibleBillingSKUValues returns the possible values for the BillingSKU const type.

type ConnectedClusterResourceID added in v0.6.0

type ConnectedClusterResourceID struct {
	// REQUIRED; Azure Arc connected cluster resource ID.
	ID *string `json:"id,omitempty"`
}

ConnectedClusterResourceID - Reference to an Azure Arc custom location resource.

func (ConnectedClusterResourceID) MarshalJSON added in v0.6.0

func (c ConnectedClusterResourceID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectedClusterResourceID.

func (*ConnectedClusterResourceID) UnmarshalJSON added in v0.6.0

func (c *ConnectedClusterResourceID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectedClusterResourceID.

type CoreNetworkType

type CoreNetworkType string

CoreNetworkType - The core network technology generation (5G core or EPC / 4G core).

const (
	// CoreNetworkTypeEPC - EPC / 4G core
	CoreNetworkTypeEPC CoreNetworkType = "EPC"
	// CoreNetworkTypeFiveGC - 5G core
	CoreNetworkTypeFiveGC CoreNetworkType = "5GC"
)

func PossibleCoreNetworkTypeValues

func PossibleCoreNetworkTypeValues() []CoreNetworkType

PossibleCoreNetworkTypeValues returns the possible values for the CoreNetworkType const type.

type CreatedByType

type CreatedByType string

CreatedByType - The type of identity that created the resource.

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type CustomLocationResourceID

type CustomLocationResourceID struct {
	// REQUIRED; Azure Arc custom location resource ID.
	ID *string `json:"id,omitempty"`
}

CustomLocationResourceID - Reference to an Azure Arc custom location resource.

func (CustomLocationResourceID) MarshalJSON added in v0.6.0

func (c CustomLocationResourceID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CustomLocationResourceID.

func (*CustomLocationResourceID) UnmarshalJSON added in v0.6.0

func (c *CustomLocationResourceID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CustomLocationResourceID.

type DataNetwork

type DataNetwork struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Data network properties.
	Properties *DataNetworkPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

DataNetwork - Data network resource.

func (DataNetwork) MarshalJSON

func (d DataNetwork) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataNetwork.

func (*DataNetwork) UnmarshalJSON added in v0.6.0

func (d *DataNetwork) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataNetwork.

type DataNetworkConfiguration

type DataNetworkConfiguration struct {
	// REQUIRED; List of services that can be used as part of this SIM policy. The list must not contain duplicate items and must
	// contain at least one item.
	AllowedServices []*ServiceResourceID `json:"allowedServices,omitempty"`

	// REQUIRED; A reference to the data network that these settings apply to
	DataNetwork *DataNetworkResourceID `json:"dataNetwork,omitempty"`

	// REQUIRED; Aggregate maximum bit rate across all non-GBR QoS flows of a given PDU session. See 3GPP TS23.501 section 5.7.2.6
	// for a full description of the Session-AMBR.
	SessionAmbr *Ambr `json:"sessionAmbr,omitempty"`

	// Allowed session types in addition to the default session type. Must not duplicate the default session type.
	AdditionalAllowedSessionTypes []*PduSessionType `json:"additionalAllowedSessionTypes,omitempty"`

	// Default QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority,
	// if the settings of preemptionCapability and preemptionVulnerability allow
	// it. 1 is the highest level of priority. If this field is not specified then 5qi is used to derive the ARP value. See 3GPP
	// TS23.501 section 5.7.2.2 for a full description of the ARP parameters.
	AllocationAndRetentionPriorityLevel *int32 `json:"allocationAndRetentionPriorityLevel,omitempty"`

	// The default PDU session type, which is used if the UE does not request a specific session type.
	DefaultSessionType *PduSessionType `json:"defaultSessionType,omitempty"`

	// Default QoS Flow 5G QoS Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow.
	// This must not be a standardized 5QI value corresponding to a GBR (guaranteed
	// bit rate) QoS Flow. The illegal GBR 5QI values are: 1, 2, 3, 4, 65, 66, 67, 71, 72, 73, 74, 75, 76, 82, 83, 84, and 85.
	// See 3GPP TS23.501 section 5.7.2.1 for a full description of the 5QI parameter,
	// and table 5.7.4-1 for the definition of which are the GBR 5QI values.
	FiveQi *int32 `json:"5qi,omitempty"`

	// Default QoS Flow preemption capability. The preemption capability of a QoS Flow controls whether it can preempt another
	// QoS Flow with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a
	// full description of the ARP parameters.
	PreemptionCapability *PreemptionCapability `json:"preemptionCapability,omitempty"`

	// Default QoS Flow preemption vulnerability. The preemption vulnerability of a QoS Flow controls whether it can be preempted
	// by a QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2
	// for a full description of the ARP parameters.
	PreemptionVulnerability *PreemptionVulnerability `json:"preemptionVulnerability,omitempty"`
}

DataNetworkConfiguration - Settings controlling data network use

func (DataNetworkConfiguration) MarshalJSON

func (d DataNetworkConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataNetworkConfiguration.

func (*DataNetworkConfiguration) UnmarshalJSON added in v0.6.0

func (d *DataNetworkConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataNetworkConfiguration.

type DataNetworkListResult

type DataNetworkListResult struct {
	// A list of data networks.
	Value []*DataNetwork `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

DataNetworkListResult - Response for data network API service call.

func (DataNetworkListResult) MarshalJSON

func (d DataNetworkListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataNetworkListResult.

func (*DataNetworkListResult) UnmarshalJSON added in v0.6.0

func (d *DataNetworkListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataNetworkListResult.

type DataNetworkPropertiesFormat

type DataNetworkPropertiesFormat struct {
	// An optional description for this data network.
	Description *string `json:"description,omitempty"`

	// READ-ONLY; The provisioning state of the data network resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

DataNetworkPropertiesFormat - Data network properties.

func (DataNetworkPropertiesFormat) MarshalJSON added in v0.6.0

func (d DataNetworkPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataNetworkPropertiesFormat.

func (*DataNetworkPropertiesFormat) UnmarshalJSON added in v0.6.0

func (d *DataNetworkPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataNetworkPropertiesFormat.

type DataNetworkResourceID

type DataNetworkResourceID struct {
	// REQUIRED; Data network resource ID.
	ID *string `json:"id,omitempty"`
}

DataNetworkResourceID - Reference to a data network resource.

func (DataNetworkResourceID) MarshalJSON added in v0.6.0

func (d DataNetworkResourceID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DataNetworkResourceID.

func (*DataNetworkResourceID) UnmarshalJSON added in v0.6.0

func (d *DataNetworkResourceID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DataNetworkResourceID.

type DataNetworksClient

type DataNetworksClient struct {
	// contains filtered or unexported fields
}

DataNetworksClient contains the methods for the DataNetworks group. Don't use this type directly, use NewDataNetworksClient() instead.

func NewDataNetworksClient

func NewDataNetworksClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*DataNetworksClient, error)

NewDataNetworksClient creates a new instance of DataNetworksClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*DataNetworksClient) BeginCreateOrUpdate

func (client *DataNetworksClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, mobileNetworkName string, dataNetworkName string, parameters DataNetwork, options *DataNetworksClientBeginCreateOrUpdateOptions) (*runtime.Poller[DataNetworksClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a data network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. dataNetworkName - The name of the data network. parameters - Parameters supplied to the create or update data network operation. options - DataNetworksClientBeginCreateOrUpdateOptions contains the optional parameters for the DataNetworksClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/DataNetworkCreate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewDataNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"testMobileNetwork",
		"testDataNetwork",
		armmobilenetwork.DataNetwork{
			Location: to.Ptr("eastus"),
			Properties: &armmobilenetwork.DataNetworkPropertiesFormat{
				Description: to.Ptr("myFavouriteDataNetwork"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*DataNetworksClient) BeginDelete

func (client *DataNetworksClient) BeginDelete(ctx context.Context, resourceGroupName string, mobileNetworkName string, dataNetworkName string, options *DataNetworksClientBeginDeleteOptions) (*runtime.Poller[DataNetworksClientDeleteResponse], error)

BeginDelete - Deletes the specified data network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. dataNetworkName - The name of the data network. options - DataNetworksClientBeginDeleteOptions contains the optional parameters for the DataNetworksClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/DataNetworkDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewDataNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"rg1",
		"testMobileNetwork",
		"testDataNetwork",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*DataNetworksClient) Get

func (client *DataNetworksClient) Get(ctx context.Context, resourceGroupName string, mobileNetworkName string, dataNetworkName string, options *DataNetworksClientGetOptions) (DataNetworksClientGetResponse, error)

Get - Gets information about the specified data network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. dataNetworkName - The name of the data network. options - DataNetworksClientGetOptions contains the optional parameters for the DataNetworksClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/DataNetworkGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewDataNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"testMobileNetwork",
		"testDataNetwork",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*DataNetworksClient) NewListByMobileNetworkPager added in v0.4.0

func (client *DataNetworksClient) NewListByMobileNetworkPager(resourceGroupName string, mobileNetworkName string, options *DataNetworksClientListByMobileNetworkOptions) *runtime.Pager[DataNetworksClientListByMobileNetworkResponse]

NewListByMobileNetworkPager - Lists all data networks in the mobile network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. options - DataNetworksClientListByMobileNetworkOptions contains the optional parameters for the DataNetworksClient.ListByMobileNetwork method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/DataNetworkListByMobileNetwork.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewDataNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByMobileNetworkPager("rg1",
		"testMobileNetwork",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*DataNetworksClient) UpdateTags

func (client *DataNetworksClient) UpdateTags(ctx context.Context, resourceGroupName string, mobileNetworkName string, dataNetworkName string, parameters TagsObject, options *DataNetworksClientUpdateTagsOptions) (DataNetworksClientUpdateTagsResponse, error)

UpdateTags - Updates data network tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. dataNetworkName - The name of the data network. parameters - Parameters supplied to update data network tags. options - DataNetworksClientUpdateTagsOptions contains the optional parameters for the DataNetworksClient.UpdateTags method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/DataNetworkUpdateTags.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewDataNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.UpdateTags(ctx,
		"rg1",
		"testMobileNetwork",
		"testDataNetwork",
		armmobilenetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type DataNetworksClientBeginCreateOrUpdateOptions

type DataNetworksClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DataNetworksClientBeginCreateOrUpdateOptions contains the optional parameters for the DataNetworksClient.BeginCreateOrUpdate method.

type DataNetworksClientBeginDeleteOptions

type DataNetworksClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

DataNetworksClientBeginDeleteOptions contains the optional parameters for the DataNetworksClient.BeginDelete method.

type DataNetworksClientCreateOrUpdateResponse

type DataNetworksClientCreateOrUpdateResponse struct {
	DataNetwork
}

DataNetworksClientCreateOrUpdateResponse contains the response from method DataNetworksClient.CreateOrUpdate.

type DataNetworksClientDeleteResponse

type DataNetworksClientDeleteResponse struct {
}

DataNetworksClientDeleteResponse contains the response from method DataNetworksClient.Delete.

type DataNetworksClientGetOptions

type DataNetworksClientGetOptions struct {
}

DataNetworksClientGetOptions contains the optional parameters for the DataNetworksClient.Get method.

type DataNetworksClientGetResponse

type DataNetworksClientGetResponse struct {
	DataNetwork
}

DataNetworksClientGetResponse contains the response from method DataNetworksClient.Get.

type DataNetworksClientListByMobileNetworkOptions

type DataNetworksClientListByMobileNetworkOptions struct {
}

DataNetworksClientListByMobileNetworkOptions contains the optional parameters for the DataNetworksClient.ListByMobileNetwork method.

type DataNetworksClientListByMobileNetworkResponse

type DataNetworksClientListByMobileNetworkResponse struct {
	DataNetworkListResult
}

DataNetworksClientListByMobileNetworkResponse contains the response from method DataNetworksClient.ListByMobileNetwork.

type DataNetworksClientUpdateTagsOptions

type DataNetworksClientUpdateTagsOptions struct {
}

DataNetworksClientUpdateTagsOptions contains the optional parameters for the DataNetworksClient.UpdateTags method.

type DataNetworksClientUpdateTagsResponse

type DataNetworksClientUpdateTagsResponse struct {
	DataNetwork
}

DataNetworksClientUpdateTagsResponse contains the response from method DataNetworksClient.UpdateTags.

type ErrorAdditionalInfo added in v0.3.0

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info interface{} `json:"info,omitempty" azure:"ro"`

	// READ-ONLY; The additional info type.
	Type *string `json:"type,omitempty" azure:"ro"`
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON added in v0.6.0

func (e ErrorAdditionalInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON added in v0.6.0

func (e *ErrorAdditionalInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorDetail added in v0.3.0

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo `json:"additionalInfo,omitempty" azure:"ro"`

	// READ-ONLY; The error code.
	Code *string `json:"code,omitempty" azure:"ro"`

	// READ-ONLY; The error details.
	Details []*ErrorDetail `json:"details,omitempty" azure:"ro"`

	// READ-ONLY; The error message.
	Message *string `json:"message,omitempty" azure:"ro"`

	// READ-ONLY; The error target.
	Target *string `json:"target,omitempty" azure:"ro"`
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON added in v0.3.0

func (e ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON added in v0.6.0

func (e *ErrorDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ErrorResponse added in v0.3.0

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail `json:"error,omitempty"`
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

func (ErrorResponse) MarshalJSON added in v0.6.0

func (e ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON added in v0.6.0

func (e *ErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type InterfaceProperties

type InterfaceProperties struct {
	// The IPv4 address.
	IPv4Address *string `json:"ipv4Address,omitempty"`

	// The default IPv4 gateway (router).
	IPv4Gateway *string `json:"ipv4Gateway,omitempty"`

	// The IPv4 subnet.
	IPv4Subnet *string `json:"ipv4Subnet,omitempty"`

	// The logical name for this interface. This should match one of the interfaces configured on your Azure Stack Edge device.
	Name *string `json:"name,omitempty"`
}

InterfaceProperties - Interface properties

func (InterfaceProperties) MarshalJSON added in v0.6.0

func (i InterfaceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type InterfaceProperties.

func (*InterfaceProperties) UnmarshalJSON added in v0.6.0

func (i *InterfaceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type InterfaceProperties.

type KeyVaultCertificate added in v0.6.0

type KeyVaultCertificate struct {
	// The certificate URL, unversioned. For example: https://contosovault.vault.azure.net/certificates/ingress.
	CertificateURL *string `json:"certificateUrl,omitempty"`
}

KeyVaultCertificate - An Azure key vault certificate.

func (KeyVaultCertificate) MarshalJSON added in v0.6.0

func (k KeyVaultCertificate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyVaultCertificate.

func (*KeyVaultCertificate) UnmarshalJSON added in v0.6.0

func (k *KeyVaultCertificate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyVaultCertificate.

type KeyVaultKey added in v0.6.0

type KeyVaultKey struct {
	// The key URL, unversioned. For example: https://contosovault.vault.azure.net/keys/azureKey.
	KeyURL *string `json:"keyUrl,omitempty"`
}

KeyVaultKey - An Azure key vault key.

func (KeyVaultKey) MarshalJSON added in v0.6.0

func (k KeyVaultKey) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KeyVaultKey.

func (*KeyVaultKey) UnmarshalJSON added in v0.6.0

func (k *KeyVaultKey) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KeyVaultKey.

type ListResult

type ListResult struct {
	// A list of mobile networks in a resource group.
	Value []*MobileNetwork `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ListResult - Response for mobile networks API service call.

func (ListResult) MarshalJSON

func (l ListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ListResult.

func (*ListResult) UnmarshalJSON added in v0.6.0

func (l *ListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ListResult.

type LocalDiagnosticsAccessConfiguration added in v0.6.0

type LocalDiagnosticsAccessConfiguration struct {
	// The HTTPS server TLS certificate used to secure local access to diagnostics.
	HTTPSServerCertificate *KeyVaultCertificate `json:"httpsServerCertificate,omitempty"`
}

LocalDiagnosticsAccessConfiguration - The kubernetes ingress configuration to control access to packet core diagnostics over local APIs.

func (LocalDiagnosticsAccessConfiguration) MarshalJSON added in v0.6.0

func (l LocalDiagnosticsAccessConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type LocalDiagnosticsAccessConfiguration.

func (*LocalDiagnosticsAccessConfiguration) UnmarshalJSON added in v0.6.0

func (l *LocalDiagnosticsAccessConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type LocalDiagnosticsAccessConfiguration.

type ManagedServiceIdentity added in v0.6.0

type ManagedServiceIdentity struct {
	// REQUIRED; Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
	Type *ManagedServiceIdentityType `json:"type,omitempty"`

	// The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM
	// resource ids in the form:
	// '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
	// The dictionary values can be empty objects ({}) in
	// requests.
	UserAssignedIdentities map[string]*UserAssignedIdentity `json:"userAssignedIdentities,omitempty"`

	// READ-ONLY; The service principal ID of the system assigned identity. This property will only be provided for a system assigned
	// identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`

	// READ-ONLY; The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
	TenantID *string `json:"tenantId,omitempty" azure:"ro"`
}

ManagedServiceIdentity - Managed service identity (system assigned and/or user assigned identities)

func (ManagedServiceIdentity) MarshalJSON added in v0.6.0

func (m ManagedServiceIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ManagedServiceIdentity.

func (*ManagedServiceIdentity) UnmarshalJSON added in v0.6.0

func (m *ManagedServiceIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ManagedServiceIdentity.

type ManagedServiceIdentityType added in v0.6.0

type ManagedServiceIdentityType string

ManagedServiceIdentityType - Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

const (
	ManagedServiceIdentityTypeNone                       ManagedServiceIdentityType = "None"
	ManagedServiceIdentityTypeSystemAssigned             ManagedServiceIdentityType = "SystemAssigned"
	ManagedServiceIdentityTypeSystemAssignedUserAssigned ManagedServiceIdentityType = "SystemAssigned,UserAssigned"
	ManagedServiceIdentityTypeUserAssigned               ManagedServiceIdentityType = "UserAssigned"
)

func PossibleManagedServiceIdentityTypeValues added in v0.6.0

func PossibleManagedServiceIdentityTypeValues() []ManagedServiceIdentityType

PossibleManagedServiceIdentityTypeValues returns the possible values for the ManagedServiceIdentityType const type.

type MobileNetwork

type MobileNetwork struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// REQUIRED; Mobile network properties.
	Properties *PropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

MobileNetwork - Mobile network resource.

func (MobileNetwork) MarshalJSON

func (m MobileNetwork) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MobileNetwork.

func (*MobileNetwork) UnmarshalJSON added in v0.6.0

func (m *MobileNetwork) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MobileNetwork.

type MobileNetworksClient

type MobileNetworksClient struct {
	// contains filtered or unexported fields
}

MobileNetworksClient contains the methods for the MobileNetworks group. Don't use this type directly, use NewMobileNetworksClient() instead.

func NewMobileNetworksClient

func NewMobileNetworksClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*MobileNetworksClient, error)

NewMobileNetworksClient creates a new instance of MobileNetworksClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*MobileNetworksClient) BeginCreateOrUpdate

func (client *MobileNetworksClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, mobileNetworkName string, parameters MobileNetwork, options *MobileNetworksClientBeginCreateOrUpdateOptions) (*runtime.Poller[MobileNetworksClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a mobile network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. parameters - Parameters supplied to the create or update mobile network operation. options - MobileNetworksClientBeginCreateOrUpdateOptions contains the optional parameters for the MobileNetworksClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/MobileNetworkCreate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewMobileNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"testMobileNetwork",
		armmobilenetwork.MobileNetwork{
			Location: to.Ptr("eastus"),
			Properties: &armmobilenetwork.PropertiesFormat{
				PublicLandMobileNetworkIdentifier: &armmobilenetwork.PlmnID{
					Mcc: to.Ptr("001"),
					Mnc: to.Ptr("01"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*MobileNetworksClient) BeginDelete

func (client *MobileNetworksClient) BeginDelete(ctx context.Context, resourceGroupName string, mobileNetworkName string, options *MobileNetworksClientBeginDeleteOptions) (*runtime.Poller[MobileNetworksClientDeleteResponse], error)

BeginDelete - Deletes the specified mobile network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. options - MobileNetworksClientBeginDeleteOptions contains the optional parameters for the MobileNetworksClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/MobileNetworkDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewMobileNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"rg1",
		"testMobileNetwork",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*MobileNetworksClient) BeginListSimIDs

func (client *MobileNetworksClient) BeginListSimIDs(ctx context.Context, resourceGroupName string, mobileNetworkName string, options *MobileNetworksClientBeginListSimIDsOptions) (*runtime.Poller[MobileNetworksClientListSimIDsResponse], error)

BeginListSimIDs - Lists the IDs of all provisioned SIMs in a mobile network If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. options - MobileNetworksClientBeginListSimIDsOptions contains the optional parameters for the MobileNetworksClient.BeginListSimIDs method.

func (*MobileNetworksClient) Get

func (client *MobileNetworksClient) Get(ctx context.Context, resourceGroupName string, mobileNetworkName string, options *MobileNetworksClientGetOptions) (MobileNetworksClientGetResponse, error)

Get - Gets information about the specified mobile network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. options - MobileNetworksClientGetOptions contains the optional parameters for the MobileNetworksClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/MobileNetworkGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewMobileNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"testMobileNetwork",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*MobileNetworksClient) NewListByResourceGroupPager added in v0.4.0

NewListByResourceGroupPager - Lists all the mobile networks in a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. options - MobileNetworksClientListByResourceGroupOptions contains the optional parameters for the MobileNetworksClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/MobileNetworkListByResourceGroup.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewMobileNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("rg1",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*MobileNetworksClient) NewListBySubscriptionPager added in v0.4.0

NewListBySubscriptionPager - Lists all the mobile networks in a subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview options - MobileNetworksClientListBySubscriptionOptions contains the optional parameters for the MobileNetworksClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/MobileNetworkListBySubscription.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewMobileNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*MobileNetworksClient) UpdateTags

func (client *MobileNetworksClient) UpdateTags(ctx context.Context, resourceGroupName string, mobileNetworkName string, parameters TagsObject, options *MobileNetworksClientUpdateTagsOptions) (MobileNetworksClientUpdateTagsResponse, error)

UpdateTags - Updates mobile network tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. parameters - Parameters supplied to update mobile network tags. options - MobileNetworksClientUpdateTagsOptions contains the optional parameters for the MobileNetworksClient.UpdateTags method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/MobileNetworkUpdateTags.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewMobileNetworksClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.UpdateTags(ctx,
		"rg1",
		"testMobileNetwork",
		armmobilenetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type MobileNetworksClientBeginCreateOrUpdateOptions

type MobileNetworksClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

MobileNetworksClientBeginCreateOrUpdateOptions contains the optional parameters for the MobileNetworksClient.BeginCreateOrUpdate method.

type MobileNetworksClientBeginDeleteOptions

type MobileNetworksClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

MobileNetworksClientBeginDeleteOptions contains the optional parameters for the MobileNetworksClient.BeginDelete method.

type MobileNetworksClientBeginListSimIDsOptions

type MobileNetworksClientBeginListSimIDsOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

MobileNetworksClientBeginListSimIDsOptions contains the optional parameters for the MobileNetworksClient.BeginListSimIDs method.

type MobileNetworksClientCreateOrUpdateResponse

type MobileNetworksClientCreateOrUpdateResponse struct {
	MobileNetwork
}

MobileNetworksClientCreateOrUpdateResponse contains the response from method MobileNetworksClient.CreateOrUpdate.

type MobileNetworksClientDeleteResponse

type MobileNetworksClientDeleteResponse struct {
}

MobileNetworksClientDeleteResponse contains the response from method MobileNetworksClient.Delete.

type MobileNetworksClientGetOptions

type MobileNetworksClientGetOptions struct {
}

MobileNetworksClientGetOptions contains the optional parameters for the MobileNetworksClient.Get method.

type MobileNetworksClientGetResponse

type MobileNetworksClientGetResponse struct {
	MobileNetwork
}

MobileNetworksClientGetResponse contains the response from method MobileNetworksClient.Get.

type MobileNetworksClientListByResourceGroupOptions

type MobileNetworksClientListByResourceGroupOptions struct {
}

MobileNetworksClientListByResourceGroupOptions contains the optional parameters for the MobileNetworksClient.ListByResourceGroup method.

type MobileNetworksClientListByResourceGroupResponse

type MobileNetworksClientListByResourceGroupResponse struct {
	ListResult
}

MobileNetworksClientListByResourceGroupResponse contains the response from method MobileNetworksClient.ListByResourceGroup.

type MobileNetworksClientListBySubscriptionOptions

type MobileNetworksClientListBySubscriptionOptions struct {
}

MobileNetworksClientListBySubscriptionOptions contains the optional parameters for the MobileNetworksClient.ListBySubscription method.

type MobileNetworksClientListBySubscriptionResponse

type MobileNetworksClientListBySubscriptionResponse struct {
	ListResult
}

MobileNetworksClientListBySubscriptionResponse contains the response from method MobileNetworksClient.ListBySubscription.

type MobileNetworksClientListSimIDsResponse

type MobileNetworksClientListSimIDsResponse struct {
	SimIDListResult
}

MobileNetworksClientListSimIDsResponse contains the response from method MobileNetworksClient.ListSimIDs.

type MobileNetworksClientUpdateTagsOptions

type MobileNetworksClientUpdateTagsOptions struct {
}

MobileNetworksClientUpdateTagsOptions contains the optional parameters for the MobileNetworksClient.UpdateTags method.

type MobileNetworksClientUpdateTagsResponse

type MobileNetworksClientUpdateTagsResponse struct {
	MobileNetwork
}

MobileNetworksClientUpdateTagsResponse contains the response from method MobileNetworksClient.UpdateTags.

type NaptConfiguration

type NaptConfiguration struct {
	// Whether NAPT is enabled for connections to this attached data network.
	Enabled *NaptEnabled `json:"enabled,omitempty"`

	// Maximum number of UDP and TCP pinholes that can be open simultaneously on the core interface. For 5G networks, this is
	// the N6 interface. For 4G networks, this is the SGi interface.
	PinholeLimits *int32 `json:"pinholeLimits,omitempty"`

	// Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second.
	PinholeTimeouts *PinholeTimeouts `json:"pinholeTimeouts,omitempty"`

	// Range of port numbers to use as translated ports on each translated address. If not specified and NAPT is enabled, this
	// range defaults to 1,024 - 49,999. (Ports under 1,024 should not be used because
	// these are special purpose ports reserved by IANA. Ports 50,000 and above are reserved for non-NAPT use.)
	PortRange *PortRange `json:"portRange,omitempty"`

	// The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by
	// another pinhole. All hold times must be minimum 1 second.
	PortReuseHoldTime *PortReuseHoldTimes `json:"portReuseHoldTime,omitempty"`
}

NaptConfiguration - The network address and port translation settings to use for the attached data network.

func (NaptConfiguration) MarshalJSON added in v0.6.0

func (n NaptConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type NaptConfiguration.

func (*NaptConfiguration) UnmarshalJSON added in v0.6.0

func (n *NaptConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type NaptConfiguration.

type NaptEnabled

type NaptEnabled string

NaptEnabled - Whether network address and port translation is enabled.

const (
	// NaptEnabledDisabled - NAPT is disabled
	NaptEnabledDisabled NaptEnabled = "Disabled"
	// NaptEnabledEnabled - NAPT is enabled
	NaptEnabledEnabled NaptEnabled = "Enabled"
)

func PossibleNaptEnabledValues

func PossibleNaptEnabledValues() []NaptEnabled

PossibleNaptEnabledValues returns the possible values for the NaptEnabled const type.

type Operation

type Operation struct {
	// Indicates whether the operation applies to data-plane.
	IsDataAction *bool `json:"isDataAction,omitempty"`

	// READ-ONLY; The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty" azure:"ro"`

	// READ-ONLY; Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty" azure:"ro"`
}

Operation - Object that describes a single Microsoft.MobileNetwork operation.

func (Operation) MarshalJSON added in v0.6.0

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON added in v0.6.0

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationDisplay

type OperationDisplay struct {
	// Description of the operation.
	Description *string `json:"description,omitempty"`

	// Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`

	// Service provider: Microsoft.MobileNetwork
	Provider *string `json:"provider,omitempty"`

	// Resource on which the operation is performed: Registration definition, registration assignment etc.
	Resource *string `json:"resource,omitempty"`
}

OperationDisplay - The object that represents the operation.

func (OperationDisplay) MarshalJSON added in v0.6.0

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON added in v0.6.0

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationList

type OperationList struct {
	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`

	// READ-ONLY; List of Microsoft.MobileNetwork operations.
	Value []*Operation `json:"value,omitempty" azure:"ro"`
}

OperationList - List of the operations.

func (OperationList) MarshalJSON

func (o OperationList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationList.

func (*OperationList) UnmarshalJSON added in v0.6.0

func (o *OperationList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationList.

type OperationsClient

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*OperationsClient) NewListPager added in v0.4.0

NewListPager - Gets a list of the operations. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview options - OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/OperationList.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewOperationsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

type OperationsClientListOptions

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.List method.

type OperationsClientListResponse

type OperationsClientListResponse struct {
	OperationList
}

OperationsClientListResponse contains the response from method OperationsClient.List.

type PacketCoreControlPlane

type PacketCoreControlPlane struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// REQUIRED; Packet core control plane Properties.
	Properties *PacketCoreControlPlanePropertiesFormat `json:"properties,omitempty"`

	// The identity used to retrieve the ingress certificate from Azure key vault.
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PacketCoreControlPlane - Packet core control plane resource.

func (PacketCoreControlPlane) MarshalJSON

func (p PacketCoreControlPlane) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCoreControlPlane.

func (*PacketCoreControlPlane) UnmarshalJSON added in v0.6.0

func (p *PacketCoreControlPlane) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCoreControlPlane.

type PacketCoreControlPlaneListResult

type PacketCoreControlPlaneListResult struct {
	// A list of packet core control planes in a resource group.
	Value []*PacketCoreControlPlane `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

PacketCoreControlPlaneListResult - Response for packet core control planes API service call.

func (PacketCoreControlPlaneListResult) MarshalJSON

func (p PacketCoreControlPlaneListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCoreControlPlaneListResult.

func (*PacketCoreControlPlaneListResult) UnmarshalJSON added in v0.6.0

func (p *PacketCoreControlPlaneListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCoreControlPlaneListResult.

type PacketCoreControlPlanePropertiesFormat

type PacketCoreControlPlanePropertiesFormat struct {
	// REQUIRED; The control plane interface on the access network. For 5G networks, this is the N2 interface. For 4G networks,
	// this is the S1-MME interface.
	ControlPlaneAccessInterface *InterfaceProperties `json:"controlPlaneAccessInterface,omitempty"`

	// REQUIRED; Mobile network in which this packet core control plane is deployed.
	MobileNetwork *ResourceID `json:"mobileNetwork,omitempty"`

	// REQUIRED; The SKU defining the throughput and SIM allowances for this packet core control plane deployment.
	SKU *BillingSKU `json:"sku,omitempty"`

	// The core network technology generation (5G core or EPC / 4G core).
	CoreNetworkTechnology *CoreNetworkType `json:"coreNetworkTechnology,omitempty"`

	// Settings to allow interoperability with third party components e.g. RANs and UEs.
	InteropSettings interface{} `json:"interopSettings,omitempty"`

	// The kubernetes ingress configuration to control access to packet core diagnostics over local APIs.
	LocalDiagnosticsAccess *LocalDiagnosticsAccessConfiguration `json:"localDiagnosticsAccess,omitempty"`

	// The platform where the packet core is deployed.
	Platform *PlatformConfiguration `json:"platform,omitempty"`

	// The version of the packet core software that is deployed.
	Version *string `json:"version,omitempty"`

	// READ-ONLY; The provisioning state of the packet core control plane resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PacketCoreControlPlanePropertiesFormat - Packet core control plane properties.

func (PacketCoreControlPlanePropertiesFormat) MarshalJSON added in v0.6.0

func (p PacketCoreControlPlanePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCoreControlPlanePropertiesFormat.

func (*PacketCoreControlPlanePropertiesFormat) UnmarshalJSON added in v0.6.0

func (p *PacketCoreControlPlanePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCoreControlPlanePropertiesFormat.

type PacketCoreControlPlaneVersion added in v0.6.0

type PacketCoreControlPlaneVersion struct {
	// REQUIRED; Packet core control plane version properties.
	Properties *PacketCoreControlPlaneVersionPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PacketCoreControlPlaneVersion - Packet core control plane version resource.

func (PacketCoreControlPlaneVersion) MarshalJSON added in v0.6.0

func (p PacketCoreControlPlaneVersion) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCoreControlPlaneVersion.

func (*PacketCoreControlPlaneVersion) UnmarshalJSON added in v0.6.0

func (p *PacketCoreControlPlaneVersion) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCoreControlPlaneVersion.

type PacketCoreControlPlaneVersionListResult added in v0.6.0

type PacketCoreControlPlaneVersionListResult struct {
	// A list of supported packet core control plane versions.
	Value []*PacketCoreControlPlaneVersion `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

PacketCoreControlPlaneVersionListResult - Response for packet core control plane version API service call.

func (PacketCoreControlPlaneVersionListResult) MarshalJSON added in v0.6.0

func (p PacketCoreControlPlaneVersionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCoreControlPlaneVersionListResult.

func (*PacketCoreControlPlaneVersionListResult) UnmarshalJSON added in v0.6.0

func (p *PacketCoreControlPlaneVersionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCoreControlPlaneVersionListResult.

type PacketCoreControlPlaneVersionPropertiesFormat added in v0.6.0

type PacketCoreControlPlaneVersionPropertiesFormat struct {
	// Indicates whether this is the recommended version to use for new packet core control plane deployments.
	RecommendedVersion *RecommendedVersion `json:"recommendedVersion,omitempty"`

	// The state of this packet core control plane version.
	VersionState *VersionState `json:"versionState,omitempty"`

	// READ-ONLY; The provisioning state of the packet core control plane version resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PacketCoreControlPlaneVersionPropertiesFormat - Packet core control plane version properties.

func (PacketCoreControlPlaneVersionPropertiesFormat) MarshalJSON added in v0.6.0

MarshalJSON implements the json.Marshaller interface for type PacketCoreControlPlaneVersionPropertiesFormat.

func (*PacketCoreControlPlaneVersionPropertiesFormat) UnmarshalJSON added in v0.6.0

func (p *PacketCoreControlPlaneVersionPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCoreControlPlaneVersionPropertiesFormat.

type PacketCoreControlPlaneVersionsClient added in v0.6.0

type PacketCoreControlPlaneVersionsClient struct {
	// contains filtered or unexported fields
}

PacketCoreControlPlaneVersionsClient contains the methods for the PacketCoreControlPlaneVersions group. Don't use this type directly, use NewPacketCoreControlPlaneVersionsClient() instead.

func NewPacketCoreControlPlaneVersionsClient added in v0.6.0

func NewPacketCoreControlPlaneVersionsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*PacketCoreControlPlaneVersionsClient, error)

NewPacketCoreControlPlaneVersionsClient creates a new instance of PacketCoreControlPlaneVersionsClient with the specified values. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PacketCoreControlPlaneVersionsClient) Get added in v0.6.0

Get - Gets information about the specified packet core control plane version. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview versionName - The name of the packet core control plane version. options - PacketCoreControlPlaneVersionsClientGetOptions contains the optional parameters for the PacketCoreControlPlaneVersionsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/PacketCoreControlPlaneVersionGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewPacketCoreControlPlaneVersionsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"PMN-4-11-1",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*PacketCoreControlPlaneVersionsClient) NewListByResourceGroupPager added in v0.6.0

NewListByResourceGroupPager - Lists all supported packet core control planes versions. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview options - PacketCoreControlPlaneVersionsClientListByResourceGroupOptions contains the optional parameters for the PacketCoreControlPlaneVersionsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/PacketCoreControlPlaneVersionListByResourceGroup.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewPacketCoreControlPlaneVersionsClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

type PacketCoreControlPlaneVersionsClientGetOptions added in v0.6.0

type PacketCoreControlPlaneVersionsClientGetOptions struct {
}

PacketCoreControlPlaneVersionsClientGetOptions contains the optional parameters for the PacketCoreControlPlaneVersionsClient.Get method.

type PacketCoreControlPlaneVersionsClientGetResponse added in v0.6.0

type PacketCoreControlPlaneVersionsClientGetResponse struct {
	PacketCoreControlPlaneVersion
}

PacketCoreControlPlaneVersionsClientGetResponse contains the response from method PacketCoreControlPlaneVersionsClient.Get.

type PacketCoreControlPlaneVersionsClientListByResourceGroupOptions added in v0.6.0

type PacketCoreControlPlaneVersionsClientListByResourceGroupOptions struct {
}

PacketCoreControlPlaneVersionsClientListByResourceGroupOptions contains the optional parameters for the PacketCoreControlPlaneVersionsClient.ListByResourceGroup method.

type PacketCoreControlPlaneVersionsClientListByResourceGroupResponse added in v0.6.0

type PacketCoreControlPlaneVersionsClientListByResourceGroupResponse struct {
	PacketCoreControlPlaneVersionListResult
}

PacketCoreControlPlaneVersionsClientListByResourceGroupResponse contains the response from method PacketCoreControlPlaneVersionsClient.ListByResourceGroup.

type PacketCoreControlPlanesClient

type PacketCoreControlPlanesClient struct {
	// contains filtered or unexported fields
}

PacketCoreControlPlanesClient contains the methods for the PacketCoreControlPlanes group. Don't use this type directly, use NewPacketCoreControlPlanesClient() instead.

func NewPacketCoreControlPlanesClient

func NewPacketCoreControlPlanesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PacketCoreControlPlanesClient, error)

NewPacketCoreControlPlanesClient creates a new instance of PacketCoreControlPlanesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PacketCoreControlPlanesClient) BeginCreateOrUpdate

BeginCreateOrUpdate - Creates or updates a packet core control plane. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. parameters - Parameters supplied to the create or update packet core control plane operation. options - PacketCoreControlPlanesClientBeginCreateOrUpdateOptions contains the optional parameters for the PacketCoreControlPlanesClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/PacketCoreControlPlaneCreate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewPacketCoreControlPlanesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"TestPacketCoreCP",
		armmobilenetwork.PacketCoreControlPlane{
			Location: to.Ptr("eastus"),
			Properties: &armmobilenetwork.PacketCoreControlPlanePropertiesFormat{
				ControlPlaneAccessInterface: &armmobilenetwork.InterfaceProperties{
					Name: to.Ptr("N2"),
				},
				CoreNetworkTechnology: to.Ptr(armmobilenetwork.CoreNetworkTypeFiveGC),
				LocalDiagnosticsAccess: &armmobilenetwork.LocalDiagnosticsAccessConfiguration{
					HTTPSServerCertificate: &armmobilenetwork.KeyVaultCertificate{
						CertificateURL: to.Ptr("https://contosovault.vault.azure.net/certificates/ingress"),
					},
				},
				MobileNetwork: &armmobilenetwork.ResourceID{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork"),
				},
				Platform: &armmobilenetwork.PlatformConfiguration{
					Type: to.Ptr(armmobilenetwork.PlatformTypeAKSHCI),
					AzureStackEdgeDevice: &armmobilenetwork.AzureStackEdgeDeviceResourceID{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/TestAzureStackEdgeDevice"),
					},
					ConnectedCluster: &armmobilenetwork.ConnectedClusterResourceID{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Kubernetes/connectedClusters/TestConnectedCluster"),
					},
					CustomLocation: &armmobilenetwork.CustomLocationResourceID{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ExtendedLocation/customLocations/TestCustomLocation"),
					},
				},
				SKU:     to.Ptr(armmobilenetwork.BillingSKU("testSku")),
				Version: to.Ptr("0.2.0"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*PacketCoreControlPlanesClient) BeginDelete

BeginDelete - Deletes the specified packet core control plane. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. options - PacketCoreControlPlanesClientBeginDeleteOptions contains the optional parameters for the PacketCoreControlPlanesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/PacketCoreControlPlaneDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewPacketCoreControlPlanesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"rg1",
		"TestPacketCoreCP",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*PacketCoreControlPlanesClient) Get

func (client *PacketCoreControlPlanesClient) Get(ctx context.Context, resourceGroupName string, packetCoreControlPlaneName string, options *PacketCoreControlPlanesClientGetOptions) (PacketCoreControlPlanesClientGetResponse, error)

Get - Gets information about the specified packet core control plane. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. options - PacketCoreControlPlanesClientGetOptions contains the optional parameters for the PacketCoreControlPlanesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/PacketCoreControlPlaneGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewPacketCoreControlPlanesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"TestPacketCoreCP",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*PacketCoreControlPlanesClient) NewListByResourceGroupPager added in v0.4.0

NewListByResourceGroupPager - Lists all the packet core control planes in a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. options - PacketCoreControlPlanesClientListByResourceGroupOptions contains the optional parameters for the PacketCoreControlPlanesClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/PacketCoreControlPlaneListByResourceGroup.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewPacketCoreControlPlanesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("rg1",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*PacketCoreControlPlanesClient) NewListBySubscriptionPager added in v0.4.0

NewListBySubscriptionPager - Lists all the packet core control planes in a subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview options - PacketCoreControlPlanesClientListBySubscriptionOptions contains the optional parameters for the PacketCoreControlPlanesClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/PacketCoreControlPlaneListBySubscription.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewPacketCoreControlPlanesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*PacketCoreControlPlanesClient) UpdateTags

func (client *PacketCoreControlPlanesClient) UpdateTags(ctx context.Context, resourceGroupName string, packetCoreControlPlaneName string, parameters TagsObject, options *PacketCoreControlPlanesClientUpdateTagsOptions) (PacketCoreControlPlanesClientUpdateTagsResponse, error)

UpdateTags - Updates packet core control planes tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. parameters - Parameters supplied to update packet core control plane tags. options - PacketCoreControlPlanesClientUpdateTagsOptions contains the optional parameters for the PacketCoreControlPlanesClient.UpdateTags method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/PacketCoreControlPlaneUpdateTags.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewPacketCoreControlPlanesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.UpdateTags(ctx,
		"rg1",
		"TestPacketCoreCP",
		armmobilenetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type PacketCoreControlPlanesClientBeginCreateOrUpdateOptions

type PacketCoreControlPlanesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PacketCoreControlPlanesClientBeginCreateOrUpdateOptions contains the optional parameters for the PacketCoreControlPlanesClient.BeginCreateOrUpdate method.

type PacketCoreControlPlanesClientBeginDeleteOptions

type PacketCoreControlPlanesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PacketCoreControlPlanesClientBeginDeleteOptions contains the optional parameters for the PacketCoreControlPlanesClient.BeginDelete method.

type PacketCoreControlPlanesClientCreateOrUpdateResponse

type PacketCoreControlPlanesClientCreateOrUpdateResponse struct {
	PacketCoreControlPlane
}

PacketCoreControlPlanesClientCreateOrUpdateResponse contains the response from method PacketCoreControlPlanesClient.CreateOrUpdate.

type PacketCoreControlPlanesClientDeleteResponse

type PacketCoreControlPlanesClientDeleteResponse struct {
}

PacketCoreControlPlanesClientDeleteResponse contains the response from method PacketCoreControlPlanesClient.Delete.

type PacketCoreControlPlanesClientGetOptions

type PacketCoreControlPlanesClientGetOptions struct {
}

PacketCoreControlPlanesClientGetOptions contains the optional parameters for the PacketCoreControlPlanesClient.Get method.

type PacketCoreControlPlanesClientGetResponse

type PacketCoreControlPlanesClientGetResponse struct {
	PacketCoreControlPlane
}

PacketCoreControlPlanesClientGetResponse contains the response from method PacketCoreControlPlanesClient.Get.

type PacketCoreControlPlanesClientListByResourceGroupOptions

type PacketCoreControlPlanesClientListByResourceGroupOptions struct {
}

PacketCoreControlPlanesClientListByResourceGroupOptions contains the optional parameters for the PacketCoreControlPlanesClient.ListByResourceGroup method.

type PacketCoreControlPlanesClientListByResourceGroupResponse

type PacketCoreControlPlanesClientListByResourceGroupResponse struct {
	PacketCoreControlPlaneListResult
}

PacketCoreControlPlanesClientListByResourceGroupResponse contains the response from method PacketCoreControlPlanesClient.ListByResourceGroup.

type PacketCoreControlPlanesClientListBySubscriptionOptions

type PacketCoreControlPlanesClientListBySubscriptionOptions struct {
}

PacketCoreControlPlanesClientListBySubscriptionOptions contains the optional parameters for the PacketCoreControlPlanesClient.ListBySubscription method.

type PacketCoreControlPlanesClientListBySubscriptionResponse

type PacketCoreControlPlanesClientListBySubscriptionResponse struct {
	PacketCoreControlPlaneListResult
}

PacketCoreControlPlanesClientListBySubscriptionResponse contains the response from method PacketCoreControlPlanesClient.ListBySubscription.

type PacketCoreControlPlanesClientUpdateTagsOptions

type PacketCoreControlPlanesClientUpdateTagsOptions struct {
}

PacketCoreControlPlanesClientUpdateTagsOptions contains the optional parameters for the PacketCoreControlPlanesClient.UpdateTags method.

type PacketCoreControlPlanesClientUpdateTagsResponse

type PacketCoreControlPlanesClientUpdateTagsResponse struct {
	PacketCoreControlPlane
}

PacketCoreControlPlanesClientUpdateTagsResponse contains the response from method PacketCoreControlPlanesClient.UpdateTags.

type PacketCoreDataPlane

type PacketCoreDataPlane struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// REQUIRED; Packet core data plane Properties.
	Properties *PacketCoreDataPlanePropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

PacketCoreDataPlane - Packet core data plane resource.

func (PacketCoreDataPlane) MarshalJSON

func (p PacketCoreDataPlane) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCoreDataPlane.

func (*PacketCoreDataPlane) UnmarshalJSON added in v0.6.0

func (p *PacketCoreDataPlane) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCoreDataPlane.

type PacketCoreDataPlaneListResult

type PacketCoreDataPlaneListResult struct {
	// A list of packet core data planes in a resource group.
	Value []*PacketCoreDataPlane `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

PacketCoreDataPlaneListResult - Response for packet core data planes API service call.

func (PacketCoreDataPlaneListResult) MarshalJSON

func (p PacketCoreDataPlaneListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCoreDataPlaneListResult.

func (*PacketCoreDataPlaneListResult) UnmarshalJSON added in v0.6.0

func (p *PacketCoreDataPlaneListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCoreDataPlaneListResult.

type PacketCoreDataPlanePropertiesFormat

type PacketCoreDataPlanePropertiesFormat struct {
	// REQUIRED; The user plane interface on the access network. For 5G networks, this is the N3 interface. For 4G networks, this
	// is the S1-U interface.
	UserPlaneAccessInterface *InterfaceProperties `json:"userPlaneAccessInterface,omitempty"`

	// READ-ONLY; The provisioning state of the packet core data plane resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

PacketCoreDataPlanePropertiesFormat - Packet core data plane properties.

func (PacketCoreDataPlanePropertiesFormat) MarshalJSON added in v0.6.0

func (p PacketCoreDataPlanePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PacketCoreDataPlanePropertiesFormat.

func (*PacketCoreDataPlanePropertiesFormat) UnmarshalJSON added in v0.6.0

func (p *PacketCoreDataPlanePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PacketCoreDataPlanePropertiesFormat.

type PacketCoreDataPlanesClient

type PacketCoreDataPlanesClient struct {
	// contains filtered or unexported fields
}

PacketCoreDataPlanesClient contains the methods for the PacketCoreDataPlanes group. Don't use this type directly, use NewPacketCoreDataPlanesClient() instead.

func NewPacketCoreDataPlanesClient

func NewPacketCoreDataPlanesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PacketCoreDataPlanesClient, error)

NewPacketCoreDataPlanesClient creates a new instance of PacketCoreDataPlanesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*PacketCoreDataPlanesClient) BeginCreateOrUpdate

func (client *PacketCoreDataPlanesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, packetCoreControlPlaneName string, packetCoreDataPlaneName string, parameters PacketCoreDataPlane, options *PacketCoreDataPlanesClientBeginCreateOrUpdateOptions) (*runtime.Poller[PacketCoreDataPlanesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a packet core data plane. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. packetCoreDataPlaneName - The name of the packet core data plane. parameters - Parameters supplied to the create or update packet core data plane operation. options - PacketCoreDataPlanesClientBeginCreateOrUpdateOptions contains the optional parameters for the PacketCoreDataPlanesClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/PacketCoreDataPlaneCreate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewPacketCoreDataPlanesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"testPacketCoreCP",
		"testPacketCoreDP",
		armmobilenetwork.PacketCoreDataPlane{
			Location: to.Ptr("eastus"),
			Properties: &armmobilenetwork.PacketCoreDataPlanePropertiesFormat{
				UserPlaneAccessInterface: &armmobilenetwork.InterfaceProperties{
					Name: to.Ptr("N3"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*PacketCoreDataPlanesClient) BeginDelete

func (client *PacketCoreDataPlanesClient) BeginDelete(ctx context.Context, resourceGroupName string, packetCoreControlPlaneName string, packetCoreDataPlaneName string, options *PacketCoreDataPlanesClientBeginDeleteOptions) (*runtime.Poller[PacketCoreDataPlanesClientDeleteResponse], error)

BeginDelete - Deletes the specified packet core data plane. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. packetCoreDataPlaneName - The name of the packet core data plane. options - PacketCoreDataPlanesClientBeginDeleteOptions contains the optional parameters for the PacketCoreDataPlanesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/PacketCoreDataPlaneDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewPacketCoreDataPlanesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"rg1",
		"testPacketCoreCP",
		"testPacketCoreDP",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*PacketCoreDataPlanesClient) Get

func (client *PacketCoreDataPlanesClient) Get(ctx context.Context, resourceGroupName string, packetCoreControlPlaneName string, packetCoreDataPlaneName string, options *PacketCoreDataPlanesClientGetOptions) (PacketCoreDataPlanesClientGetResponse, error)

Get - Gets information about the specified packet core data plane. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. packetCoreDataPlaneName - The name of the packet core data plane. options - PacketCoreDataPlanesClientGetOptions contains the optional parameters for the PacketCoreDataPlanesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/PacketCoreDataPlaneGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewPacketCoreDataPlanesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"testPacketCoreCP",
		"testPacketCoreDP",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*PacketCoreDataPlanesClient) NewListByPacketCoreControlPlanePager added in v0.4.0

func (client *PacketCoreDataPlanesClient) NewListByPacketCoreControlPlanePager(resourceGroupName string, packetCoreControlPlaneName string, options *PacketCoreDataPlanesClientListByPacketCoreControlPlaneOptions) *runtime.Pager[PacketCoreDataPlanesClientListByPacketCoreControlPlaneResponse]

NewListByPacketCoreControlPlanePager - Lists all the packet core data planes associated with a packet core control plane. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. options - PacketCoreDataPlanesClientListByPacketCoreControlPlaneOptions contains the optional parameters for the PacketCoreDataPlanesClient.ListByPacketCoreControlPlane method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/PacketCoreDataPlaneListByPacketCoreControlPlane.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewPacketCoreDataPlanesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByPacketCoreControlPlanePager("rg1",
		"testPacketCoreCP",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*PacketCoreDataPlanesClient) UpdateTags

func (client *PacketCoreDataPlanesClient) UpdateTags(ctx context.Context, resourceGroupName string, packetCoreControlPlaneName string, packetCoreDataPlaneName string, parameters TagsObject, options *PacketCoreDataPlanesClientUpdateTagsOptions) (PacketCoreDataPlanesClientUpdateTagsResponse, error)

UpdateTags - Updates packet core data planes tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. packetCoreControlPlaneName - The name of the packet core control plane. packetCoreDataPlaneName - The name of the packet core data plane. parameters - Parameters supplied to update packet core data plane tags. options - PacketCoreDataPlanesClientUpdateTagsOptions contains the optional parameters for the PacketCoreDataPlanesClient.UpdateTags method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/PacketCoreDataPlaneUpdateTags.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewPacketCoreDataPlanesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.UpdateTags(ctx,
		"rg1",
		"testPacketCoreCP",
		"testPacketCoreDP",
		armmobilenetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type PacketCoreDataPlanesClientBeginCreateOrUpdateOptions

type PacketCoreDataPlanesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PacketCoreDataPlanesClientBeginCreateOrUpdateOptions contains the optional parameters for the PacketCoreDataPlanesClient.BeginCreateOrUpdate method.

type PacketCoreDataPlanesClientBeginDeleteOptions

type PacketCoreDataPlanesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

PacketCoreDataPlanesClientBeginDeleteOptions contains the optional parameters for the PacketCoreDataPlanesClient.BeginDelete method.

type PacketCoreDataPlanesClientCreateOrUpdateResponse

type PacketCoreDataPlanesClientCreateOrUpdateResponse struct {
	PacketCoreDataPlane
}

PacketCoreDataPlanesClientCreateOrUpdateResponse contains the response from method PacketCoreDataPlanesClient.CreateOrUpdate.

type PacketCoreDataPlanesClientDeleteResponse

type PacketCoreDataPlanesClientDeleteResponse struct {
}

PacketCoreDataPlanesClientDeleteResponse contains the response from method PacketCoreDataPlanesClient.Delete.

type PacketCoreDataPlanesClientGetOptions

type PacketCoreDataPlanesClientGetOptions struct {
}

PacketCoreDataPlanesClientGetOptions contains the optional parameters for the PacketCoreDataPlanesClient.Get method.

type PacketCoreDataPlanesClientGetResponse

type PacketCoreDataPlanesClientGetResponse struct {
	PacketCoreDataPlane
}

PacketCoreDataPlanesClientGetResponse contains the response from method PacketCoreDataPlanesClient.Get.

type PacketCoreDataPlanesClientListByPacketCoreControlPlaneOptions

type PacketCoreDataPlanesClientListByPacketCoreControlPlaneOptions struct {
}

PacketCoreDataPlanesClientListByPacketCoreControlPlaneOptions contains the optional parameters for the PacketCoreDataPlanesClient.ListByPacketCoreControlPlane method.

type PacketCoreDataPlanesClientListByPacketCoreControlPlaneResponse

type PacketCoreDataPlanesClientListByPacketCoreControlPlaneResponse struct {
	PacketCoreDataPlaneListResult
}

PacketCoreDataPlanesClientListByPacketCoreControlPlaneResponse contains the response from method PacketCoreDataPlanesClient.ListByPacketCoreControlPlane.

type PacketCoreDataPlanesClientUpdateTagsOptions

type PacketCoreDataPlanesClientUpdateTagsOptions struct {
}

PacketCoreDataPlanesClientUpdateTagsOptions contains the optional parameters for the PacketCoreDataPlanesClient.UpdateTags method.

type PacketCoreDataPlanesClientUpdateTagsResponse

type PacketCoreDataPlanesClientUpdateTagsResponse struct {
	PacketCoreDataPlane
}

PacketCoreDataPlanesClientUpdateTagsResponse contains the response from method PacketCoreDataPlanesClient.UpdateTags.

type PccRuleConfiguration

type PccRuleConfiguration struct {
	// REQUIRED; The name of the rule. This must be unique within the parent service. You must not use any of the following reserved
	// strings - default, requested or service.
	RuleName *string `json:"ruleName,omitempty"`

	// REQUIRED; A precedence value that is used to decide between data flow policy rules when identifying the QoS values to use
	// for a particular SIM. A lower value means a higher priority. This value should be unique
	// among all data flow policy rules configured in the mobile network.
	RulePrecedence *int32 `json:"rulePrecedence,omitempty"`

	// REQUIRED; The set of data flow templates to use for this data flow policy rule.
	ServiceDataFlowTemplates []*ServiceDataFlowTemplate `json:"serviceDataFlowTemplates,omitempty"`

	// The QoS policy to use for packets matching this rule. If this field is null then the parent service will define the QoS
	// settings.
	RuleQosPolicy *PccRuleQosPolicy `json:"ruleQosPolicy,omitempty"`

	// Determines whether flows that match this data flow policy rule are permitted.
	TrafficControl *TrafficControlPermission `json:"trafficControl,omitempty"`
}

PccRuleConfiguration - Data flow policy rule configuration

func (PccRuleConfiguration) MarshalJSON

func (p PccRuleConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PccRuleConfiguration.

func (*PccRuleConfiguration) UnmarshalJSON added in v0.6.0

func (p *PccRuleConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PccRuleConfiguration.

type PccRuleQosPolicy

type PccRuleQosPolicy struct {
	// REQUIRED; The maximum bit rate (MBR) for all service data flows that use this data flow policy rule or service.
	MaximumBitRate *Ambr `json:"maximumBitRate,omitempty"`

	// QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority, if
	// the settings of preemptionCapability and preemptionVulnerability allow it. 1 is
	// the highest level of priority. If this field is not specified then 5qi is used to derive the ARP value. See 3GPP TS23.501
	// section 5.7.2.2 for a full description of the ARP parameters.
	AllocationAndRetentionPriorityLevel *int32 `json:"allocationAndRetentionPriorityLevel,omitempty"`

	// QoS Flow 5G QoS Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. This
	// must not be a standardized 5QI value corresponding to a GBR (guaranteed bit rate)
	// QoS Flow. The illegal GBR 5QI values are: 1, 2, 3, 4, 65, 66, 67, 71, 72, 73, 74, 75, 76, 82, 83, 84, and 85. See 3GPP
	// TS23.501 section 5.7.2.1 for a full description of the 5QI parameter, and table
	// 5.7.4-1 for the definition of which are the GBR 5QI values.
	FiveQi *int32 `json:"5qi,omitempty"`

	// The guaranteed bit rate (GBR) for all service data flows that use this data flow policy rule. This is an optional setting.
	// If you do not provide a value, there will be no GBR set for the data flow
	// policy rule that uses this QoS definition.
	GuaranteedBitRate *Ambr `json:"guaranteedBitRate,omitempty"`

	// QoS Flow preemption capability. The preemption capability of a QoS Flow controls whether it can preempt another QoS Flow
	// with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a full
	// description of the ARP parameters.
	PreemptionCapability *PreemptionCapability `json:"preemptionCapability,omitempty"`

	// QoS Flow preemption vulnerability. The preemption vulnerability of a QoS Flow controls whether it can be preempted by a
	// QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a
	// full description of the ARP parameters.
	PreemptionVulnerability *PreemptionVulnerability `json:"preemptionVulnerability,omitempty"`
}

PccRuleQosPolicy - Data flow policy rule QoS policy

func (PccRuleQosPolicy) MarshalJSON added in v0.6.0

func (p PccRuleQosPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PccRuleQosPolicy.

func (*PccRuleQosPolicy) UnmarshalJSON added in v0.6.0

func (p *PccRuleQosPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PccRuleQosPolicy.

type PduSessionType

type PduSessionType string

PduSessionType - PDU session type (IPv4/IPv6).

const (
	PduSessionTypeIPv4 PduSessionType = "IPv4"
	PduSessionTypeIPv6 PduSessionType = "IPv6"
)

func PossiblePduSessionTypeValues

func PossiblePduSessionTypeValues() []PduSessionType

PossiblePduSessionTypeValues returns the possible values for the PduSessionType const type.

type PinholeTimeouts

type PinholeTimeouts struct {
	// Pinhole timeout for ICMP pinholes in seconds. Default for ICMP Echo is 60 seconds, as per RFC 5508 section 3.2.
	Icmp *int32 `json:"icmp,omitempty"`

	// Pinhole timeout for TCP pinholes in seconds. Default for TCP is 2 hours 4 minutes, as per RFC 5382 section 5.
	TCP *int32 `json:"tcp,omitempty"`

	// Pinhole timeout for UDP pinholes in seconds. Default for UDP is 5 minutes, as per RFC 4787 section 4.3.
	UDP *int32 `json:"udp,omitempty"`
}

PinholeTimeouts - Expiry times of inactive NAPT pinholes, in seconds. All timers must be at least 1 second.

func (PinholeTimeouts) MarshalJSON added in v0.6.0

func (p PinholeTimeouts) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PinholeTimeouts.

func (*PinholeTimeouts) UnmarshalJSON added in v0.6.0

func (p *PinholeTimeouts) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PinholeTimeouts.

type PlatformConfiguration added in v0.6.0

type PlatformConfiguration struct {
	// REQUIRED; The platform type where packet core is deployed.
	Type *PlatformType `json:"type,omitempty"`

	// The Azure Stack Edge device where where the packet core is deployed. If the device is part of a fault tolerant pair, either
	// device in the pair can be specified.
	AzureStackEdgeDevice *AzureStackEdgeDeviceResourceID `json:"azureStackEdgeDevice,omitempty"`

	// Azure Arc connected cluster where the packet core is deployed.
	ConnectedCluster *ConnectedClusterResourceID `json:"connectedCluster,omitempty"`

	// Azure Arc custom location where the packet core is deployed.
	CustomLocation *CustomLocationResourceID `json:"customLocation,omitempty"`
}

PlatformConfiguration - The platform where the packet core is deployed.

func (PlatformConfiguration) MarshalJSON added in v0.6.0

func (p PlatformConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PlatformConfiguration.

func (*PlatformConfiguration) UnmarshalJSON added in v0.6.0

func (p *PlatformConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PlatformConfiguration.

type PlatformType added in v0.6.0

type PlatformType string

PlatformType - The platform type where packet core is deployed. The contents of this enum can change.

const (
	// PlatformTypeAKSHCI - If this option is chosen, you must set one of "azureStackEdgeDevice", "connectedCluster" or "customLocation".
	// If multiple are set then "customLocation" will take precedence over "connectedCluster" which takes precedence over "azureStackEdgeDevice".
	PlatformTypeAKSHCI PlatformType = "AKS-HCI"
	// PlatformTypeBaseVM - If this option is chosen, you must set one of "connectedCluster" or "customLocation". If multiple
	// are set then "customLocation" will take precedence over "connectedCluster".
	PlatformTypeBaseVM PlatformType = "BaseVM"
)

func PossiblePlatformTypeValues added in v0.6.0

func PossiblePlatformTypeValues() []PlatformType

PossiblePlatformTypeValues returns the possible values for the PlatformType const type.

type PlmnID

type PlmnID struct {
	// REQUIRED; Mobile country code (MCC).
	Mcc *string `json:"mcc,omitempty"`

	// REQUIRED; Mobile network code (MNC).
	Mnc *string `json:"mnc,omitempty"`
}

PlmnID - Public land mobile network (PLMN) ID.

func (PlmnID) MarshalJSON added in v0.6.0

func (p PlmnID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PlmnID.

func (*PlmnID) UnmarshalJSON added in v0.6.0

func (p *PlmnID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PlmnID.

type PortRange

type PortRange struct {
	// The maximum port number
	MaxPort *int32 `json:"maxPort,omitempty"`

	// The minimum port number
	MinPort *int32 `json:"minPort,omitempty"`
}

PortRange - Range of port numbers to use as translated ports on each translated address. If not specified and NAPT is enabled, this range defaults to 1,024 - 49,999. (Ports under 1,024 should not be used because these are special purpose ports reserved by IANA. Ports 50,000 and above are reserved for non-NAPT use.)

func (PortRange) MarshalJSON added in v0.6.0

func (p PortRange) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PortRange.

func (*PortRange) UnmarshalJSON added in v0.6.0

func (p *PortRange) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PortRange.

type PortReuseHoldTimes

type PortReuseHoldTimes struct {
	// Minimum time in seconds that will pass before a TCP port that was used by a closed pinhole can be reused. Default for TCP
	// is 2 minutes.
	TCP *int32 `json:"tcp,omitempty"`

	// Minimum time in seconds that will pass before a UDP port that was used by a closed pinhole can be reused. Default for UDP
	// is 1 minute.
	UDP *int32 `json:"udp,omitempty"`
}

PortReuseHoldTimes - The minimum time (in seconds) that will pass before a port that was used by a closed pinhole can be recycled for use by another pinhole. All hold times must be minimum 1 second.

func (PortReuseHoldTimes) MarshalJSON added in v0.6.0

func (p PortReuseHoldTimes) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PortReuseHoldTimes.

func (*PortReuseHoldTimes) UnmarshalJSON added in v0.6.0

func (p *PortReuseHoldTimes) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PortReuseHoldTimes.

type PreemptionCapability

type PreemptionCapability string

PreemptionCapability - Preemption capability.

const (
	// PreemptionCapabilityMayPreempt - May preempt
	PreemptionCapabilityMayPreempt PreemptionCapability = "MayPreempt"
	// PreemptionCapabilityNotPreempt - Cannot preempt
	PreemptionCapabilityNotPreempt PreemptionCapability = "NotPreempt"
)

func PossiblePreemptionCapabilityValues

func PossiblePreemptionCapabilityValues() []PreemptionCapability

PossiblePreemptionCapabilityValues returns the possible values for the PreemptionCapability const type.

type PreemptionVulnerability

type PreemptionVulnerability string

PreemptionVulnerability - Preemption vulnerability.

const (
	// PreemptionVulnerabilityNotPreemptable - Cannot be preempted
	PreemptionVulnerabilityNotPreemptable PreemptionVulnerability = "NotPreemptable"
	// PreemptionVulnerabilityPreemptable - May be preempted
	PreemptionVulnerabilityPreemptable PreemptionVulnerability = "Preemptable"
)

func PossiblePreemptionVulnerabilityValues

func PossiblePreemptionVulnerabilityValues() []PreemptionVulnerability

PossiblePreemptionVulnerabilityValues returns the possible values for the PreemptionVulnerability const type.

type PropertiesFormat

type PropertiesFormat struct {
	// REQUIRED; The unique public land mobile network identifier for the network. This is made up of the mobile country code
	// and mobile network code, as defined in https://www.itu.int/rec/T-REC-E.212. The values
	// 001-01 and 001-001 can be used for testing and the values 999-99 and 999-999 can be used on internal private networks.
	PublicLandMobileNetworkIdentifier *PlmnID `json:"publicLandMobileNetworkIdentifier,omitempty"`

	// READ-ONLY; The provisioning state of the mobile network resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The mobile network resource identifier
	ServiceKey *string `json:"serviceKey,omitempty" azure:"ro"`
}

PropertiesFormat - Mobile network properties.

func (PropertiesFormat) MarshalJSON added in v0.6.0

func (p PropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PropertiesFormat.

func (*PropertiesFormat) UnmarshalJSON added in v0.6.0

func (p *PropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PropertiesFormat.

type ProvisioningState

type ProvisioningState string

ProvisioningState - The current provisioning state.

const (
	ProvisioningStateAccepted  ProvisioningState = "Accepted"
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateDeleted   ProvisioningState = "Deleted"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	ProvisioningStateUnknown   ProvisioningState = "Unknown"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type ProxyResource added in v0.6.0

type ProxyResource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

ProxyResource - The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

func (ProxyResource) MarshalJSON added in v0.6.0

func (p ProxyResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProxyResource.

func (*ProxyResource) UnmarshalJSON added in v0.6.0

func (p *ProxyResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProxyResource.

type QosPolicy

type QosPolicy struct {
	// REQUIRED; The maximum bit rate (MBR) for all service data flows that use this data flow policy rule or service.
	MaximumBitRate *Ambr `json:"maximumBitRate,omitempty"`

	// QoS Flow allocation and retention priority (ARP) level. Flows with higher priority preempt flows with lower priority, if
	// the settings of preemptionCapability and preemptionVulnerability allow it. 1 is
	// the highest level of priority. If this field is not specified then 5qi is used to derive the ARP value. See 3GPP TS23.501
	// section 5.7.2.2 for a full description of the ARP parameters.
	AllocationAndRetentionPriorityLevel *int32 `json:"allocationAndRetentionPriorityLevel,omitempty"`

	// QoS Flow 5G QoS Indicator value. The 5QI identifies a specific QoS forwarding treatment to be provided to a flow. This
	// must not be a standardized 5QI value corresponding to a GBR (guaranteed bit rate)
	// QoS Flow. The illegal GBR 5QI values are: 1, 2, 3, 4, 65, 66, 67, 71, 72, 73, 74, 75, 76, 82, 83, 84, and 85. See 3GPP
	// TS23.501 section 5.7.2.1 for a full description of the 5QI parameter, and table
	// 5.7.4-1 for the definition of which are the GBR 5QI values.
	FiveQi *int32 `json:"5qi,omitempty"`

	// QoS Flow preemption capability. The preemption capability of a QoS Flow controls whether it can preempt another QoS Flow
	// with a lower priority level. See 3GPP TS23.501 section 5.7.2.2 for a full
	// description of the ARP parameters.
	PreemptionCapability *PreemptionCapability `json:"preemptionCapability,omitempty"`

	// QoS Flow preemption vulnerability. The preemption vulnerability of a QoS Flow controls whether it can be preempted by a
	// QoS Flow with a higher priority level. See 3GPP TS23.501 section 5.7.2.2 for a
	// full description of the ARP parameters.
	PreemptionVulnerability *PreemptionVulnerability `json:"preemptionVulnerability,omitempty"`
}

QosPolicy - QoS policy

func (QosPolicy) MarshalJSON added in v0.6.0

func (q QosPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type QosPolicy.

func (*QosPolicy) UnmarshalJSON added in v0.6.0

func (q *QosPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type QosPolicy.

type RecommendedVersion added in v0.6.0

type RecommendedVersion string

RecommendedVersion - Indicates whether this is the recommended version to use for new packet core control plane deployments.

const (
	// RecommendedVersionNotRecommended - This is not the recommended version to use for new packet core control plane deployments.
	RecommendedVersionNotRecommended RecommendedVersion = "NotRecommended"
	// RecommendedVersionRecommended - This is the recommended version to use for new packet core control plane deployments.
	RecommendedVersionRecommended RecommendedVersion = "Recommended"
)

func PossibleRecommendedVersionValues added in v0.6.0

func PossibleRecommendedVersionValues() []RecommendedVersion

PossibleRecommendedVersionValues returns the possible values for the RecommendedVersion const type.

type Resource

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON added in v0.6.0

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON added in v0.6.0

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceID

type ResourceID struct {
	// REQUIRED; Mobile network resource ID.
	ID *string `json:"id,omitempty"`
}

ResourceID - Reference to a mobile network resource.

func (ResourceID) MarshalJSON added in v0.6.0

func (r ResourceID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceID.

func (*ResourceID) UnmarshalJSON added in v0.6.0

func (r *ResourceID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceID.

type SdfDirection

type SdfDirection string

SdfDirection - Service data flow direction.

const (
	// SdfDirectionBidirectional - Traffic flowing both to and from the UE.
	SdfDirectionBidirectional SdfDirection = "Bidirectional"
	// SdfDirectionDownlink - Traffic flowing from the data network to the UE.
	SdfDirectionDownlink SdfDirection = "Downlink"
	// SdfDirectionUplink - Traffic flowing from the UE to the data network.
	SdfDirectionUplink SdfDirection = "Uplink"
)

func PossibleSdfDirectionValues

func PossibleSdfDirectionValues() []SdfDirection

PossibleSdfDirectionValues returns the possible values for the SdfDirection const type.

type Service

type Service struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// REQUIRED; Service Properties.
	Properties *ServicePropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Service resource.

func (Service) MarshalJSON

func (s Service) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Service.

func (*Service) UnmarshalJSON added in v0.6.0

func (s *Service) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Service.

type ServiceDataFlowTemplate

type ServiceDataFlowTemplate struct {
	// REQUIRED; The direction of this flow.
	Direction *SdfDirection `json:"direction,omitempty"`

	// REQUIRED; A list of the allowed protocol(s) for this flow. If you want this flow to be able to use any protocol within
	// the internet protocol suite, use the value ip. If you only want to allow a selection of
	// protocols, you must use the corresponding IANA Assigned Internet Protocol Number for each protocol, as described in https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml.
	// For
	// example, for UDP, you must use 17. If you use the value ip then you must leave the field port unspecified.
	Protocol []*string `json:"protocol,omitempty"`

	// REQUIRED; The remote IP address(es) to which UEs will connect for this flow. If you want to allow connections on any IP
	// address, use the value any. Otherwise, you must provide each of the remote IP addresses to
	// which the packet core instance will connect for this flow. You must provide each IP address in CIDR notation, including
	// the netmask (for example, 192.0.2.54/24).
	RemoteIPList []*string `json:"remoteIpList,omitempty"`

	// REQUIRED; The name of the data flow template. This must be unique within the parent data flow policy rule. You must not
	// use any of the following reserved strings - default, requested or service.
	TemplateName *string `json:"templateName,omitempty"`

	// The port(s) to which UEs will connect for this flow. You can specify zero or more ports or port ranges. If you specify
	// one or more ports or port ranges then you must specify a value other than ip in
	// the protocol field. This is an optional setting. If you do not specify it then connections will be allowed on all ports.
	// Port ranges must be specified as -. For example: [8080, 8082-8085].
	Ports []*string `json:"ports,omitempty"`
}

ServiceDataFlowTemplate - Data flow template

func (ServiceDataFlowTemplate) MarshalJSON

func (s ServiceDataFlowTemplate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceDataFlowTemplate.

func (*ServiceDataFlowTemplate) UnmarshalJSON added in v0.6.0

func (s *ServiceDataFlowTemplate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceDataFlowTemplate.

type ServiceListResult

type ServiceListResult struct {
	// A list of services.
	Value []*Service `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

ServiceListResult - Response for services API service call.

func (ServiceListResult) MarshalJSON

func (s ServiceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceListResult.

func (*ServiceListResult) UnmarshalJSON added in v0.6.0

func (s *ServiceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceListResult.

type ServicePropertiesFormat

type ServicePropertiesFormat struct {
	// REQUIRED; The set of data flow policy rules that make up this service.
	PccRules []*PccRuleConfiguration `json:"pccRules,omitempty"`

	// REQUIRED; A precedence value that is used to decide between services when identifying the QoS values to use for a particular
	// SIM. A lower value means a higher priority. This value should be unique among all
	// services configured in the mobile network.
	ServicePrecedence *int32 `json:"servicePrecedence,omitempty"`

	// The QoS policy to use for packets matching this service. This can be overridden for particular flows using the ruleQosPolicy
	// field in a PccRuleConfiguration. If this field is null then the UE's SIM
	// policy will define the QoS settings.
	ServiceQosPolicy *QosPolicy `json:"serviceQosPolicy,omitempty"`

	// READ-ONLY; The provisioning state of the service resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

ServicePropertiesFormat - Service properties.

func (ServicePropertiesFormat) MarshalJSON

func (s ServicePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServicePropertiesFormat.

func (*ServicePropertiesFormat) UnmarshalJSON added in v0.6.0

func (s *ServicePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServicePropertiesFormat.

type ServiceResourceID

type ServiceResourceID struct {
	// REQUIRED; Service resource ID.
	ID *string `json:"id,omitempty"`
}

ServiceResourceID - Reference to a service resource.

func (ServiceResourceID) MarshalJSON added in v0.6.0

func (s ServiceResourceID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ServiceResourceID.

func (*ServiceResourceID) UnmarshalJSON added in v0.6.0

func (s *ServiceResourceID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ServiceResourceID.

type ServicesClient

type ServicesClient struct {
	// contains filtered or unexported fields
}

ServicesClient contains the methods for the Services group. Don't use this type directly, use NewServicesClient() instead.

func NewServicesClient

func NewServicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ServicesClient, error)

NewServicesClient creates a new instance of ServicesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*ServicesClient) BeginCreateOrUpdate

func (client *ServicesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, mobileNetworkName string, serviceName string, parameters Service, options *ServicesClientBeginCreateOrUpdateOptions) (*runtime.Poller[ServicesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a service. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. serviceName - The name of the service. You must not use any of the following reserved strings - default, requested or service parameters - Parameters supplied to the create or update service operation. options - ServicesClientBeginCreateOrUpdateOptions contains the optional parameters for the ServicesClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/ServiceCreate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewServicesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"testMobileNetwork",
		"TestService",
		armmobilenetwork.Service{
			Location: to.Ptr("eastus"),
			Properties: &armmobilenetwork.ServicePropertiesFormat{
				PccRules: []*armmobilenetwork.PccRuleConfiguration{
					{
						RuleName:       to.Ptr("default-rule"),
						RulePrecedence: to.Ptr[int32](255),
						RuleQosPolicy: &armmobilenetwork.PccRuleQosPolicy{
							FiveQi:                              to.Ptr[int32](9),
							AllocationAndRetentionPriorityLevel: to.Ptr[int32](9),
							MaximumBitRate: &armmobilenetwork.Ambr{
								Downlink: to.Ptr("1 Gbps"),
								Uplink:   to.Ptr("500 Mbps"),
							},
							PreemptionCapability:    to.Ptr(armmobilenetwork.PreemptionCapabilityNotPreempt),
							PreemptionVulnerability: to.Ptr(armmobilenetwork.PreemptionVulnerabilityPreemptable),
						},
						ServiceDataFlowTemplates: []*armmobilenetwork.ServiceDataFlowTemplate{
							{
								Direction: to.Ptr(armmobilenetwork.SdfDirectionUplink),
								Ports:     []*string{},
								RemoteIPList: []*string{
									to.Ptr("10.3.4.0/24")},
								TemplateName: to.Ptr("IP-to-server"),
								Protocol: []*string{
									to.Ptr("ip")},
							}},
						TrafficControl: to.Ptr(armmobilenetwork.TrafficControlPermissionEnabled),
					}},
				ServicePrecedence: to.Ptr[int32](255),
				ServiceQosPolicy: &armmobilenetwork.QosPolicy{
					FiveQi:                              to.Ptr[int32](9),
					AllocationAndRetentionPriorityLevel: to.Ptr[int32](9),
					MaximumBitRate: &armmobilenetwork.Ambr{
						Downlink: to.Ptr("1 Gbps"),
						Uplink:   to.Ptr("500 Mbps"),
					},
					PreemptionCapability:    to.Ptr(armmobilenetwork.PreemptionCapabilityNotPreempt),
					PreemptionVulnerability: to.Ptr(armmobilenetwork.PreemptionVulnerabilityPreemptable),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*ServicesClient) BeginDelete

func (client *ServicesClient) BeginDelete(ctx context.Context, resourceGroupName string, mobileNetworkName string, serviceName string, options *ServicesClientBeginDeleteOptions) (*runtime.Poller[ServicesClientDeleteResponse], error)

BeginDelete - Deletes the specified service. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. serviceName - The name of the service. You must not use any of the following reserved strings - default, requested or service options - ServicesClientBeginDeleteOptions contains the optional parameters for the ServicesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/ServiceDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewServicesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"rg1",
		"testMobileNetwork",
		"TestService",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*ServicesClient) Get

func (client *ServicesClient) Get(ctx context.Context, resourceGroupName string, mobileNetworkName string, serviceName string, options *ServicesClientGetOptions) (ServicesClientGetResponse, error)

Get - Gets information about the specified service. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. serviceName - The name of the service. You must not use any of the following reserved strings - default, requested or service options - ServicesClientGetOptions contains the optional parameters for the ServicesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/ServiceGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewServicesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"testMobileNetwork",
		"TestService",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*ServicesClient) NewListByMobileNetworkPager added in v0.4.0

func (client *ServicesClient) NewListByMobileNetworkPager(resourceGroupName string, mobileNetworkName string, options *ServicesClientListByMobileNetworkOptions) *runtime.Pager[ServicesClientListByMobileNetworkResponse]

NewListByMobileNetworkPager - Gets all the services in a mobile network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. options - ServicesClientListByMobileNetworkOptions contains the optional parameters for the ServicesClient.ListByMobileNetwork method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/ServiceListByMobileNetwork.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewServicesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByMobileNetworkPager("testResourceGroupName",
		"testMobileNetwork",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*ServicesClient) UpdateTags

func (client *ServicesClient) UpdateTags(ctx context.Context, resourceGroupName string, mobileNetworkName string, serviceName string, parameters TagsObject, options *ServicesClientUpdateTagsOptions) (ServicesClientUpdateTagsResponse, error)

UpdateTags - Updates service tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. serviceName - The name of the service. You must not use any of the following reserved strings - default, requested or service parameters - Parameters supplied to update service tags. options - ServicesClientUpdateTagsOptions contains the optional parameters for the ServicesClient.UpdateTags method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/ServiceUpdateTags.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewServicesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.UpdateTags(ctx,
		"rg1",
		"testMobileNetwork",
		"TestService",
		armmobilenetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type ServicesClientBeginCreateOrUpdateOptions

type ServicesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ServicesClientBeginCreateOrUpdateOptions contains the optional parameters for the ServicesClient.BeginCreateOrUpdate method.

type ServicesClientBeginDeleteOptions

type ServicesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

ServicesClientBeginDeleteOptions contains the optional parameters for the ServicesClient.BeginDelete method.

type ServicesClientCreateOrUpdateResponse

type ServicesClientCreateOrUpdateResponse struct {
	Service
}

ServicesClientCreateOrUpdateResponse contains the response from method ServicesClient.CreateOrUpdate.

type ServicesClientDeleteResponse

type ServicesClientDeleteResponse struct {
}

ServicesClientDeleteResponse contains the response from method ServicesClient.Delete.

type ServicesClientGetOptions

type ServicesClientGetOptions struct {
}

ServicesClientGetOptions contains the optional parameters for the ServicesClient.Get method.

type ServicesClientGetResponse

type ServicesClientGetResponse struct {
	Service
}

ServicesClientGetResponse contains the response from method ServicesClient.Get.

type ServicesClientListByMobileNetworkOptions

type ServicesClientListByMobileNetworkOptions struct {
}

ServicesClientListByMobileNetworkOptions contains the optional parameters for the ServicesClient.ListByMobileNetwork method.

type ServicesClientListByMobileNetworkResponse

type ServicesClientListByMobileNetworkResponse struct {
	ServiceListResult
}

ServicesClientListByMobileNetworkResponse contains the response from method ServicesClient.ListByMobileNetwork.

type ServicesClientUpdateTagsOptions

type ServicesClientUpdateTagsOptions struct {
}

ServicesClientUpdateTagsOptions contains the optional parameters for the ServicesClient.UpdateTags method.

type ServicesClientUpdateTagsResponse

type ServicesClientUpdateTagsResponse struct {
	Service
}

ServicesClientUpdateTagsResponse contains the response from method ServicesClient.UpdateTags.

type Sim

type Sim struct {
	// REQUIRED; SIM Properties.
	Properties *SimPropertiesFormat `json:"properties,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Sim - SIM resource.

func (Sim) MarshalJSON

func (s Sim) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Sim.

func (*Sim) UnmarshalJSON added in v0.6.0

func (s *Sim) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Sim.

type SimGroup added in v0.6.0

type SimGroup struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// REQUIRED; SIM group Properties.
	Properties *SimGroupPropertiesFormat `json:"properties,omitempty"`

	// The identity used to retrieve the encryption key from Azure key vault.
	Identity *ManagedServiceIdentity `json:"identity,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

SimGroup - SIM group resource.

func (SimGroup) MarshalJSON added in v0.6.0

func (s SimGroup) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SimGroup.

func (*SimGroup) UnmarshalJSON added in v0.6.0

func (s *SimGroup) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SimGroup.

type SimGroupListResult added in v0.6.0

type SimGroupListResult struct {
	// A list of SIM groups in a resource group.
	Value []*SimGroup `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

SimGroupListResult - Response for list SIM groups API service call.

func (SimGroupListResult) MarshalJSON added in v0.6.0

func (s SimGroupListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SimGroupListResult.

func (*SimGroupListResult) UnmarshalJSON added in v0.6.0

func (s *SimGroupListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SimGroupListResult.

type SimGroupPropertiesFormat added in v0.6.0

type SimGroupPropertiesFormat struct {
	// A key to encrypt the SIM data that belongs to this SIM group.
	EncryptionKey *KeyVaultKey `json:"encryptionKey,omitempty"`

	// Mobile network that this SIM belongs to
	MobileNetwork *ResourceID `json:"mobileNetwork,omitempty"`

	// READ-ONLY; The provisioning state of the SIM group resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

SimGroupPropertiesFormat - SIM group properties.

func (SimGroupPropertiesFormat) MarshalJSON added in v0.6.0

func (s SimGroupPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SimGroupPropertiesFormat.

func (*SimGroupPropertiesFormat) UnmarshalJSON added in v0.6.0

func (s *SimGroupPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SimGroupPropertiesFormat.

type SimGroupResourceID added in v0.6.0

type SimGroupResourceID struct {
	// REQUIRED; SIM group resource ID.
	ID *string `json:"id,omitempty"`
}

SimGroupResourceID - Reference to a SIM group resource.

func (SimGroupResourceID) MarshalJSON added in v0.6.0

func (s SimGroupResourceID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SimGroupResourceID.

func (*SimGroupResourceID) UnmarshalJSON added in v0.6.0

func (s *SimGroupResourceID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SimGroupResourceID.

type SimGroupsClient added in v0.6.0

type SimGroupsClient struct {
	// contains filtered or unexported fields
}

SimGroupsClient contains the methods for the SimGroups group. Don't use this type directly, use NewSimGroupsClient() instead.

func NewSimGroupsClient added in v0.6.0

func NewSimGroupsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SimGroupsClient, error)

NewSimGroupsClient creates a new instance of SimGroupsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SimGroupsClient) BeginCreateOrUpdate added in v0.6.0

func (client *SimGroupsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, simGroupName string, parameters SimGroup, options *SimGroupsClientBeginCreateOrUpdateOptions) (*runtime.Poller[SimGroupsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a SIM group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. simGroupName - The name of the SIM Group. parameters - Parameters supplied to the create or update SIM group operation. options - SimGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the SimGroupsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimGroupCreate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimGroupsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"testSimGroup",
		armmobilenetwork.SimGroup{
			Location: to.Ptr("eastus"),
			Properties: &armmobilenetwork.SimGroupPropertiesFormat{
				EncryptionKey: &armmobilenetwork.KeyVaultKey{
					KeyURL: to.Ptr("https://contosovault.vault.azure.net/keys/azureKey"),
				},
				MobileNetwork: &armmobilenetwork.ResourceID{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*SimGroupsClient) BeginDelete added in v0.6.0

func (client *SimGroupsClient) BeginDelete(ctx context.Context, resourceGroupName string, simGroupName string, options *SimGroupsClientBeginDeleteOptions) (*runtime.Poller[SimGroupsClientDeleteResponse], error)

BeginDelete - Deletes the specified SIM group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. simGroupName - The name of the SIM Group. options - SimGroupsClientBeginDeleteOptions contains the optional parameters for the SimGroupsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimGroupDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimGroupsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"testResourceGroupName",
		"testSimGroup",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*SimGroupsClient) Get added in v0.6.0

func (client *SimGroupsClient) Get(ctx context.Context, resourceGroupName string, simGroupName string, options *SimGroupsClientGetOptions) (SimGroupsClientGetResponse, error)

Get - Gets information about the specified SIM group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. simGroupName - The name of the SIM Group. options - SimGroupsClientGetOptions contains the optional parameters for the SimGroupsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimGroupGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimGroupsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"testResourceGroupName",
		"testSimGroupName",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*SimGroupsClient) NewListByResourceGroupPager added in v0.6.0

func (client *SimGroupsClient) NewListByResourceGroupPager(resourceGroupName string, options *SimGroupsClientListByResourceGroupOptions) *runtime.Pager[SimGroupsClientListByResourceGroupResponse]

NewListByResourceGroupPager - Gets all the SIM groups in a resource group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. options - SimGroupsClientListByResourceGroupOptions contains the optional parameters for the SimGroupsClient.ListByResourceGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimGroupListByResourceGroup.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimGroupsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("rg1",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*SimGroupsClient) NewListBySubscriptionPager added in v0.6.0

NewListBySubscriptionPager - Gets all the SIM groups in a subscription. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview options - SimGroupsClientListBySubscriptionOptions contains the optional parameters for the SimGroupsClient.ListBySubscription method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimGroupListBySubscription.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimGroupsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySubscriptionPager(nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*SimGroupsClient) UpdateTags added in v0.6.0

func (client *SimGroupsClient) UpdateTags(ctx context.Context, resourceGroupName string, simGroupName string, parameters TagsObject, options *SimGroupsClientUpdateTagsOptions) (SimGroupsClientUpdateTagsResponse, error)

UpdateTags - Updates SIM group tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. simGroupName - The name of the SIM Group. parameters - Parameters supplied to update SIM group tags. options - SimGroupsClientUpdateTagsOptions contains the optional parameters for the SimGroupsClient.UpdateTags method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimGroupUpdateTags.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimGroupsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.UpdateTags(ctx,
		"rg1",
		"testSimGroup",
		armmobilenetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type SimGroupsClientBeginCreateOrUpdateOptions added in v0.6.0

type SimGroupsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SimGroupsClientBeginCreateOrUpdateOptions contains the optional parameters for the SimGroupsClient.BeginCreateOrUpdate method.

type SimGroupsClientBeginDeleteOptions added in v0.6.0

type SimGroupsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SimGroupsClientBeginDeleteOptions contains the optional parameters for the SimGroupsClient.BeginDelete method.

type SimGroupsClientCreateOrUpdateResponse added in v0.6.0

type SimGroupsClientCreateOrUpdateResponse struct {
	SimGroup
}

SimGroupsClientCreateOrUpdateResponse contains the response from method SimGroupsClient.CreateOrUpdate.

type SimGroupsClientDeleteResponse added in v0.6.0

type SimGroupsClientDeleteResponse struct {
}

SimGroupsClientDeleteResponse contains the response from method SimGroupsClient.Delete.

type SimGroupsClientGetOptions added in v0.6.0

type SimGroupsClientGetOptions struct {
}

SimGroupsClientGetOptions contains the optional parameters for the SimGroupsClient.Get method.

type SimGroupsClientGetResponse added in v0.6.0

type SimGroupsClientGetResponse struct {
	SimGroup
}

SimGroupsClientGetResponse contains the response from method SimGroupsClient.Get.

type SimGroupsClientListByResourceGroupOptions added in v0.6.0

type SimGroupsClientListByResourceGroupOptions struct {
}

SimGroupsClientListByResourceGroupOptions contains the optional parameters for the SimGroupsClient.ListByResourceGroup method.

type SimGroupsClientListByResourceGroupResponse added in v0.6.0

type SimGroupsClientListByResourceGroupResponse struct {
	SimGroupListResult
}

SimGroupsClientListByResourceGroupResponse contains the response from method SimGroupsClient.ListByResourceGroup.

type SimGroupsClientListBySubscriptionOptions added in v0.6.0

type SimGroupsClientListBySubscriptionOptions struct {
}

SimGroupsClientListBySubscriptionOptions contains the optional parameters for the SimGroupsClient.ListBySubscription method.

type SimGroupsClientListBySubscriptionResponse added in v0.6.0

type SimGroupsClientListBySubscriptionResponse struct {
	SimGroupListResult
}

SimGroupsClientListBySubscriptionResponse contains the response from method SimGroupsClient.ListBySubscription.

type SimGroupsClientUpdateTagsOptions added in v0.6.0

type SimGroupsClientUpdateTagsOptions struct {
}

SimGroupsClientUpdateTagsOptions contains the optional parameters for the SimGroupsClient.UpdateTags method.

type SimGroupsClientUpdateTagsResponse added in v0.6.0

type SimGroupsClientUpdateTagsResponse struct {
	SimGroup
}

SimGroupsClientUpdateTagsResponse contains the response from method SimGroupsClient.UpdateTags.

type SimIDListResult

type SimIDListResult struct {
	// A list of SIM IDs.
	Value []*SubResource `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

SimIDListResult - Response for list SIM IDs API service call.

func (SimIDListResult) MarshalJSON

func (s SimIDListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SimIDListResult.

func (*SimIDListResult) UnmarshalJSON added in v0.6.0

func (s *SimIDListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SimIDListResult.

type SimListResult

type SimListResult struct {
	// A list of SIMs in a resource group.
	Value []*Sim `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

SimListResult - Response for list SIMs API service call.

func (SimListResult) MarshalJSON

func (s SimListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SimListResult.

func (*SimListResult) UnmarshalJSON added in v0.6.0

func (s *SimListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SimListResult.

type SimPoliciesClient

type SimPoliciesClient struct {
	// contains filtered or unexported fields
}

SimPoliciesClient contains the methods for the SimPolicies group. Don't use this type directly, use NewSimPoliciesClient() instead.

func NewSimPoliciesClient

func NewSimPoliciesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SimPoliciesClient, error)

NewSimPoliciesClient creates a new instance of SimPoliciesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SimPoliciesClient) BeginCreateOrUpdate

func (client *SimPoliciesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, mobileNetworkName string, simPolicyName string, parameters SimPolicy, options *SimPoliciesClientBeginCreateOrUpdateOptions) (*runtime.Poller[SimPoliciesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a SIM policy. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. simPolicyName - The name of the SIM policy. parameters - Parameters supplied to the create or update SIM policy operation. options - SimPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the SimPoliciesClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimPolicyCreate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimPoliciesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"testMobileNetwork",
		"testPolicy",
		armmobilenetwork.SimPolicy{
			Location: to.Ptr("eastus"),
			Properties: &armmobilenetwork.SimPolicyPropertiesFormat{
				DefaultSlice: &armmobilenetwork.SliceResourceID{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"),
				},
				RegistrationTimer: to.Ptr[int32](3240),
				SliceConfigurations: []*armmobilenetwork.SliceConfiguration{
					{
						DataNetworkConfigurations: []*armmobilenetwork.DataNetworkConfiguration{
							{
								FiveQi:                              to.Ptr[int32](9),
								AdditionalAllowedSessionTypes:       []*armmobilenetwork.PduSessionType{},
								AllocationAndRetentionPriorityLevel: to.Ptr[int32](9),
								AllowedServices: []*armmobilenetwork.ServiceResourceID{
									{
										ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/services/testService"),
									}},
								DataNetwork: &armmobilenetwork.DataNetworkResourceID{
									ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork"),
								},
								DefaultSessionType:      to.Ptr(armmobilenetwork.PduSessionTypeIPv4),
								PreemptionCapability:    to.Ptr(armmobilenetwork.PreemptionCapabilityNotPreempt),
								PreemptionVulnerability: to.Ptr(armmobilenetwork.PreemptionVulnerabilityPreemptable),
								SessionAmbr: &armmobilenetwork.Ambr{
									Downlink: to.Ptr("1 Gbps"),
									Uplink:   to.Ptr("500 Mbps"),
								},
							}},
						DefaultDataNetwork: &armmobilenetwork.DataNetworkResourceID{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/dataNetworks/testdataNetwork"),
						},
						Slice: &armmobilenetwork.SliceResourceID{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"),
						},
					}},
				UeAmbr: &armmobilenetwork.Ambr{
					Downlink: to.Ptr("1 Gbps"),
					Uplink:   to.Ptr("500 Mbps"),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*SimPoliciesClient) BeginDelete

func (client *SimPoliciesClient) BeginDelete(ctx context.Context, resourceGroupName string, mobileNetworkName string, simPolicyName string, options *SimPoliciesClientBeginDeleteOptions) (*runtime.Poller[SimPoliciesClientDeleteResponse], error)

BeginDelete - Deletes the specified SIM policy. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. simPolicyName - The name of the SIM policy. options - SimPoliciesClientBeginDeleteOptions contains the optional parameters for the SimPoliciesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimPolicyDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimPoliciesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"rg1",
		"testMobileNetwork",
		"testPolicy",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*SimPoliciesClient) Get

func (client *SimPoliciesClient) Get(ctx context.Context, resourceGroupName string, mobileNetworkName string, simPolicyName string, options *SimPoliciesClientGetOptions) (SimPoliciesClientGetResponse, error)

Get - Gets information about the specified SIM policy. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. simPolicyName - The name of the SIM policy. options - SimPoliciesClientGetOptions contains the optional parameters for the SimPoliciesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimPolicyGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimPoliciesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"testMobileNetwork",
		"testPolicy",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*SimPoliciesClient) NewListByMobileNetworkPager added in v0.4.0

func (client *SimPoliciesClient) NewListByMobileNetworkPager(resourceGroupName string, mobileNetworkName string, options *SimPoliciesClientListByMobileNetworkOptions) *runtime.Pager[SimPoliciesClientListByMobileNetworkResponse]

NewListByMobileNetworkPager - Gets all the SIM policies in a mobile network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. options - SimPoliciesClientListByMobileNetworkOptions contains the optional parameters for the SimPoliciesClient.ListByMobileNetwork method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimPolicyListByMobileNetwork.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimPoliciesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByMobileNetworkPager("testResourceGroupName",
		"testMobileNetwork",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*SimPoliciesClient) UpdateTags

func (client *SimPoliciesClient) UpdateTags(ctx context.Context, resourceGroupName string, mobileNetworkName string, simPolicyName string, parameters TagsObject, options *SimPoliciesClientUpdateTagsOptions) (SimPoliciesClientUpdateTagsResponse, error)

UpdateTags - Updates SIM policy tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. simPolicyName - The name of the SIM policy. parameters - Parameters supplied to update SIM policy tags. options - SimPoliciesClientUpdateTagsOptions contains the optional parameters for the SimPoliciesClient.UpdateTags method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimPolicyUpdateTags.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimPoliciesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.UpdateTags(ctx,
		"rg1",
		"testMobileNetwork",
		"testPolicy",
		armmobilenetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type SimPoliciesClientBeginCreateOrUpdateOptions

type SimPoliciesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SimPoliciesClientBeginCreateOrUpdateOptions contains the optional parameters for the SimPoliciesClient.BeginCreateOrUpdate method.

type SimPoliciesClientBeginDeleteOptions

type SimPoliciesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SimPoliciesClientBeginDeleteOptions contains the optional parameters for the SimPoliciesClient.BeginDelete method.

type SimPoliciesClientCreateOrUpdateResponse

type SimPoliciesClientCreateOrUpdateResponse struct {
	SimPolicy
}

SimPoliciesClientCreateOrUpdateResponse contains the response from method SimPoliciesClient.CreateOrUpdate.

type SimPoliciesClientDeleteResponse

type SimPoliciesClientDeleteResponse struct {
}

SimPoliciesClientDeleteResponse contains the response from method SimPoliciesClient.Delete.

type SimPoliciesClientGetOptions

type SimPoliciesClientGetOptions struct {
}

SimPoliciesClientGetOptions contains the optional parameters for the SimPoliciesClient.Get method.

type SimPoliciesClientGetResponse

type SimPoliciesClientGetResponse struct {
	SimPolicy
}

SimPoliciesClientGetResponse contains the response from method SimPoliciesClient.Get.

type SimPoliciesClientListByMobileNetworkOptions

type SimPoliciesClientListByMobileNetworkOptions struct {
}

SimPoliciesClientListByMobileNetworkOptions contains the optional parameters for the SimPoliciesClient.ListByMobileNetwork method.

type SimPoliciesClientListByMobileNetworkResponse

type SimPoliciesClientListByMobileNetworkResponse struct {
	SimPolicyListResult
}

SimPoliciesClientListByMobileNetworkResponse contains the response from method SimPoliciesClient.ListByMobileNetwork.

type SimPoliciesClientUpdateTagsOptions

type SimPoliciesClientUpdateTagsOptions struct {
}

SimPoliciesClientUpdateTagsOptions contains the optional parameters for the SimPoliciesClient.UpdateTags method.

type SimPoliciesClientUpdateTagsResponse

type SimPoliciesClientUpdateTagsResponse struct {
	SimPolicy
}

SimPoliciesClientUpdateTagsResponse contains the response from method SimPoliciesClient.UpdateTags.

type SimPolicy

type SimPolicy struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// REQUIRED; SIM policy Properties.
	Properties *SimPolicyPropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

SimPolicy - SIM policy resource.

func (SimPolicy) MarshalJSON

func (s SimPolicy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SimPolicy.

func (*SimPolicy) UnmarshalJSON added in v0.6.0

func (s *SimPolicy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SimPolicy.

type SimPolicyListResult

type SimPolicyListResult struct {
	// A list of SIM policies.
	Value []*SimPolicy `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

SimPolicyListResult - Response for SIM policies API service call.

func (SimPolicyListResult) MarshalJSON

func (s SimPolicyListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SimPolicyListResult.

func (*SimPolicyListResult) UnmarshalJSON added in v0.6.0

func (s *SimPolicyListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SimPolicyListResult.

type SimPolicyPropertiesFormat

type SimPolicyPropertiesFormat struct {
	// REQUIRED; The default slice to use if the UE does not explicitly specify it. This slice must exist in the sliceConfigurations
	// map.
	DefaultSlice *SliceResourceID `json:"defaultSlice,omitempty"`

	// REQUIRED; The allowed slices and the settings to use for them. The list must not contain duplicate items and must contain
	// at least one item.
	SliceConfigurations []*SliceConfiguration `json:"sliceConfigurations,omitempty"`

	// REQUIRED; Aggregate maximum bit rate across all non-GBR QoS flows of all PDU sessions of a given UE. See 3GPP TS23.501
	// section 5.7.2.6 for a full description of the UE-AMBR.
	UeAmbr *Ambr `json:"ueAmbr,omitempty"`

	// Interval for the UE periodic registration update procedure, in seconds.
	RegistrationTimer *int32 `json:"registrationTimer,omitempty"`

	// RAT/Frequency Selection Priority Index, defined in 3GPP TS 36.413. This is an optional setting and by default is unspecified.
	RfspIndex *int32 `json:"rfspIndex,omitempty"`

	// READ-ONLY; The provisioning state of the SIM policy resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

SimPolicyPropertiesFormat - SIM policy properties.

func (SimPolicyPropertiesFormat) MarshalJSON

func (s SimPolicyPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SimPolicyPropertiesFormat.

func (*SimPolicyPropertiesFormat) UnmarshalJSON added in v0.6.0

func (s *SimPolicyPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SimPolicyPropertiesFormat.

type SimPolicyResourceID

type SimPolicyResourceID struct {
	// REQUIRED; SIM policy resource ID.
	ID *string `json:"id,omitempty"`
}

SimPolicyResourceID - Reference to a SIM policy resource.

func (SimPolicyResourceID) MarshalJSON added in v0.6.0

func (s SimPolicyResourceID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SimPolicyResourceID.

func (*SimPolicyResourceID) UnmarshalJSON added in v0.6.0

func (s *SimPolicyResourceID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SimPolicyResourceID.

type SimPropertiesFormat

type SimPropertiesFormat struct {
	// REQUIRED; The international mobile subscriber identity (IMSI) for the SIM.
	InternationalMobileSubscriberIdentity *string `json:"internationalMobileSubscriberIdentity,omitempty"`

	// The Ki value for the SIM.
	AuthenticationKey *string `json:"authenticationKey,omitempty"`

	// An optional free-form text field that can be used to record the device type this SIM is associated with, for example 'Video
	// camera'. The Azure portal allows SIMs to be grouped and filtered based on
	// this value.
	DeviceType *string `json:"deviceType,omitempty"`

	// The integrated circuit card ID (ICCID) for the SIM.
	IntegratedCircuitCardIdentifier *string `json:"integratedCircuitCardIdentifier,omitempty"`

	// The Opc value for the SIM.
	OperatorKeyCode *string `json:"operatorKeyCode,omitempty"`

	// The SIM policy used by this SIM.
	SimPolicy *SimPolicyResourceID `json:"simPolicy,omitempty"`

	// A list of static IP addresses assigned to this SIM. Each address is assigned at a defined network scope, made up of {attached
	// data network, slice}.
	StaticIPConfiguration []*SimStaticIPProperties `json:"staticIpConfiguration,omitempty"`

	// READ-ONLY; The provisioning state of the SIM resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`

	// READ-ONLY; The state of the SIM resource.
	SimState *SimState `json:"simState,omitempty" azure:"ro"`
}

SimPropertiesFormat - SIM properties.

func (SimPropertiesFormat) MarshalJSON

func (s SimPropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SimPropertiesFormat.

func (*SimPropertiesFormat) UnmarshalJSON added in v0.6.0

func (s *SimPropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SimPropertiesFormat.

type SimState added in v0.2.0

type SimState string

SimState - The state of the SIM resource.

const (
	// SimStateDisabled - The SIM is disabled because not all configuration required for enabling is present.
	SimStateDisabled SimState = "Disabled"
	// SimStateEnabled - The SIM is enabled.
	SimStateEnabled SimState = "Enabled"
	// SimStateInvalid - The SIM cannot be enabled because some of the associated configuration is invalid.
	SimStateInvalid SimState = "Invalid"
)

func PossibleSimStateValues added in v0.2.0

func PossibleSimStateValues() []SimState

PossibleSimStateValues returns the possible values for the SimState const type.

type SimStaticIPProperties

type SimStaticIPProperties struct {
	// The attached data network on which the static IP address will be used. The combination of attached data network and slice
	// defines the network scope of the IP address.
	AttachedDataNetwork *AttachedDataNetworkResourceID `json:"attachedDataNetwork,omitempty"`

	// The network slice on which the static IP address will be used. The combination of attached data network and slice defines
	// the network scope of the IP address.
	Slice *SliceResourceID `json:"slice,omitempty"`

	// The static IP configuration for the SIM to use at the defined network scope.
	StaticIP *SimStaticIPPropertiesStaticIP `json:"staticIp,omitempty"`
}

SimStaticIPProperties - Static IP configuration for a SIM, scoped to a particular attached data network and slice.

func (SimStaticIPProperties) MarshalJSON added in v0.6.0

func (s SimStaticIPProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SimStaticIPProperties.

func (*SimStaticIPProperties) UnmarshalJSON added in v0.6.0

func (s *SimStaticIPProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SimStaticIPProperties.

type SimStaticIPPropertiesStaticIP

type SimStaticIPPropertiesStaticIP struct {
	// The IPv4 address assigned to the SIM at this network scope. This address must be in the userEquipmentStaticAddressPoolPrefix
	// defined in the attached data network.
	IPv4Address *string `json:"ipv4Address,omitempty"`
}

SimStaticIPPropertiesStaticIP - The static IP configuration for the SIM to use at the defined network scope.

func (SimStaticIPPropertiesStaticIP) MarshalJSON added in v0.6.0

func (s SimStaticIPPropertiesStaticIP) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SimStaticIPPropertiesStaticIP.

func (*SimStaticIPPropertiesStaticIP) UnmarshalJSON added in v0.6.0

func (s *SimStaticIPPropertiesStaticIP) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SimStaticIPPropertiesStaticIP.

type SimsClient

type SimsClient struct {
	// contains filtered or unexported fields
}

SimsClient contains the methods for the Sims group. Don't use this type directly, use NewSimsClient() instead.

func NewSimsClient

func NewSimsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SimsClient, error)

NewSimsClient creates a new instance of SimsClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SimsClient) BeginCreateOrUpdate

func (client *SimsClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, simGroupName string, simName string, parameters Sim, options *SimsClientBeginCreateOrUpdateOptions) (*runtime.Poller[SimsClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a SIM. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. simGroupName - The name of the SIM Group. simName - The name of the SIM. parameters - Parameters supplied to the create or update SIM operation. options - SimsClientBeginCreateOrUpdateOptions contains the optional parameters for the SimsClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimCreate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"testSimGroup",
		"testSim",
		armmobilenetwork.Sim{
			Properties: &armmobilenetwork.SimPropertiesFormat{
				AuthenticationKey:                     to.Ptr("00000000000000000000000000000000"),
				DeviceType:                            to.Ptr("Video camera"),
				IntegratedCircuitCardIdentifier:       to.Ptr("8900000000000000000"),
				InternationalMobileSubscriberIdentity: to.Ptr("00000"),
				OperatorKeyCode:                       to.Ptr("00000000000000000000000000000000"),
				SimPolicy: &armmobilenetwork.SimPolicyResourceID{
					ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/simPolicies/MySimPolicy"),
				},
				StaticIPConfiguration: []*armmobilenetwork.SimStaticIPProperties{
					{
						AttachedDataNetwork: &armmobilenetwork.AttachedDataNetworkResourceID{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/packetCoreControlPlanes/TestPacketCoreCP/packetCoreDataPlanes/TestPacketCoreDP/attachedDataNetworks/TestAttachedDataNetwork"),
						},
						Slice: &armmobilenetwork.SliceResourceID{
							ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.MobileNetwork/mobileNetworks/testMobileNetwork/slices/testSlice"),
						},
						StaticIP: &armmobilenetwork.SimStaticIPPropertiesStaticIP{
							IPv4Address: to.Ptr("2.4.0.1"),
						},
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*SimsClient) BeginDelete

func (client *SimsClient) BeginDelete(ctx context.Context, resourceGroupName string, simGroupName string, simName string, options *SimsClientBeginDeleteOptions) (*runtime.Poller[SimsClientDeleteResponse], error)

BeginDelete - Deletes the specified SIM. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. simGroupName - The name of the SIM Group. simName - The name of the SIM. options - SimsClientBeginDeleteOptions contains the optional parameters for the SimsClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"testResourceGroupName",
		"testSimGroup",
		"testSim",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*SimsClient) Get

func (client *SimsClient) Get(ctx context.Context, resourceGroupName string, simGroupName string, simName string, options *SimsClientGetOptions) (SimsClientGetResponse, error)

Get - Gets information about the specified SIM. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. simGroupName - The name of the SIM Group. simName - The name of the SIM. options - SimsClientGetOptions contains the optional parameters for the SimsClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"testResourceGroupName",
		"testSimGroup",
		"testSimName",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*SimsClient) NewListBySimGroupPager added in v0.6.0

func (client *SimsClient) NewListBySimGroupPager(resourceGroupName string, simGroupName string, options *SimsClientListBySimGroupOptions) *runtime.Pager[SimsClientListBySimGroupResponse]

NewListBySimGroupPager - Gets all the SIMs in a SIM group. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. simGroupName - The name of the SIM Group. options - SimsClientListBySimGroupOptions contains the optional parameters for the SimsClient.ListBySimGroup method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SimListBySimGroup.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSimsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListBySimGroupPager("rg1",
		"testSimGroup",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

type SimsClientBeginCreateOrUpdateOptions

type SimsClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SimsClientBeginCreateOrUpdateOptions contains the optional parameters for the SimsClient.BeginCreateOrUpdate method.

type SimsClientBeginDeleteOptions

type SimsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SimsClientBeginDeleteOptions contains the optional parameters for the SimsClient.BeginDelete method.

type SimsClientCreateOrUpdateResponse

type SimsClientCreateOrUpdateResponse struct {
	Sim
}

SimsClientCreateOrUpdateResponse contains the response from method SimsClient.CreateOrUpdate.

type SimsClientDeleteResponse

type SimsClientDeleteResponse struct {
}

SimsClientDeleteResponse contains the response from method SimsClient.Delete.

type SimsClientGetOptions

type SimsClientGetOptions struct {
}

SimsClientGetOptions contains the optional parameters for the SimsClient.Get method.

type SimsClientGetResponse

type SimsClientGetResponse struct {
	Sim
}

SimsClientGetResponse contains the response from method SimsClient.Get.

type SimsClientListBySimGroupOptions added in v0.6.0

type SimsClientListBySimGroupOptions struct {
}

SimsClientListBySimGroupOptions contains the optional parameters for the SimsClient.ListBySimGroup method.

type SimsClientListBySimGroupResponse added in v0.6.0

type SimsClientListBySimGroupResponse struct {
	SimListResult
}

SimsClientListBySimGroupResponse contains the response from method SimsClient.ListBySimGroup.

type Site

type Site struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Site properties.
	Properties *SitePropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Site resource.

func (Site) MarshalJSON

func (s Site) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Site.

func (*Site) UnmarshalJSON added in v0.6.0

func (s *Site) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Site.

type SiteListResult

type SiteListResult struct {
	// A list of sites in a mobile network.
	Value []*Site `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

SiteListResult - Response for sites API service call.

func (SiteListResult) MarshalJSON

func (s SiteListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SiteListResult.

func (*SiteListResult) UnmarshalJSON added in v0.6.0

func (s *SiteListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SiteListResult.

type SitePropertiesFormat

type SitePropertiesFormat struct {
	// An array of IDs of the network functions deployed on the site, maintained by the user.
	NetworkFunctions []*SubResource `json:"networkFunctions,omitempty"`

	// READ-ONLY; The provisioning state of the site resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

SitePropertiesFormat - Site properties.

func (SitePropertiesFormat) MarshalJSON

func (s SitePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SitePropertiesFormat.

func (*SitePropertiesFormat) UnmarshalJSON added in v0.6.0

func (s *SitePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SitePropertiesFormat.

type SitesClient

type SitesClient struct {
	// contains filtered or unexported fields
}

SitesClient contains the methods for the Sites group. Don't use this type directly, use NewSitesClient() instead.

func NewSitesClient

func NewSitesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SitesClient, error)

NewSitesClient creates a new instance of SitesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SitesClient) BeginCreateOrUpdate

func (client *SitesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, mobileNetworkName string, siteName string, parameters Site, options *SitesClientBeginCreateOrUpdateOptions) (*runtime.Poller[SitesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a mobile network site. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. siteName - The name of the mobile network site. parameters - Parameters supplied to the create or update mobile network site operation. options - SitesClientBeginCreateOrUpdateOptions contains the optional parameters for the SitesClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SiteCreate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSitesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"testMobileNetwork",
		"testSite",
		armmobilenetwork.Site{
			Location: to.Ptr("testLocation"),
			Properties: &armmobilenetwork.SitePropertiesFormat{
				NetworkFunctions: []*armmobilenetwork.SubResource{
					{
						ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HybridNetwork/networkFunctions/testNf"),
					}},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*SitesClient) BeginDelete

func (client *SitesClient) BeginDelete(ctx context.Context, resourceGroupName string, mobileNetworkName string, siteName string, options *SitesClientBeginDeleteOptions) (*runtime.Poller[SitesClientDeleteResponse], error)

BeginDelete - Deletes the specified mobile network site. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. siteName - The name of the mobile network site. options - SitesClientBeginDeleteOptions contains the optional parameters for the SitesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SiteDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSitesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"rg1",
		"testMobileNetwork",
		"testSite",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*SitesClient) Get

func (client *SitesClient) Get(ctx context.Context, resourceGroupName string, mobileNetworkName string, siteName string, options *SitesClientGetOptions) (SitesClientGetResponse, error)

Get - Gets information about the specified mobile network site. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. siteName - The name of the mobile network site. options - SitesClientGetOptions contains the optional parameters for the SitesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SiteGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSitesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"testMobileNetwork",
		"testSite",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*SitesClient) NewListByMobileNetworkPager added in v0.4.0

func (client *SitesClient) NewListByMobileNetworkPager(resourceGroupName string, mobileNetworkName string, options *SitesClientListByMobileNetworkOptions) *runtime.Pager[SitesClientListByMobileNetworkResponse]

NewListByMobileNetworkPager - Lists all sites in the mobile network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. options - SitesClientListByMobileNetworkOptions contains the optional parameters for the SitesClient.ListByMobileNetwork method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SiteListByMobileNetwork.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSitesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByMobileNetworkPager("rg1",
		"testMobileNetwork",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*SitesClient) UpdateTags

func (client *SitesClient) UpdateTags(ctx context.Context, resourceGroupName string, mobileNetworkName string, siteName string, parameters TagsObject, options *SitesClientUpdateTagsOptions) (SitesClientUpdateTagsResponse, error)

UpdateTags - Updates site tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. siteName - The name of the mobile network site. parameters - Parameters supplied to update network site tags. options - SitesClientUpdateTagsOptions contains the optional parameters for the SitesClient.UpdateTags method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SiteUpdateTags.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSitesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.UpdateTags(ctx,
		"rg1",
		"testMobileNetwork",
		"testSite",
		armmobilenetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type SitesClientBeginCreateOrUpdateOptions

type SitesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SitesClientBeginCreateOrUpdateOptions contains the optional parameters for the SitesClient.BeginCreateOrUpdate method.

type SitesClientBeginDeleteOptions

type SitesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SitesClientBeginDeleteOptions contains the optional parameters for the SitesClient.BeginDelete method.

type SitesClientCreateOrUpdateResponse

type SitesClientCreateOrUpdateResponse struct {
	Site
}

SitesClientCreateOrUpdateResponse contains the response from method SitesClient.CreateOrUpdate.

type SitesClientDeleteResponse

type SitesClientDeleteResponse struct {
}

SitesClientDeleteResponse contains the response from method SitesClient.Delete.

type SitesClientGetOptions

type SitesClientGetOptions struct {
}

SitesClientGetOptions contains the optional parameters for the SitesClient.Get method.

type SitesClientGetResponse

type SitesClientGetResponse struct {
	Site
}

SitesClientGetResponse contains the response from method SitesClient.Get.

type SitesClientListByMobileNetworkOptions

type SitesClientListByMobileNetworkOptions struct {
}

SitesClientListByMobileNetworkOptions contains the optional parameters for the SitesClient.ListByMobileNetwork method.

type SitesClientListByMobileNetworkResponse

type SitesClientListByMobileNetworkResponse struct {
	SiteListResult
}

SitesClientListByMobileNetworkResponse contains the response from method SitesClient.ListByMobileNetwork.

type SitesClientUpdateTagsOptions

type SitesClientUpdateTagsOptions struct {
}

SitesClientUpdateTagsOptions contains the optional parameters for the SitesClient.UpdateTags method.

type SitesClientUpdateTagsResponse

type SitesClientUpdateTagsResponse struct {
	Site
}

SitesClientUpdateTagsResponse contains the response from method SitesClient.UpdateTags.

type Slice

type Slice struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// REQUIRED; Slice properties.
	Properties *SlicePropertiesFormat `json:"properties,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

Slice - Network slice resource.

func (Slice) MarshalJSON

func (s Slice) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Slice.

func (*Slice) UnmarshalJSON added in v0.6.0

func (s *Slice) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Slice.

type SliceConfiguration

type SliceConfiguration struct {
	// REQUIRED; The allowed data networks and the settings to use for them. The list must not contain duplicate items and must
	// contain at least one item.
	DataNetworkConfigurations []*DataNetworkConfiguration `json:"dataNetworkConfigurations,omitempty"`

	// REQUIRED; The default data network to use if the UE does not explicitly specify it. Configuration for this object must
	// exist in the dataNetworkConfigurations map.
	DefaultDataNetwork *DataNetworkResourceID `json:"defaultDataNetwork,omitempty"`

	// REQUIRED; A reference to the slice that these settings apply to
	Slice *SliceResourceID `json:"slice,omitempty"`
}

SliceConfiguration - Per-slice settings

func (SliceConfiguration) MarshalJSON

func (s SliceConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SliceConfiguration.

func (*SliceConfiguration) UnmarshalJSON added in v0.6.0

func (s *SliceConfiguration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SliceConfiguration.

type SliceListResult

type SliceListResult struct {
	// A list of network slices in a mobile network.
	Value []*Slice `json:"value,omitempty"`

	// READ-ONLY; The URL to get the next set of results.
	NextLink *string `json:"nextLink,omitempty" azure:"ro"`
}

SliceListResult - Response for network slice API service call.

func (SliceListResult) MarshalJSON

func (s SliceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SliceListResult.

func (*SliceListResult) UnmarshalJSON added in v0.6.0

func (s *SliceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SliceListResult.

type SlicePropertiesFormat

type SlicePropertiesFormat struct {
	// REQUIRED; Single-network slice selection assistance information (S-NSSAI). Unique at the scope of a mobile network.
	Snssai *Snssai `json:"snssai,omitempty"`

	// An optional description for this network slice.
	Description *string `json:"description,omitempty"`

	// READ-ONLY; The provisioning state of the network slice resource.
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty" azure:"ro"`
}

SlicePropertiesFormat - Network slice properties.

func (SlicePropertiesFormat) MarshalJSON added in v0.6.0

func (s SlicePropertiesFormat) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SlicePropertiesFormat.

func (*SlicePropertiesFormat) UnmarshalJSON added in v0.6.0

func (s *SlicePropertiesFormat) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SlicePropertiesFormat.

type SliceResourceID

type SliceResourceID struct {
	// REQUIRED; Slice resource ID.
	ID *string `json:"id,omitempty"`
}

SliceResourceID - Reference to a slice resource.

func (SliceResourceID) MarshalJSON added in v0.6.0

func (s SliceResourceID) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SliceResourceID.

func (*SliceResourceID) UnmarshalJSON added in v0.6.0

func (s *SliceResourceID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SliceResourceID.

type SlicesClient

type SlicesClient struct {
	// contains filtered or unexported fields
}

SlicesClient contains the methods for the Slices group. Don't use this type directly, use NewSlicesClient() instead.

func NewSlicesClient

func NewSlicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SlicesClient, error)

NewSlicesClient creates a new instance of SlicesClient with the specified values. subscriptionID - The ID of the target subscription. credential - used to authorize requests. Usually a credential from azidentity. options - pass nil to accept the default values.

func (*SlicesClient) BeginCreateOrUpdate

func (client *SlicesClient) BeginCreateOrUpdate(ctx context.Context, resourceGroupName string, mobileNetworkName string, sliceName string, parameters Slice, options *SlicesClientBeginCreateOrUpdateOptions) (*runtime.Poller[SlicesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Creates or updates a network slice. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. sliceName - The name of the network slice. parameters - Parameters supplied to the create or update network slice operation. options - SlicesClientBeginCreateOrUpdateOptions contains the optional parameters for the SlicesClient.BeginCreateOrUpdate method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SliceCreate.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSlicesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"testMobileNetwork",
		"testSlice",
		armmobilenetwork.Slice{
			Location: to.Ptr("eastus"),
			Properties: &armmobilenetwork.SlicePropertiesFormat{
				Description: to.Ptr("myFavouriteSlice"),
				Snssai: &armmobilenetwork.Snssai{
					Sd:  to.Ptr("1abcde"),
					Sst: to.Ptr[int32](1),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*SlicesClient) BeginDelete

func (client *SlicesClient) BeginDelete(ctx context.Context, resourceGroupName string, mobileNetworkName string, sliceName string, options *SlicesClientBeginDeleteOptions) (*runtime.Poller[SlicesClientDeleteResponse], error)

BeginDelete - Deletes the specified network slice. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. sliceName - The name of the network slice. options - SlicesClientBeginDeleteOptions contains the optional parameters for the SlicesClient.BeginDelete method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SliceDelete.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSlicesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginDelete(ctx,
		"rg1",
		"testMobileNetwork",
		"testSlice",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}
Output:

func (*SlicesClient) Get

func (client *SlicesClient) Get(ctx context.Context, resourceGroupName string, mobileNetworkName string, sliceName string, options *SlicesClientGetOptions) (SlicesClientGetResponse, error)

Get - Gets information about the specified network slice. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. sliceName - The name of the network slice. options - SlicesClientGetOptions contains the optional parameters for the SlicesClient.Get method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SliceGet.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSlicesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"rg1",
		"testMobileNetwork",
		"testSlice",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

func (*SlicesClient) NewListByMobileNetworkPager added in v0.4.0

func (client *SlicesClient) NewListByMobileNetworkPager(resourceGroupName string, mobileNetworkName string, options *SlicesClientListByMobileNetworkOptions) *runtime.Pager[SlicesClientListByMobileNetworkResponse]

NewListByMobileNetworkPager - Lists all slices in the mobile network. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. options - SlicesClientListByMobileNetworkOptions contains the optional parameters for the SlicesClient.ListByMobileNetwork method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SliceListByMobileNetwork.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSlicesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByMobileNetworkPager("rg1",
		"testMobileNetwork",
		nil)
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}
Output:

func (*SlicesClient) UpdateTags

func (client *SlicesClient) UpdateTags(ctx context.Context, resourceGroupName string, mobileNetworkName string, sliceName string, parameters TagsObject, options *SlicesClientUpdateTagsOptions) (SlicesClientUpdateTagsResponse, error)

UpdateTags - Updates slice tags. If the operation fails it returns an *azcore.ResponseError type. Generated from API version 2022-04-01-preview resourceGroupName - The name of the resource group. The name is case insensitive. mobileNetworkName - The name of the mobile network. sliceName - The name of the network slice. parameters - Parameters supplied to update network slice tags. options - SlicesClientUpdateTagsOptions contains the optional parameters for the SlicesClient.UpdateTags method.

Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/mobilenetwork/resource-manager/Microsoft.MobileNetwork/preview/2022-04-01-preview/examples/SliceUpdateTags.json

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mobilenetwork/armmobilenetwork"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmobilenetwork.NewSlicesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.UpdateTags(ctx,
		"rg1",
		"testMobileNetwork",
		"testSlice",
		armmobilenetwork.TagsObject{
			Tags: map[string]*string{
				"tag1": to.Ptr("value1"),
				"tag2": to.Ptr("value2"),
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}
Output:

type SlicesClientBeginCreateOrUpdateOptions

type SlicesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SlicesClientBeginCreateOrUpdateOptions contains the optional parameters for the SlicesClient.BeginCreateOrUpdate method.

type SlicesClientBeginDeleteOptions

type SlicesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SlicesClientBeginDeleteOptions contains the optional parameters for the SlicesClient.BeginDelete method.

type SlicesClientCreateOrUpdateResponse

type SlicesClientCreateOrUpdateResponse struct {
	Slice
}

SlicesClientCreateOrUpdateResponse contains the response from method SlicesClient.CreateOrUpdate.

type SlicesClientDeleteResponse

type SlicesClientDeleteResponse struct {
}

SlicesClientDeleteResponse contains the response from method SlicesClient.Delete.

type SlicesClientGetOptions

type SlicesClientGetOptions struct {
}

SlicesClientGetOptions contains the optional parameters for the SlicesClient.Get method.

type SlicesClientGetResponse

type SlicesClientGetResponse struct {
	Slice
}

SlicesClientGetResponse contains the response from method SlicesClient.Get.

type SlicesClientListByMobileNetworkOptions

type SlicesClientListByMobileNetworkOptions struct {
}

SlicesClientListByMobileNetworkOptions contains the optional parameters for the SlicesClient.ListByMobileNetwork method.

type SlicesClientListByMobileNetworkResponse

type SlicesClientListByMobileNetworkResponse struct {
	SliceListResult
}

SlicesClientListByMobileNetworkResponse contains the response from method SlicesClient.ListByMobileNetwork.

type SlicesClientUpdateTagsOptions

type SlicesClientUpdateTagsOptions struct {
}

SlicesClientUpdateTagsOptions contains the optional parameters for the SlicesClient.UpdateTags method.

type SlicesClientUpdateTagsResponse

type SlicesClientUpdateTagsResponse struct {
	Slice
}

SlicesClientUpdateTagsResponse contains the response from method SlicesClient.UpdateTags.

type Snssai

type Snssai struct {
	// REQUIRED; Slice/service type (SST).
	Sst *int32 `json:"sst,omitempty"`

	// Slice differentiator (SD).
	Sd *string `json:"sd,omitempty"`
}

Snssai - Single-network slice selection assistance information (S-NSSAI).

func (Snssai) MarshalJSON added in v0.6.0

func (s Snssai) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Snssai.

func (*Snssai) UnmarshalJSON added in v0.6.0

func (s *Snssai) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Snssai.

type SubResource

type SubResource struct {
	// REQUIRED; Resource ID.
	ID *string `json:"id,omitempty"`
}

SubResource - Reference to another sub resource.

func (SubResource) MarshalJSON added in v0.6.0

func (s SubResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SubResource.

func (*SubResource) UnmarshalJSON added in v0.6.0

func (s *SubResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SubResource.

type SystemData

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time `json:"createdAt,omitempty"`

	// The identity that created the resource.
	CreatedBy *string `json:"createdBy,omitempty"`

	// The type of identity that created the resource.
	CreatedByType *CreatedByType `json:"createdByType,omitempty"`

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time `json:"lastModifiedAt,omitempty"`

	// The identity that last modified the resource.
	LastModifiedBy *string `json:"lastModifiedBy,omitempty"`

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType `json:"lastModifiedByType,omitempty"`
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TagsObject

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

TagsObject - Tags object for patch operations.

func (TagsObject) MarshalJSON

func (t TagsObject) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TagsObject.

func (*TagsObject) UnmarshalJSON added in v0.6.0

func (t *TagsObject) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TagsObject.

type TrackedResource

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string `json:"location,omitempty"`

	// Resource tags.
	Tags map[string]*string `json:"tags,omitempty"`

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string `json:"id,omitempty" azure:"ro"`

	// READ-ONLY; The name of the resource
	Name *string `json:"name,omitempty" azure:"ro"`

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData `json:"systemData,omitempty" azure:"ro"`

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string `json:"type,omitempty" azure:"ro"`
}

TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

func (*TrackedResource) UnmarshalJSON added in v0.6.0

func (t *TrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

type TrafficControlPermission

type TrafficControlPermission string

TrafficControlPermission - Traffic control permission.

const (
	// TrafficControlPermissionBlocked - Traffic matching this rule is not allowed to flow.
	TrafficControlPermissionBlocked TrafficControlPermission = "Blocked"
	// TrafficControlPermissionEnabled - Traffic matching this rule is allowed to flow.
	TrafficControlPermissionEnabled TrafficControlPermission = "Enabled"
)

func PossibleTrafficControlPermissionValues

func PossibleTrafficControlPermissionValues() []TrafficControlPermission

PossibleTrafficControlPermissionValues returns the possible values for the TrafficControlPermission const type.

type UserAssignedIdentity added in v0.6.0

type UserAssignedIdentity struct {
	// READ-ONLY; The client ID of the assigned identity.
	ClientID *string `json:"clientId,omitempty" azure:"ro"`

	// READ-ONLY; The principal ID of the assigned identity.
	PrincipalID *string `json:"principalId,omitempty" azure:"ro"`
}

UserAssignedIdentity - User assigned identity properties

func (UserAssignedIdentity) MarshalJSON added in v0.6.0

func (u UserAssignedIdentity) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type UserAssignedIdentity.

func (*UserAssignedIdentity) UnmarshalJSON added in v0.6.0

func (u *UserAssignedIdentity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UserAssignedIdentity.

type VersionState added in v0.6.0

type VersionState string

VersionState - The state of this packet core control plane version.

const (
	// VersionStateActive - This version is active and suitable for production use.
	VersionStateActive VersionState = "Active"
	// VersionStateDeprecated - This version is deprecated and is no longer supported.
	VersionStateDeprecated VersionState = "Deprecated"
	// VersionStatePreview - This version is a preview and is not suitable for production use.
	VersionStatePreview VersionState = "Preview"
	// VersionStateUnknown - The state of this version is unknown.
	VersionStateUnknown VersionState = "Unknown"
	// VersionStateValidating - This version is currently being validated.
	VersionStateValidating VersionState = "Validating"
	// VersionStateValidationFailed - This version failed validation.
	VersionStateValidationFailed VersionState = "ValidationFailed"
)

func PossibleVersionStateValues added in v0.6.0

func PossibleVersionStateValues() []VersionState

PossibleVersionStateValues returns the possible values for the VersionState const type.

Jump to

Keyboard shortcuts

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