communicationsgateways

package
v0.20240131.1131852 Latest Latest
Warning

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

Go to latest
Published: Jan 31, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/voiceservices/2023-09-01/communicationsgateways Documentation

The communicationsgateways SDK allows for interaction with the Azure Resource Manager Service voiceservices (API Version 2023-09-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/voiceservices/2023-09-01/communicationsgateways"

Client Initialization

client := communicationsgateways.NewCommunicationsGatewaysClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CommunicationsGatewaysClient.CreateOrUpdate

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

payload := communicationsgateways.CommunicationsGateway{
	// ...
}


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

Example Usage: CommunicationsGatewaysClient.Delete

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

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

Example Usage: CommunicationsGatewaysClient.Get

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

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

Example Usage: CommunicationsGatewaysClient.ListByResourceGroup

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

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

Example Usage: CommunicationsGatewaysClient.ListBySubscription

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

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

Example Usage: CommunicationsGatewaysClient.Update

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

payload := communicationsgateways.CommunicationsGatewayUpdate{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForApiBridgeActivationState

func PossibleValuesForApiBridgeActivationState() []string

func PossibleValuesForAutoGeneratedDomainNameLabelScope

func PossibleValuesForAutoGeneratedDomainNameLabelScope() []string

func PossibleValuesForCommunicationsPlatform

func PossibleValuesForCommunicationsPlatform() []string

func PossibleValuesForConnectivity

func PossibleValuesForConnectivity() []string

func PossibleValuesForE911Type

func PossibleValuesForE911Type() []string

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForSkuTier

func PossibleValuesForSkuTier() []string

func PossibleValuesForStatus

func PossibleValuesForStatus() []string

func PossibleValuesForTeamsCodecs

func PossibleValuesForTeamsCodecs() []string

func ValidateCommunicationsGatewayID

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

ValidateCommunicationsGatewayID checks that 'input' can be parsed as a Communications Gateway ID

Types

type ApiBridgeActivationState

type ApiBridgeActivationState string
const (
	ApiBridgeActivationStateDisabled ApiBridgeActivationState = "disabled"
	ApiBridgeActivationStateEnabled  ApiBridgeActivationState = "enabled"
)

func (*ApiBridgeActivationState) UnmarshalJSON

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

type ApiBridgeProperties

type ApiBridgeProperties struct {
	AllowedAddressPrefixes *[]string                 `json:"allowedAddressPrefixes,omitempty"`
	ConfigureApiBridge     *ApiBridgeActivationState `json:"configureApiBridge,omitempty"`
	EndpointFqdns          *[]string                 `json:"endpointFqdns,omitempty"`
}

type AutoGeneratedDomainNameLabelScope

type AutoGeneratedDomainNameLabelScope string
const (
	AutoGeneratedDomainNameLabelScopeNoReuse            AutoGeneratedDomainNameLabelScope = "NoReuse"
	AutoGeneratedDomainNameLabelScopeResourceGroupReuse AutoGeneratedDomainNameLabelScope = "ResourceGroupReuse"
	AutoGeneratedDomainNameLabelScopeSubscriptionReuse  AutoGeneratedDomainNameLabelScope = "SubscriptionReuse"
	AutoGeneratedDomainNameLabelScopeTenantReuse        AutoGeneratedDomainNameLabelScope = "TenantReuse"
)

func (*AutoGeneratedDomainNameLabelScope) UnmarshalJSON

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

type CommunicationsGateway

type CommunicationsGateway struct {
	Id         *string                            `json:"id,omitempty"`
	Identity   *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   string                             `json:"location"`
	Name       *string                            `json:"name,omitempty"`
	Properties *CommunicationsGatewayProperties   `json:"properties,omitempty"`
	Sku        *Sku                               `json:"sku,omitempty"`
	SystemData *systemdata.SystemData             `json:"systemData,omitempty"`
	Tags       *map[string]string                 `json:"tags,omitempty"`
	Type       *string                            `json:"type,omitempty"`
}

type CommunicationsGatewayId

type CommunicationsGatewayId struct {
	SubscriptionId            string
	ResourceGroupName         string
	CommunicationsGatewayName string
}

CommunicationsGatewayId is a struct representing the Resource ID for a Communications Gateway

func NewCommunicationsGatewayID

func NewCommunicationsGatewayID(subscriptionId string, resourceGroupName string, communicationsGatewayName string) CommunicationsGatewayId

NewCommunicationsGatewayID returns a new CommunicationsGatewayId struct

func ParseCommunicationsGatewayID

func ParseCommunicationsGatewayID(input string) (*CommunicationsGatewayId, error)

ParseCommunicationsGatewayID parses 'input' into a CommunicationsGatewayId

func ParseCommunicationsGatewayIDInsensitively

func ParseCommunicationsGatewayIDInsensitively(input string) (*CommunicationsGatewayId, error)

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

func (*CommunicationsGatewayId) FromParseResult

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

func (CommunicationsGatewayId) ID

ID returns the formatted Communications Gateway ID

func (CommunicationsGatewayId) Segments

Segments returns a slice of Resource ID Segments which comprise this Communications Gateway ID

func (CommunicationsGatewayId) String

func (id CommunicationsGatewayId) String() string

String returns a human-readable description of this Communications Gateway ID

type CommunicationsGatewayOperationPredicate

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

func (CommunicationsGatewayOperationPredicate) Matches

type CommunicationsGatewayProperties

type CommunicationsGatewayProperties struct {
	AllocatedMediaAddressPrefixes     *[]string                          `json:"allocatedMediaAddressPrefixes,omitempty"`
	AllocatedSignalingAddressPrefixes *[]string                          `json:"allocatedSignalingAddressPrefixes,omitempty"`
	ApiBridge                         *ApiBridgeProperties               `json:"apiBridge,omitempty"`
	AutoGeneratedDomainNameLabel      *string                            `json:"autoGeneratedDomainNameLabel,omitempty"`
	AutoGeneratedDomainNameLabelScope *AutoGeneratedDomainNameLabelScope `json:"autoGeneratedDomainNameLabelScope,omitempty"`
	Codecs                            []TeamsCodecs                      `json:"codecs"`
	Connectivity                      Connectivity                       `json:"connectivity"`
	CustomSipHeaders                  *CustomSipHeadersProperties        `json:"customSipHeaders,omitempty"`
	DnsDelegations                    *DnsDelegationsProperties          `json:"dnsDelegations,omitempty"`
	E911Type                          E911Type                           `json:"e911Type"`
	EmergencyDialStrings              *[]string                          `json:"emergencyDialStrings,omitempty"`
	IntegratedMcpEnabled              *bool                              `json:"integratedMcpEnabled,omitempty"`
	OnPremMcpEnabled                  *bool                              `json:"onPremMcpEnabled,omitempty"`
	Platforms                         []CommunicationsPlatform           `json:"platforms"`
	ProvisioningState                 *ProvisioningState                 `json:"provisioningState,omitempty"`
	ServiceLocations                  []ServiceRegionProperties          `json:"serviceLocations"`
	Status                            *Status                            `json:"status,omitempty"`
	TeamsVoicemailPilotNumber         *string                            `json:"teamsVoicemailPilotNumber,omitempty"`
}

type CommunicationsGatewayUpdate

type CommunicationsGatewayUpdate struct {
	Identity *identity.SystemAndUserAssignedMap `json:"identity,omitempty"`
	Sku      *Sku                               `json:"sku,omitempty"`
	Tags     *map[string]string                 `json:"tags,omitempty"`
}

type CommunicationsGatewaysClient

type CommunicationsGatewaysClient struct {
	Client *resourcemanager.Client
}

func NewCommunicationsGatewaysClientWithBaseURI

func NewCommunicationsGatewaysClientWithBaseURI(sdkApi sdkEnv.Api) (*CommunicationsGatewaysClient, error)

func (CommunicationsGatewaysClient) CreateOrUpdate

CreateOrUpdate ...

func (CommunicationsGatewaysClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (CommunicationsGatewaysClient) Delete

Delete ...

func (CommunicationsGatewaysClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (CommunicationsGatewaysClient) Get

Get ...

func (CommunicationsGatewaysClient) ListByResourceGroup

ListByResourceGroup ...

func (CommunicationsGatewaysClient) ListByResourceGroupComplete

ListByResourceGroupComplete retrieves all the results into a single object

func (CommunicationsGatewaysClient) ListByResourceGroupCompleteMatchingPredicate

func (c CommunicationsGatewaysClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate CommunicationsGatewayOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CommunicationsGatewaysClient) ListBySubscription

ListBySubscription ...

func (CommunicationsGatewaysClient) ListBySubscriptionComplete

ListBySubscriptionComplete retrieves all the results into a single object

func (CommunicationsGatewaysClient) ListBySubscriptionCompleteMatchingPredicate

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

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CommunicationsGatewaysClient) Update

Update ...

type CommunicationsPlatform

type CommunicationsPlatform string
const (
	CommunicationsPlatformOperatorConnect    CommunicationsPlatform = "OperatorConnect"
	CommunicationsPlatformTeamsDirectRouting CommunicationsPlatform = "TeamsDirectRouting"
	CommunicationsPlatformTeamsPhoneMobile   CommunicationsPlatform = "TeamsPhoneMobile"
)

func (*CommunicationsPlatform) UnmarshalJSON

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

type Connectivity

type Connectivity string
const (
	ConnectivityPublicAddress Connectivity = "PublicAddress"
)

func (*Connectivity) UnmarshalJSON

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

type CreateOrUpdateOperationResponse

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

type CustomSipHeader

type CustomSipHeader struct {
	Name *string `json:"name,omitempty"`
}

type CustomSipHeadersProperties

type CustomSipHeadersProperties struct {
	Headers *[]CustomSipHeader `json:"headers,omitempty"`
}

type DeleteOperationResponse

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

type DnsDelegationProperties

type DnsDelegationProperties struct {
	Domain      *string   `json:"domain,omitempty"`
	NameServers *[]string `json:"nameServers,omitempty"`
}

type DnsDelegationsProperties

type DnsDelegationsProperties struct {
	Delegations *[]DnsDelegationProperties `json:"delegations,omitempty"`
}

type E911Type

type E911Type string
const (
	E911TypeDirectToEsrp E911Type = "DirectToEsrp"
	E911TypeStandard     E911Type = "Standard"
)

func (*E911Type) UnmarshalJSON

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

type GetOperationResponse

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

type ListByResourceGroupCompleteResult

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []CommunicationsGateway
}

type ListByResourceGroupOperationResponse

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]CommunicationsGateway
}

type ListBySubscriptionCompleteResult

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []CommunicationsGateway
}

type ListBySubscriptionOperationResponse

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

type PrimaryRegionProperties

type PrimaryRegionProperties struct {
	AllowedMediaSourceAddressPrefixes     *[]string `json:"allowedMediaSourceAddressPrefixes,omitempty"`
	AllowedSignalingSourceAddressPrefixes *[]string `json:"allowedSignalingSourceAddressPrefixes,omitempty"`
	EsrpAddresses                         *[]string `json:"esrpAddresses,omitempty"`
	OperatorAddresses                     []string  `json:"operatorAddresses"`
}

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON

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

type ServiceRegionProperties

type ServiceRegionProperties struct {
	Name                    string                  `json:"name"`
	PrimaryRegionProperties PrimaryRegionProperties `json:"primaryRegionProperties"`
}

type Sku

type Sku struct {
	Capacity *int64   `json:"capacity,omitempty"`
	Family   *string  `json:"family,omitempty"`
	Name     string   `json:"name"`
	Size     *string  `json:"size,omitempty"`
	Tier     *SkuTier `json:"tier,omitempty"`
}

type SkuTier

type SkuTier string
const (
	SkuTierBasic    SkuTier = "Basic"
	SkuTierFree     SkuTier = "Free"
	SkuTierPremium  SkuTier = "Premium"
	SkuTierStandard SkuTier = "Standard"
)

func (*SkuTier) UnmarshalJSON

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

type Status

type Status string
const (
	StatusChangePending Status = "ChangePending"
	StatusComplete      Status = "Complete"
)

func (*Status) UnmarshalJSON

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

type TeamsCodecs

type TeamsCodecs string
const (
	TeamsCodecsGSevenTwoTwo    TeamsCodecs = "G722"
	TeamsCodecsGSevenTwoTwoTwo TeamsCodecs = "G722_2"
	TeamsCodecsPCMA            TeamsCodecs = "PCMA"
	TeamsCodecsPCMU            TeamsCodecs = "PCMU"
	TeamsCodecsSILKEight       TeamsCodecs = "SILK_8"
	TeamsCodecsSILKOneSix      TeamsCodecs = "SILK_16"
)

func (*TeamsCodecs) UnmarshalJSON

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

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CommunicationsGateway
}

Jump to

Keyboard shortcuts

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