address

README

github.com/hashicorp/go-azure-sdk/resource-manager/billing/2020-05-01/address Documentation

The address SDK allows for interaction with Azure Resource Manager billing (API Version 2020-05-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/billing/2020-05-01/address"

Client Initialization

client := address.NewAddressClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AddressClient.Validate

ctx := context.TODO()

payload := address.AddressDetails{
	// ...
}


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

Documentation

Index

• func PossibleValuesForAddressValidationStatus() []string
• type AddressClient
  • func NewAddressClientWithBaseURI(sdkApi sdkEnv.Api) (*AddressClient, error)
  • func (c AddressClient) Validate(ctx context.Context, input AddressDetails) (result ValidateOperationResponse, err error)
• type AddressDetails
• type AddressValidationStatus
  • func (s *AddressValidationStatus) UnmarshalJSON(bytes []byte) error
• type ValidateAddressResponse
• type ValidateOperationResponse

Functions

func PossibleValuesForAddressValidationStatus

func PossibleValuesForAddressValidationStatus() []string

Types

type AddressClient

type AddressClient struct {
	Client *resourcemanager.Client
}

func NewAddressClientWithBaseURI

func NewAddressClientWithBaseURI(sdkApi sdkEnv.Api) (*AddressClient, error)

func (AddressClient) Validate

func (c AddressClient) Validate(ctx context.Context, input AddressDetails) (result ValidateOperationResponse, err error)

Validate ...

type AddressDetails

type AddressDetails struct {
	AddressLine1 string  `json:"addressLine1"`
	AddressLine2 *string `json:"addressLine2,omitempty"`
	AddressLine3 *string `json:"addressLine3,omitempty"`
	City         *string `json:"city,omitempty"`
	CompanyName  *string `json:"companyName,omitempty"`
	Country      string  `json:"country"`
	District     *string `json:"district,omitempty"`
	Email        *string `json:"email,omitempty"`
	FirstName    *string `json:"firstName,omitempty"`
	LastName     *string `json:"lastName,omitempty"`
	MiddleName   *string `json:"middleName,omitempty"`
	PhoneNumber  *string `json:"phoneNumber,omitempty"`
	PostalCode   *string `json:"postalCode,omitempty"`
	Region       *string `json:"region,omitempty"`
}

type AddressValidationStatus

type AddressValidationStatus string

const (
	AddressValidationStatusInvalid AddressValidationStatus = "Invalid"
	AddressValidationStatusValid   AddressValidationStatus = "Valid"
)

func (*AddressValidationStatus) UnmarshalJSON

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

type ValidateAddressResponse

type ValidateAddressResponse struct {
	Status             *AddressValidationStatus `json:"status,omitempty"`
	SuggestedAddresses *[]AddressDetails        `json:"suggestedAddresses,omitempty"`
	ValidationMessage  *string                  `json:"validationMessage,omitempty"`
}

type ValidateOperationResponse

type ValidateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ValidateAddressResponse
}