emailregistration

README

github.com/hashicorp/go-azure-sdk/resource-manager/datashare/2021-08-01/emailregistration Documentation

The emailregistration SDK allows for interaction with the Azure Resource Manager Service datashare (API Version 2021-08-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/datashare/2021-08-01/emailregistration"

Client Initialization

client := emailregistration.NewEmailRegistrationClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EmailRegistrationClient.ActivateEmail

ctx := context.TODO()
id := emailregistration.NewLocationID("locationValue")

payload := emailregistration.EmailRegistration{
	// ...
}


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

Example Usage: EmailRegistrationClient.RegisterEmail

ctx := context.TODO()
id := emailregistration.NewLocationID("locationValue")

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

Documentation

Index

• func PossibleValuesForRegistrationStatus() []string
• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type ActivateEmailOperationResponse
• type EmailRegistration
  • func (o *EmailRegistration) GetActivationExpirationDateAsTime() (*time.Time, error)
  • func (o *EmailRegistration) SetActivationExpirationDateAsTime(input time.Time)
• type EmailRegistrationClient
  • func NewEmailRegistrationClientWithBaseURI(sdkApi sdkEnv.Api) (*EmailRegistrationClient, error)
  • func (c EmailRegistrationClient) ActivateEmail(ctx context.Context, id LocationId, input EmailRegistration) (result ActivateEmailOperationResponse, err error)
  • func (c EmailRegistrationClient) RegisterEmail(ctx context.Context, id LocationId) (result RegisterEmailOperationResponse, err error)
• type LocationId
  • func NewLocationID(locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id *LocationId) FromParseResult(input resourceids.ParseResult) error
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type RegisterEmailOperationResponse
• type RegistrationStatus
  • func (s *RegistrationStatus) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForRegistrationStatus

func PossibleValuesForRegistrationStatus() []string

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type ActivateEmailOperationResponse

type ActivateEmailOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EmailRegistration
}

type EmailRegistration

type EmailRegistration struct {
	ActivationCode           *string             `json:"activationCode,omitempty"`
	ActivationExpirationDate *string             `json:"activationExpirationDate,omitempty"`
	Email                    *string             `json:"email,omitempty"`
	RegistrationStatus       *RegistrationStatus `json:"registrationStatus,omitempty"`
	TenantId                 *string             `json:"tenantId,omitempty"`
}

func (*EmailRegistration) GetActivationExpirationDateAsTime

func (o *EmailRegistration) GetActivationExpirationDateAsTime() (*time.Time, error)

func (*EmailRegistration) SetActivationExpirationDateAsTime

func (o *EmailRegistration) SetActivationExpirationDateAsTime(input time.Time)

type EmailRegistrationClient

type EmailRegistrationClient struct {
	Client *resourcemanager.Client
}

func NewEmailRegistrationClientWithBaseURI

func NewEmailRegistrationClientWithBaseURI(sdkApi sdkEnv.Api) (*EmailRegistrationClient, error)

func (EmailRegistrationClient) ActivateEmail

func (c EmailRegistrationClient) ActivateEmail(ctx context.Context, id LocationId, input EmailRegistration) (result ActivateEmailOperationResponse, err error)

ActivateEmail ...

func (EmailRegistrationClient) RegisterEmail

func (c EmailRegistrationClient) RegisterEmail(ctx context.Context, id LocationId) (result RegisterEmailOperationResponse, err error)

RegisterEmail ...

type LocationId

type LocationId struct {
	LocationName string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (*LocationId) FromParseResult

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Location ID

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type RegisterEmailOperationResponse

type RegisterEmailOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *EmailRegistration
}

type RegistrationStatus

type RegistrationStatus string

const (
	RegistrationStatusActivated                   RegistrationStatus = "Activated"
	RegistrationStatusActivationAttemptsExhausted RegistrationStatus = "ActivationAttemptsExhausted"
	RegistrationStatusActivationPending           RegistrationStatus = "ActivationPending"
)

func (*RegistrationStatus) UnmarshalJSON

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