README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/communication/2023-04-01/communicationservices
Documentation
The communicationservices
SDK allows for interaction with Azure Resource Manager communication
(API Version 2023-04-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/communication/2023-04-01/communicationservices"
Client Initialization
client := communicationservices.NewCommunicationServicesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: CommunicationServicesClient.CheckNameAvailability
ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")
payload := communicationservices.CheckNameAvailabilityRequest{
// ...
}
read, err := client.CheckNameAvailability(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: CommunicationServicesClient.CreateOrUpdate
ctx := context.TODO()
id := communicationservices.NewCommunicationServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "communicationServiceName")
payload := communicationservices.CommunicationServiceResource{
// ...
}
if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: CommunicationServicesClient.Delete
ctx := context.TODO()
id := communicationservices.NewCommunicationServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "communicationServiceName")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: CommunicationServicesClient.Get
ctx := context.TODO()
id := communicationservices.NewCommunicationServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "communicationServiceName")
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: CommunicationServicesClient.LinkNotificationHub
ctx := context.TODO()
id := communicationservices.NewCommunicationServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "communicationServiceName")
payload := communicationservices.LinkNotificationHubParameters{
// ...
}
read, err := client.LinkNotificationHub(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: CommunicationServicesClient.ListByResourceGroup
ctx := context.TODO()
id := commonids.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: CommunicationServicesClient.ListBySubscription
ctx := context.TODO()
id := commonids.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: CommunicationServicesClient.ListKeys
ctx := context.TODO()
id := communicationservices.NewCommunicationServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "communicationServiceName")
read, err := client.ListKeys(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: CommunicationServicesClient.RegenerateKey
ctx := context.TODO()
id := communicationservices.NewCommunicationServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "communicationServiceName")
payload := communicationservices.RegenerateKeyParameters{
// ...
}
read, err := client.RegenerateKey(ctx, id, payload)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Example Usage: CommunicationServicesClient.Update
ctx := context.TODO()
id := communicationservices.NewCommunicationServiceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "communicationServiceName")
payload := communicationservices.CommunicationServiceResourceUpdate{
// ...
}
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 ¶
- func PossibleValuesForCheckNameAvailabilityReason() []string
- func PossibleValuesForCommunicationServicesProvisioningState() []string
- func PossibleValuesForKeyType() []string
- func ValidateCommunicationServiceID(input interface{}, key string) (warnings []string, errors []error)
- type CheckNameAvailabilityOperationResponse
- type CheckNameAvailabilityReason
- type CheckNameAvailabilityRequest
- type CheckNameAvailabilityResponse
- type CommunicationServiceId
- type CommunicationServiceKeys
- type CommunicationServiceProperties
- type CommunicationServiceResource
- type CommunicationServiceResourceOperationPredicate
- type CommunicationServiceResourceUpdate
- type CommunicationServiceUpdateProperties
- type CommunicationServicesClient
- func (c CommunicationServicesClient) CheckNameAvailability(ctx context.Context, id commonids.SubscriptionId, ...) (result CheckNameAvailabilityOperationResponse, err error)
- func (c CommunicationServicesClient) CreateOrUpdate(ctx context.Context, id CommunicationServiceId, ...) (result CreateOrUpdateOperationResponse, err error)
- func (c CommunicationServicesClient) CreateOrUpdateThenPoll(ctx context.Context, id CommunicationServiceId, ...) error
- func (c CommunicationServicesClient) Delete(ctx context.Context, id CommunicationServiceId) (result DeleteOperationResponse, err error)
- func (c CommunicationServicesClient) DeleteThenPoll(ctx context.Context, id CommunicationServiceId) error
- func (c CommunicationServicesClient) Get(ctx context.Context, id CommunicationServiceId) (result GetOperationResponse, err error)
- func (c CommunicationServicesClient) LinkNotificationHub(ctx context.Context, id CommunicationServiceId, ...) (result LinkNotificationHubOperationResponse, err error)
- func (c CommunicationServicesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
- func (c CommunicationServicesClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
- func (c CommunicationServicesClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, ...) (result ListByResourceGroupCompleteResult, err error)
- func (c CommunicationServicesClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
- func (c CommunicationServicesClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
- func (c CommunicationServicesClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, ...) (result ListBySubscriptionCompleteResult, err error)
- func (c CommunicationServicesClient) ListKeys(ctx context.Context, id CommunicationServiceId) (result ListKeysOperationResponse, err error)
- func (c CommunicationServicesClient) RegenerateKey(ctx context.Context, id CommunicationServiceId, input RegenerateKeyParameters) (result RegenerateKeyOperationResponse, err error)
- func (c CommunicationServicesClient) Update(ctx context.Context, id CommunicationServiceId, ...) (result UpdateOperationResponse, err error)
- type CommunicationServicesProvisioningState
- type CreateOrUpdateOperationResponse
- type DeleteOperationResponse
- type GetOperationResponse
- type KeyType
- type LinkNotificationHubOperationResponse
- type LinkNotificationHubParameters
- type LinkedNotificationHub
- type ListByResourceGroupCompleteResult
- type ListByResourceGroupCustomPager
- type ListByResourceGroupOperationResponse
- type ListBySubscriptionCompleteResult
- type ListBySubscriptionCustomPager
- type ListBySubscriptionOperationResponse
- type ListKeysOperationResponse
- type RegenerateKeyOperationResponse
- type RegenerateKeyParameters
- type UpdateOperationResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PossibleValuesForCheckNameAvailabilityReason ¶
func PossibleValuesForCheckNameAvailabilityReason() []string
func PossibleValuesForCommunicationServicesProvisioningState ¶
func PossibleValuesForCommunicationServicesProvisioningState() []string
func PossibleValuesForKeyType ¶
func PossibleValuesForKeyType() []string
func ValidateCommunicationServiceID ¶
func ValidateCommunicationServiceID(input interface{}, key string) (warnings []string, errors []error)
ValidateCommunicationServiceID checks that 'input' can be parsed as a Communication Service ID
Types ¶
type CheckNameAvailabilityOperationResponse ¶
type CheckNameAvailabilityOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *CheckNameAvailabilityResponse }
type CheckNameAvailabilityReason ¶
type CheckNameAvailabilityReason string
const ( CheckNameAvailabilityReasonAlreadyExists CheckNameAvailabilityReason = "AlreadyExists" CheckNameAvailabilityReasonInvalid CheckNameAvailabilityReason = "Invalid" )
func (*CheckNameAvailabilityReason) UnmarshalJSON ¶
func (s *CheckNameAvailabilityReason) UnmarshalJSON(bytes []byte) error
type CheckNameAvailabilityResponse ¶
type CheckNameAvailabilityResponse struct { Message *string `json:"message,omitempty"` NameAvailable *bool `json:"nameAvailable,omitempty"` Reason *CheckNameAvailabilityReason `json:"reason,omitempty"` }
type CommunicationServiceId ¶
type CommunicationServiceId struct { SubscriptionId string ResourceGroupName string CommunicationServiceName string }
CommunicationServiceId is a struct representing the Resource ID for a Communication Service
func NewCommunicationServiceID ¶
func NewCommunicationServiceID(subscriptionId string, resourceGroupName string, communicationServiceName string) CommunicationServiceId
NewCommunicationServiceID returns a new CommunicationServiceId struct
func ParseCommunicationServiceID ¶
func ParseCommunicationServiceID(input string) (*CommunicationServiceId, error)
ParseCommunicationServiceID parses 'input' into a CommunicationServiceId
func ParseCommunicationServiceIDInsensitively ¶
func ParseCommunicationServiceIDInsensitively(input string) (*CommunicationServiceId, error)
ParseCommunicationServiceIDInsensitively parses 'input' case-insensitively into a CommunicationServiceId note: this method should only be used for API response data and not user input
func (*CommunicationServiceId) FromParseResult ¶
func (id *CommunicationServiceId) FromParseResult(input resourceids.ParseResult) error
func (CommunicationServiceId) ID ¶
func (id CommunicationServiceId) ID() string
ID returns the formatted Communication Service ID
func (CommunicationServiceId) Segments ¶
func (id CommunicationServiceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Communication Service ID
func (CommunicationServiceId) String ¶
func (id CommunicationServiceId) String() string
String returns a human-readable description of this Communication Service ID
type CommunicationServiceProperties ¶
type CommunicationServiceProperties struct { DataLocation string `json:"dataLocation"` HostName *string `json:"hostName,omitempty"` ImmutableResourceId *string `json:"immutableResourceId,omitempty"` LinkedDomains *[]string `json:"linkedDomains,omitempty"` NotificationHubId *string `json:"notificationHubId,omitempty"` ProvisioningState *CommunicationServicesProvisioningState `json:"provisioningState,omitempty"` Version *string `json:"version,omitempty"` }
type CommunicationServiceResource ¶
type CommunicationServiceResource struct { Id *string `json:"id,omitempty"` Identity *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"` Location string `json:"location"` Name *string `json:"name,omitempty"` Properties *CommunicationServiceProperties `json:"properties,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Tags *map[string]string `json:"tags,omitempty"` Type *string `json:"type,omitempty"` }
type CommunicationServiceResourceOperationPredicate ¶
type CommunicationServiceResourceOperationPredicate struct { Id *string Location *string Name *string Type *string }
func (CommunicationServiceResourceOperationPredicate) Matches ¶
func (p CommunicationServiceResourceOperationPredicate) Matches(input CommunicationServiceResource) bool
type CommunicationServiceResourceUpdate ¶
type CommunicationServiceResourceUpdate struct { Identity *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"` Properties *CommunicationServiceUpdateProperties `json:"properties,omitempty"` Tags *map[string]string `json:"tags,omitempty"` }
type CommunicationServiceUpdateProperties ¶
type CommunicationServiceUpdateProperties struct {
LinkedDomains *[]string `json:"linkedDomains,omitempty"`
}
type CommunicationServicesClient ¶
type CommunicationServicesClient struct {
Client *resourcemanager.Client
}
func NewCommunicationServicesClientWithBaseURI ¶
func NewCommunicationServicesClientWithBaseURI(sdkApi sdkEnv.Api) (*CommunicationServicesClient, error)
func (CommunicationServicesClient) CheckNameAvailability ¶
func (c CommunicationServicesClient) CheckNameAvailability(ctx context.Context, id commonids.SubscriptionId, input CheckNameAvailabilityRequest) (result CheckNameAvailabilityOperationResponse, err error)
CheckNameAvailability ...
func (CommunicationServicesClient) CreateOrUpdate ¶
func (c CommunicationServicesClient) CreateOrUpdate(ctx context.Context, id CommunicationServiceId, input CommunicationServiceResource) (result CreateOrUpdateOperationResponse, err error)
CreateOrUpdate ...
func (CommunicationServicesClient) CreateOrUpdateThenPoll ¶
func (c CommunicationServicesClient) CreateOrUpdateThenPoll(ctx context.Context, id CommunicationServiceId, input CommunicationServiceResource) error
CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed
func (CommunicationServicesClient) Delete ¶
func (c CommunicationServicesClient) Delete(ctx context.Context, id CommunicationServiceId) (result DeleteOperationResponse, err error)
Delete ...
func (CommunicationServicesClient) DeleteThenPoll ¶
func (c CommunicationServicesClient) DeleteThenPoll(ctx context.Context, id CommunicationServiceId) error
DeleteThenPoll performs Delete then polls until it's completed
func (CommunicationServicesClient) Get ¶
func (c CommunicationServicesClient) Get(ctx context.Context, id CommunicationServiceId) (result GetOperationResponse, err error)
Get ...
func (CommunicationServicesClient) LinkNotificationHub ¶
func (c CommunicationServicesClient) LinkNotificationHub(ctx context.Context, id CommunicationServiceId, input LinkNotificationHubParameters) (result LinkNotificationHubOperationResponse, err error)
LinkNotificationHub ...
func (CommunicationServicesClient) ListByResourceGroup ¶
func (c CommunicationServicesClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)
ListByResourceGroup ...
func (CommunicationServicesClient) ListByResourceGroupComplete ¶
func (c CommunicationServicesClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)
ListByResourceGroupComplete retrieves all the results into a single object
func (CommunicationServicesClient) ListByResourceGroupCompleteMatchingPredicate ¶
func (c CommunicationServicesClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate CommunicationServiceResourceOperationPredicate) (result ListByResourceGroupCompleteResult, err error)
ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (CommunicationServicesClient) ListBySubscription ¶
func (c CommunicationServicesClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)
ListBySubscription ...
func (CommunicationServicesClient) ListBySubscriptionComplete ¶
func (c CommunicationServicesClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)
ListBySubscriptionComplete retrieves all the results into a single object
func (CommunicationServicesClient) ListBySubscriptionCompleteMatchingPredicate ¶
func (c CommunicationServicesClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate CommunicationServiceResourceOperationPredicate) (result ListBySubscriptionCompleteResult, err error)
ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate
func (CommunicationServicesClient) ListKeys ¶
func (c CommunicationServicesClient) ListKeys(ctx context.Context, id CommunicationServiceId) (result ListKeysOperationResponse, err error)
ListKeys ...
func (CommunicationServicesClient) RegenerateKey ¶
func (c CommunicationServicesClient) RegenerateKey(ctx context.Context, id CommunicationServiceId, input RegenerateKeyParameters) (result RegenerateKeyOperationResponse, err error)
RegenerateKey ...
func (CommunicationServicesClient) Update ¶
func (c CommunicationServicesClient) Update(ctx context.Context, id CommunicationServiceId, input CommunicationServiceResourceUpdate) (result UpdateOperationResponse, err error)
Update ...
type CommunicationServicesProvisioningState ¶
type CommunicationServicesProvisioningState string
const ( CommunicationServicesProvisioningStateCanceled CommunicationServicesProvisioningState = "Canceled" CommunicationServicesProvisioningStateCreating CommunicationServicesProvisioningState = "Creating" CommunicationServicesProvisioningStateDeleting CommunicationServicesProvisioningState = "Deleting" CommunicationServicesProvisioningStateFailed CommunicationServicesProvisioningState = "Failed" CommunicationServicesProvisioningStateMoving CommunicationServicesProvisioningState = "Moving" CommunicationServicesProvisioningStateRunning CommunicationServicesProvisioningState = "Running" CommunicationServicesProvisioningStateSucceeded CommunicationServicesProvisioningState = "Succeeded" CommunicationServicesProvisioningStateUnknown CommunicationServicesProvisioningState = "Unknown" CommunicationServicesProvisioningStateUpdating CommunicationServicesProvisioningState = "Updating" )
func (*CommunicationServicesProvisioningState) UnmarshalJSON ¶
func (s *CommunicationServicesProvisioningState) UnmarshalJSON(bytes []byte) error
type DeleteOperationResponse ¶
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *CommunicationServiceResource }
type LinkNotificationHubOperationResponse ¶
type LinkNotificationHubOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *LinkedNotificationHub }
type LinkedNotificationHub ¶
type LinkedNotificationHub struct {
ResourceId *string `json:"resourceId,omitempty"`
}
type ListByResourceGroupCompleteResult ¶
type ListByResourceGroupCompleteResult struct { LatestHttpResponse *http.Response Items []CommunicationServiceResource }
type ListByResourceGroupCustomPager ¶ added in v0.20240628.1153531
func (*ListByResourceGroupCustomPager) NextPageLink ¶ added in v0.20240628.1153531
func (p *ListByResourceGroupCustomPager) NextPageLink() *odata.Link
type ListByResourceGroupOperationResponse ¶
type ListByResourceGroupOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]CommunicationServiceResource }
type ListBySubscriptionCompleteResult ¶
type ListBySubscriptionCompleteResult struct { LatestHttpResponse *http.Response Items []CommunicationServiceResource }
type ListBySubscriptionCustomPager ¶ added in v0.20240628.1153531
func (*ListBySubscriptionCustomPager) NextPageLink ¶ added in v0.20240628.1153531
func (p *ListBySubscriptionCustomPager) NextPageLink() *odata.Link
type ListBySubscriptionOperationResponse ¶
type ListBySubscriptionOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *[]CommunicationServiceResource }
type ListKeysOperationResponse ¶
type ListKeysOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *CommunicationServiceKeys }
type RegenerateKeyOperationResponse ¶
type RegenerateKeyOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *CommunicationServiceKeys }
type RegenerateKeyParameters ¶
type RegenerateKeyParameters struct {
KeyType *KeyType `json:"keyType,omitempty"`
}
type UpdateOperationResponse ¶
type UpdateOperationResponse struct { HttpResponse *http.Response OData *odata.OData Model *CommunicationServiceResource }
Source Files ¶
- client.go
- constants.go
- id_communicationservice.go
- method_checknameavailability.go
- method_createorupdate.go
- method_delete.go
- method_get.go
- method_linknotificationhub.go
- method_listbyresourcegroup.go
- method_listbysubscription.go
- method_listkeys.go
- method_regeneratekey.go
- method_update.go
- model_checknameavailabilityrequest.go
- model_checknameavailabilityresponse.go
- model_communicationservicekeys.go
- model_communicationserviceproperties.go
- model_communicationserviceresource.go
- model_communicationserviceresourceupdate.go
- model_communicationserviceupdateproperties.go
- model_linkednotificationhub.go
- model_linknotificationhubparameters.go
- model_regeneratekeyparameters.go
- predicates.go
- version.go