cdn

package
v14.0.2+incompatible Latest Latest
Warning

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

 Go to latest Published: Feb 14, 2018 License: Apache-2.0 Imports: 8 Imported by: 108

Documentation ¶

Overview ¶

Package cdn implements the Azure ARM Cdn service API version 2016-10-02.

Use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure.

Index ¶

Constants ¶

View Source 
const (
	// DefaultBaseURI is the default URI used for the service Cdn
	DefaultBaseURI = "https://management.azure.com"
)

Variables ¶

This section is empty.

Functions ¶

func UserAgent ¶ 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version ¶ 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types ¶

type BaseClient ¶ 

type BaseClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

BaseClient is the base client for Cdn.

func New ¶ 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI ¶ 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

func (BaseClient) CheckNameAvailability ¶ 

func (client BaseClient) CheckNameAvailability(ctx context.Context, checkNameAvailabilityInput CheckNameAvailabilityInput) (result CheckNameAvailabilityOutput, err error)

CheckNameAvailability check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

checkNameAvailabilityInput is input to check.

func (BaseClient) CheckNameAvailabilityPreparer ¶ 

func (client BaseClient) CheckNameAvailabilityPreparer(ctx context.Context, checkNameAvailabilityInput CheckNameAvailabilityInput) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (BaseClient) CheckNameAvailabilityResponder ¶ 

func (client BaseClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityOutput, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (BaseClient) CheckNameAvailabilitySender ¶ 

func (client BaseClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.

func (BaseClient) ListOperations ¶ 

func (client BaseClient) ListOperations(ctx context.Context) (result OperationListResultPage, err error)

ListOperations lists all of the available CDN REST API operations.

func (BaseClient) ListOperationsComplete ¶ 

func (client BaseClient) ListOperationsComplete(ctx context.Context) (result OperationListResultIterator, err error)

ListOperationsComplete enumerates all values, automatically crossing page boundaries as required.

func (BaseClient) ListOperationsPreparer ¶ 

func (client BaseClient) ListOperationsPreparer(ctx context.Context) (*http.Request, error)

ListOperationsPreparer prepares the ListOperations request.

func (BaseClient) ListOperationsResponder ¶ 

func (client BaseClient) ListOperationsResponder(resp *http.Response) (result OperationListResult, err error)

ListOperationsResponder handles the response to the ListOperations request. The method always closes the http.Response Body.

func (BaseClient) ListOperationsSender ¶ 

func (client BaseClient) ListOperationsSender(req *http.Request) (*http.Response, error)

ListOperationsSender sends the ListOperations request. The method will close the http.Response Body if it receives an error.

func (BaseClient) ListResourceUsage ¶ 

func (client BaseClient) ListResourceUsage(ctx context.Context) (result ResourceUsageListResultPage, err error)

ListResourceUsage check the quota and actual usage of the CDN profiles under the given subscription.

func (BaseClient) ListResourceUsageComplete ¶ 

func (client BaseClient) ListResourceUsageComplete(ctx context.Context) (result ResourceUsageListResultIterator, err error)

ListResourceUsageComplete enumerates all values, automatically crossing page boundaries as required.

func (BaseClient) ListResourceUsagePreparer ¶ 

func (client BaseClient) ListResourceUsagePreparer(ctx context.Context) (*http.Request, error)

ListResourceUsagePreparer prepares the ListResourceUsage request.

func (BaseClient) ListResourceUsageResponder ¶ 

func (client BaseClient) ListResourceUsageResponder(resp *http.Response) (result ResourceUsageListResult, err error)

ListResourceUsageResponder handles the response to the ListResourceUsage request. The method always closes the http.Response Body.

func (BaseClient) ListResourceUsageSender ¶ 

func (client BaseClient) ListResourceUsageSender(req *http.Request) (*http.Response, error)

ListResourceUsageSender sends the ListResourceUsage request. The method will close the http.Response Body if it receives an error.

type CheckNameAvailabilityInput ¶ 

type CheckNameAvailabilityInput struct {
	// Name - The resource name to validate.
	Name *string `json:"name,omitempty"`
	// Type - The type of the resource whose name is to be validated.
	Type *string `json:"type,omitempty"`
}

CheckNameAvailabilityInput input of CheckNameAvailability API.

type CheckNameAvailabilityOutput ¶ 

type CheckNameAvailabilityOutput struct {
	autorest.Response `json:"-"`
	// NameAvailable - Indicates whether the name is available.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Reason - The reason why the name is not available.
	Reason *string `json:"reason,omitempty"`
	// Message - The detailed error message describing why the name is not available.
	Message *string `json:"message,omitempty"`
}

CheckNameAvailabilityOutput output of check name availability API.

type CidrIPAddress ¶ 

type CidrIPAddress struct {
	// BaseIPAddress - Ip adress itself.
	BaseIPAddress *string `json:"baseIpAddress,omitempty"`
	// PrefixLength - The length of the prefix of the ip address.
	PrefixLength *int32 `json:"prefixLength,omitempty"`
}

CidrIPAddress CIDR Ip address

type CustomDomain ¶ 

type CustomDomain struct {
	autorest.Response       `json:"-"`
	*CustomDomainProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

CustomDomain customer provided domain for branding purposes, e.g. www.consoto.com.

func (CustomDomain) MarshalJSON ¶ 

func (cd CustomDomain) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CustomDomain.

func (*CustomDomain) UnmarshalJSON ¶ 

func (cd *CustomDomain) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CustomDomain struct.

type CustomDomainListResult ¶ 

type CustomDomainListResult struct {
	autorest.Response `json:"-"`
	// Value - List of CDN CustomDomains within an endpoint.
	Value *[]CustomDomain `json:"value,omitempty"`
	// NextLink - URL to get the next set of custom domain objects if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

CustomDomainListResult result of the request to list custom domains. It contains a list of custom domain objects and a URL link to get the next set of results.

func (CustomDomainListResult) IsEmpty ¶ 

func (cdlr CustomDomainListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type CustomDomainListResultIterator ¶ 

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

CustomDomainListResultIterator provides access to a complete listing of CustomDomain values.

func (*CustomDomainListResultIterator) Next ¶ 

func (iter *CustomDomainListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (CustomDomainListResultIterator) NotDone ¶ 

func (iter CustomDomainListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (CustomDomainListResultIterator) Response ¶ 

func (iter CustomDomainListResultIterator) Response() CustomDomainListResult

Response returns the raw server response from the last page request.

func (CustomDomainListResultIterator) Value ¶ 

func (iter CustomDomainListResultIterator) Value() CustomDomain

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type CustomDomainListResultPage ¶ 

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

CustomDomainListResultPage contains a page of CustomDomain values.

func (*CustomDomainListResultPage) Next ¶ 

func (page *CustomDomainListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (CustomDomainListResultPage) NotDone ¶ 

func (page CustomDomainListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (CustomDomainListResultPage) Response ¶ 

func (page CustomDomainListResultPage) Response() CustomDomainListResult

Response returns the raw server response from the last page request.

func (CustomDomainListResultPage) Values ¶ 

func (page CustomDomainListResultPage) Values() []CustomDomain

Values returns the slice of values for the current page or nil if there are no values.

type CustomDomainParameters ¶ 

type CustomDomainParameters struct {
	*CustomDomainPropertiesParameters `json:"properties,omitempty"`
}

CustomDomainParameters the customDomain JSON object required for custom domain creation or update.

func (*CustomDomainParameters) UnmarshalJSON ¶ 

func (cdp *CustomDomainParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CustomDomainParameters struct.

type CustomDomainProperties ¶ 

type CustomDomainProperties struct {
	// HostName - The host name of the custom domain. Must be a domain name.
	HostName *string `json:"hostName,omitempty"`
	// ResourceState - Resource status of the custom domain. Possible values include: 'Creating', 'Active', 'Deleting'
	ResourceState CustomDomainResourceState `json:"resourceState,omitempty"`
	// CustomHTTPSProvisioningState - Provisioning state of Custom Https of the custom domain. Possible values include: 'Enabling', 'Enabled', 'Disabling', 'Disabled', 'Failed'
	CustomHTTPSProvisioningState CustomHTTPSProvisioningState `json:"customHttpsProvisioningState,omitempty"`
	// ValidationData - Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.
	ValidationData *string `json:"validationData,omitempty"`
	// ProvisioningState - Provisioning status of the custom domain.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

CustomDomainProperties the JSON object that contains the properties of the custom domain to create.

type CustomDomainPropertiesParameters ¶ 

type CustomDomainPropertiesParameters struct {
	// HostName - The host name of the custom domain. Must be a domain name.
	HostName *string `json:"hostName,omitempty"`
}

CustomDomainPropertiesParameters the JSON object that contains the properties of the custom domain to create.

type CustomDomainResourceState ¶ 

type CustomDomainResourceState string

CustomDomainResourceState enumerates the values for custom domain resource state. 

const (
	// Active ...
	Active CustomDomainResourceState = "Active"
	// Creating ...
	Creating CustomDomainResourceState = "Creating"
	// Deleting ...
	Deleting CustomDomainResourceState = "Deleting"
)

type CustomDomainsClient ¶ 

type CustomDomainsClient struct {
	BaseClient
}

CustomDomainsClient is the use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure.

func NewCustomDomainsClient ¶ 

func NewCustomDomainsClient(subscriptionID string) CustomDomainsClient

NewCustomDomainsClient creates an instance of the CustomDomainsClient client.

func NewCustomDomainsClientWithBaseURI ¶ 

func NewCustomDomainsClientWithBaseURI(baseURI string, subscriptionID string) CustomDomainsClient

NewCustomDomainsClientWithBaseURI creates an instance of the CustomDomainsClient client.

func (CustomDomainsClient) Create ¶ 

func (client CustomDomainsClient) Create(ctx context.Context, resourceGroupName string, profileName string, endpointName string, customDomainName string, customDomainProperties CustomDomainParameters) (result CustomDomainsCreateFuture, err error)

Create creates a new custom domain within an endpoint.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally. customDomainName is name of the custom domain within an endpoint. customDomainProperties is properties required to create a new custom domain.

func (CustomDomainsClient) CreatePreparer ¶ 

func (client CustomDomainsClient) CreatePreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string, customDomainName string, customDomainProperties CustomDomainParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (CustomDomainsClient) CreateResponder ¶ 

func (client CustomDomainsClient) CreateResponder(resp *http.Response) (result CustomDomain, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (CustomDomainsClient) CreateSender ¶ 

func (client CustomDomainsClient) CreateSender(req *http.Request) (future CustomDomainsCreateFuture, err error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (CustomDomainsClient) Delete ¶ 

func (client CustomDomainsClient) Delete(ctx context.Context, resourceGroupName string, profileName string, endpointName string, customDomainName string) (result CustomDomainsDeleteFuture, err error)

Delete deletes an existing custom domain within an endpoint.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally. customDomainName is name of the custom domain within an endpoint.

func (CustomDomainsClient) DeletePreparer ¶ 

func (client CustomDomainsClient) DeletePreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string, customDomainName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (CustomDomainsClient) DeleteResponder ¶ 

func (client CustomDomainsClient) DeleteResponder(resp *http.Response) (result CustomDomain, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (CustomDomainsClient) DeleteSender ¶ 

func (client CustomDomainsClient) DeleteSender(req *http.Request) (future CustomDomainsDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (CustomDomainsClient) DisableCustomHTTPS ¶ 

func (client CustomDomainsClient) DisableCustomHTTPS(ctx context.Context, resourceGroupName string, profileName string, endpointName string, customDomainName string) (result CustomDomain, err error)

DisableCustomHTTPS disable https delivery of the custom domain.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally. customDomainName is name of the custom domain within an endpoint.

func (CustomDomainsClient) DisableCustomHTTPSPreparer ¶ 

func (client CustomDomainsClient) DisableCustomHTTPSPreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string, customDomainName string) (*http.Request, error)

DisableCustomHTTPSPreparer prepares the DisableCustomHTTPS request.

func (CustomDomainsClient) DisableCustomHTTPSResponder ¶ 

func (client CustomDomainsClient) DisableCustomHTTPSResponder(resp *http.Response) (result CustomDomain, err error)

DisableCustomHTTPSResponder handles the response to the DisableCustomHTTPS request. The method always closes the http.Response Body.

func (CustomDomainsClient) DisableCustomHTTPSSender ¶ 

func (client CustomDomainsClient) DisableCustomHTTPSSender(req *http.Request) (*http.Response, error)

DisableCustomHTTPSSender sends the DisableCustomHTTPS request. The method will close the http.Response Body if it receives an error.

func (CustomDomainsClient) EnableCustomHTTPS ¶ 

func (client CustomDomainsClient) EnableCustomHTTPS(ctx context.Context, resourceGroupName string, profileName string, endpointName string, customDomainName string) (result CustomDomain, err error)

EnableCustomHTTPS enable https delivery of the custom domain.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally. customDomainName is name of the custom domain within an endpoint.

func (CustomDomainsClient) EnableCustomHTTPSPreparer ¶ 

func (client CustomDomainsClient) EnableCustomHTTPSPreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string, customDomainName string) (*http.Request, error)

EnableCustomHTTPSPreparer prepares the EnableCustomHTTPS request.

func (CustomDomainsClient) EnableCustomHTTPSResponder ¶ 

func (client CustomDomainsClient) EnableCustomHTTPSResponder(resp *http.Response) (result CustomDomain, err error)

EnableCustomHTTPSResponder handles the response to the EnableCustomHTTPS request. The method always closes the http.Response Body.

func (CustomDomainsClient) EnableCustomHTTPSSender ¶ 

func (client CustomDomainsClient) EnableCustomHTTPSSender(req *http.Request) (*http.Response, error)

EnableCustomHTTPSSender sends the EnableCustomHTTPS request. The method will close the http.Response Body if it receives an error.

func (CustomDomainsClient) Get ¶ 

func (client CustomDomainsClient) Get(ctx context.Context, resourceGroupName string, profileName string, endpointName string, customDomainName string) (result CustomDomain, err error)

Get gets an exisitng custom domain within an endpoint.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally. customDomainName is name of the custom domain within an endpoint.

func (CustomDomainsClient) GetPreparer ¶ 

func (client CustomDomainsClient) GetPreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string, customDomainName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (CustomDomainsClient) GetResponder ¶ 

func (client CustomDomainsClient) GetResponder(resp *http.Response) (result CustomDomain, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (CustomDomainsClient) GetSender ¶ 

func (client CustomDomainsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (CustomDomainsClient) ListByEndpoint ¶ 

func (client CustomDomainsClient) ListByEndpoint(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (result CustomDomainListResultPage, err error)

ListByEndpoint lists all of the existing custom domains within an endpoint.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally.

func (CustomDomainsClient) ListByEndpointComplete ¶ 

func (client CustomDomainsClient) ListByEndpointComplete(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (result CustomDomainListResultIterator, err error)

ListByEndpointComplete enumerates all values, automatically crossing page boundaries as required.

func (CustomDomainsClient) ListByEndpointPreparer ¶ 

func (client CustomDomainsClient) ListByEndpointPreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (*http.Request, error)

ListByEndpointPreparer prepares the ListByEndpoint request.

func (CustomDomainsClient) ListByEndpointResponder ¶ 

func (client CustomDomainsClient) ListByEndpointResponder(resp *http.Response) (result CustomDomainListResult, err error)

ListByEndpointResponder handles the response to the ListByEndpoint request. The method always closes the http.Response Body.

func (CustomDomainsClient) ListByEndpointSender ¶ 

func (client CustomDomainsClient) ListByEndpointSender(req *http.Request) (*http.Response, error)

ListByEndpointSender sends the ListByEndpoint request. The method will close the http.Response Body if it receives an error.

type CustomDomainsCreateFuture ¶ 

type CustomDomainsCreateFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

CustomDomainsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (CustomDomainsCreateFuture) Result ¶ 

func (future CustomDomainsCreateFuture) Result(client CustomDomainsClient) (cd CustomDomain, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type CustomDomainsDeleteFuture ¶ 

type CustomDomainsDeleteFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

CustomDomainsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (CustomDomainsDeleteFuture) Result ¶ 

func (future CustomDomainsDeleteFuture) Result(client CustomDomainsClient) (cd CustomDomain, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type CustomHTTPSProvisioningState ¶ 

type CustomHTTPSProvisioningState string

CustomHTTPSProvisioningState enumerates the values for custom https provisioning state. 

const (
	// Disabled ...
	Disabled CustomHTTPSProvisioningState = "Disabled"
	// Disabling ...
	Disabling CustomHTTPSProvisioningState = "Disabling"
	// Enabled ...
	Enabled CustomHTTPSProvisioningState = "Enabled"
	// Enabling ...
	Enabling CustomHTTPSProvisioningState = "Enabling"
	// Failed ...
	Failed CustomHTTPSProvisioningState = "Failed"
)

type DeepCreatedOrigin ¶ 

type DeepCreatedOrigin struct {
	// Name - Origin name
	Name                         *string `json:"name,omitempty"`
	*DeepCreatedOriginProperties `json:"properties,omitempty"`
}

DeepCreatedOrigin origin to be added when creating a CDN endpoint.

func (*DeepCreatedOrigin) UnmarshalJSON ¶ 

func (dco *DeepCreatedOrigin) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DeepCreatedOrigin struct.

type DeepCreatedOriginProperties ¶ 

type DeepCreatedOriginProperties struct {
	// HostName - The address of the origin. It can be a domain names, IPv4 address, or IPv6 address.
	HostName *string `json:"hostName,omitempty"`
	// HTTPPort - The value of the HTTP port. Must be between 1 and 65535
	HTTPPort *int32 `json:"httpPort,omitempty"`
	// HTTPSPort - The value of the HTTPS port. Must be between 1 and 65535
	HTTPSPort *int32 `json:"httpsPort,omitempty"`
}

DeepCreatedOriginProperties properties of origin Properties of the origin created on the CDN endpoint.

type EdgeNode ¶ 

type EdgeNode struct {
	*EdgeNodeProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

EdgeNode edge node of CDN service.

func (EdgeNode) MarshalJSON ¶ 

func (en EdgeNode) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EdgeNode.

func (*EdgeNode) UnmarshalJSON ¶ 

func (en *EdgeNode) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EdgeNode struct.

type EdgeNodeProperties ¶ 

type EdgeNodeProperties struct {
	// IPAddressGroups - List of ip address groups.
	IPAddressGroups *[]IPAddressGroup `json:"ipAddressGroups,omitempty"`
}

EdgeNodeProperties the JSON object that contains the properties required to create an edgenode.

type EdgeNodesClient ¶ 

type EdgeNodesClient struct {
	BaseClient
}

EdgeNodesClient is the use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure.

func NewEdgeNodesClient ¶ 

func NewEdgeNodesClient(subscriptionID string) EdgeNodesClient

NewEdgeNodesClient creates an instance of the EdgeNodesClient client.

func NewEdgeNodesClientWithBaseURI ¶ 

func NewEdgeNodesClientWithBaseURI(baseURI string, subscriptionID string) EdgeNodesClient

NewEdgeNodesClientWithBaseURI creates an instance of the EdgeNodesClient client.

func (EdgeNodesClient) List ¶ 

func (client EdgeNodesClient) List(ctx context.Context) (result EdgenodeResultPage, err error)

List lists all the edge nodes of a CDN service.

func (EdgeNodesClient) ListComplete ¶ 

func (client EdgeNodesClient) ListComplete(ctx context.Context) (result EdgenodeResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (EdgeNodesClient) ListPreparer ¶ 

func (client EdgeNodesClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (EdgeNodesClient) ListResponder ¶ 

func (client EdgeNodesClient) ListResponder(resp *http.Response) (result EdgenodeResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (EdgeNodesClient) ListSender ¶ 

func (client EdgeNodesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type EdgenodeResult ¶ 

type EdgenodeResult struct {
	autorest.Response `json:"-"`
	// Value - Edge node of CDN service.
	Value *[]EdgeNode `json:"value,omitempty"`
	// NextLink - URL to get the next set of edgenode list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

EdgenodeResult result of the request to list CDN edgenodes. It contains a list of ip address group and a URL link to get the next set of results.

func (EdgenodeResult) IsEmpty ¶ 

func (er EdgenodeResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EdgenodeResultIterator ¶ 

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

EdgenodeResultIterator provides access to a complete listing of EdgeNode values.

func (*EdgenodeResultIterator) Next ¶ 

func (iter *EdgenodeResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (EdgenodeResultIterator) NotDone ¶ 

func (iter EdgenodeResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (EdgenodeResultIterator) Response ¶ 

func (iter EdgenodeResultIterator) Response() EdgenodeResult

Response returns the raw server response from the last page request.

func (EdgenodeResultIterator) Value ¶ 

func (iter EdgenodeResultIterator) Value() EdgeNode

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type EdgenodeResultPage ¶ 

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

EdgenodeResultPage contains a page of EdgeNode values.

func (*EdgenodeResultPage) Next ¶ 

func (page *EdgenodeResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (EdgenodeResultPage) NotDone ¶ 

func (page EdgenodeResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (EdgenodeResultPage) Response ¶ 

func (page EdgenodeResultPage) Response() EdgenodeResult

Response returns the raw server response from the last page request.

func (EdgenodeResultPage) Values ¶ 

func (page EdgenodeResultPage) Values() []EdgeNode

Values returns the slice of values for the current page or nil if there are no values.

type Endpoint ¶ 

type Endpoint struct {
	autorest.Response   `json:"-"`
	*EndpointProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

Endpoint CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format <endpointname>.azureedge.net.

func (Endpoint) MarshalJSON ¶ 

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

MarshalJSON is the custom marshaler for Endpoint.

func (*Endpoint) UnmarshalJSON ¶ 

func (e *Endpoint) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Endpoint struct.

type EndpointListResult ¶ 

type EndpointListResult struct {
	autorest.Response `json:"-"`
	// Value - List of CDN endpoints within a profile
	Value *[]Endpoint `json:"value,omitempty"`
	// NextLink - URL to get the next set of endpoint objects if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

EndpointListResult result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the the next set of results.

func (EndpointListResult) IsEmpty ¶ 

func (elr EndpointListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type EndpointListResultIterator ¶ 

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

EndpointListResultIterator provides access to a complete listing of Endpoint values.

func (*EndpointListResultIterator) Next ¶ 

func (iter *EndpointListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (EndpointListResultIterator) NotDone ¶ 

func (iter EndpointListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (EndpointListResultIterator) Response ¶ 

func (iter EndpointListResultIterator) Response() EndpointListResult

Response returns the raw server response from the last page request.

func (EndpointListResultIterator) Value ¶ 

func (iter EndpointListResultIterator) Value() Endpoint

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type EndpointListResultPage ¶ 

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

EndpointListResultPage contains a page of Endpoint values.

func (*EndpointListResultPage) Next ¶ 

func (page *EndpointListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (EndpointListResultPage) NotDone ¶ 

func (page EndpointListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (EndpointListResultPage) Response ¶ 

func (page EndpointListResultPage) Response() EndpointListResult

Response returns the raw server response from the last page request.

func (EndpointListResultPage) Values ¶ 

func (page EndpointListResultPage) Values() []Endpoint

Values returns the slice of values for the current page or nil if there are no values.

type EndpointProperties ¶ 

type EndpointProperties struct {
	// HostName - The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. consoto.azureedge.net
	HostName *string `json:"hostName,omitempty"`
	// Origins - The source of the content being delivered via CDN.
	Origins *[]DeepCreatedOrigin `json:"origins,omitempty"`
	// ResourceState - Resource status of the endpoint. Possible values include: 'EndpointResourceStateCreating', 'EndpointResourceStateDeleting', 'EndpointResourceStateRunning', 'EndpointResourceStateStarting', 'EndpointResourceStateStopped', 'EndpointResourceStateStopping'
	ResourceState EndpointResourceState `json:"resourceState,omitempty"`
	// ProvisioningState - Provisioning status of the endpoint.
	ProvisioningState *string `json:"provisioningState,omitempty"`
	// OriginHostHeader - The host header CDN sends along with content requests to origin. The default value is the host name of the origin.
	OriginHostHeader *string `json:"originHostHeader,omitempty"`
	// OriginPath - The path used when CDN sends request to origin.
	OriginPath *string `json:"originPath,omitempty"`
	// ContentTypesToCompress - List of content types on which compression applies. The value should be a valid MIME type.
	ContentTypesToCompress *[]string `json:"contentTypesToCompress,omitempty"`
	// IsCompressionEnabled - Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
	IsCompressionEnabled *bool `json:"isCompressionEnabled,omitempty"`
	// IsHTTPAllowed - Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
	IsHTTPAllowed *bool `json:"isHttpAllowed,omitempty"`
	// IsHTTPSAllowed - Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
	IsHTTPSAllowed *bool `json:"isHttpsAllowed,omitempty"`
	// QueryStringCachingBehavior - Defines the query string caching behavior. Possible values include: 'IgnoreQueryString', 'BypassCaching', 'UseQueryString', 'NotSet'
	QueryStringCachingBehavior QueryStringCachingBehavior `json:"queryStringCachingBehavior,omitempty"`
	// OptimizationType - Customer can specify what scenario they want this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. Possible values include: 'GeneralWebDelivery', 'GeneralMediaStreaming', 'VideoOnDemandMediaStreaming', 'LargeFileDownload', 'DynamicSiteAcceleration'
	OptimizationType OptimizationType `json:"optimizationType,omitempty"`
	// GeoFilters - List of rules defining user geo access within a CDN endpoint. Each geo filter defines an acess rule to a specified path or content, e.g. block APAC for path /pictures/
	GeoFilters *[]GeoFilter `json:"geoFilters,omitempty"`
}

EndpointProperties the JSON object that contains the properties required to create an endpoint.

type EndpointPropertiesUpdateParameters ¶ 

type EndpointPropertiesUpdateParameters struct {
	// OriginHostHeader - The host header CDN sends along with content requests to origin. The default value is the host name of the origin.
	OriginHostHeader *string `json:"originHostHeader,omitempty"`
	// OriginPath - The path used when CDN sends request to origin.
	OriginPath *string `json:"originPath,omitempty"`
	// ContentTypesToCompress - List of content types on which compression applies. The value should be a valid MIME type.
	ContentTypesToCompress *[]string `json:"contentTypesToCompress,omitempty"`
	// IsCompressionEnabled - Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.
	IsCompressionEnabled *bool `json:"isCompressionEnabled,omitempty"`
	// IsHTTPAllowed - Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
	IsHTTPAllowed *bool `json:"isHttpAllowed,omitempty"`
	// IsHTTPSAllowed - Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.
	IsHTTPSAllowed *bool `json:"isHttpsAllowed,omitempty"`
	// QueryStringCachingBehavior - Defines the query string caching behavior. Possible values include: 'IgnoreQueryString', 'BypassCaching', 'UseQueryString', 'NotSet'
	QueryStringCachingBehavior QueryStringCachingBehavior `json:"queryStringCachingBehavior,omitempty"`
	// OptimizationType - Customer can specify what scenario they want this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization. Possible values include: 'GeneralWebDelivery', 'GeneralMediaStreaming', 'VideoOnDemandMediaStreaming', 'LargeFileDownload', 'DynamicSiteAcceleration'
	OptimizationType OptimizationType `json:"optimizationType,omitempty"`
	// GeoFilters - List of rules defining user geo access within a CDN endpoint. Each geo filter defines an acess rule to a specified path or content, e.g. block APAC for path /pictures/
	GeoFilters *[]GeoFilter `json:"geoFilters,omitempty"`
}

EndpointPropertiesUpdateParameters result of the request to list endpoints. It contains a list of endpoints and a URL link to get the next set of results.

type EndpointResourceState ¶ 

type EndpointResourceState string

EndpointResourceState enumerates the values for endpoint resource state. 

const (
	// EndpointResourceStateCreating ...
	EndpointResourceStateCreating EndpointResourceState = "Creating"
	// EndpointResourceStateDeleting ...
	EndpointResourceStateDeleting EndpointResourceState = "Deleting"
	// EndpointResourceStateRunning ...
	EndpointResourceStateRunning EndpointResourceState = "Running"
	// EndpointResourceStateStarting ...
	EndpointResourceStateStarting EndpointResourceState = "Starting"
	// EndpointResourceStateStopped ...
	EndpointResourceStateStopped EndpointResourceState = "Stopped"
	// EndpointResourceStateStopping ...
	EndpointResourceStateStopping EndpointResourceState = "Stopping"
)

type EndpointUpdateParameters ¶ 

type EndpointUpdateParameters struct {
	// Tags - Endpoint tags.
	Tags                                map[string]*string `json:"tags"`
	*EndpointPropertiesUpdateParameters `json:"properties,omitempty"`
}

EndpointUpdateParameters properties required to create a new endpoint.

func (EndpointUpdateParameters) MarshalJSON ¶ 

func (eup EndpointUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EndpointUpdateParameters.

func (*EndpointUpdateParameters) UnmarshalJSON ¶ 

func (eup *EndpointUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EndpointUpdateParameters struct.

type EndpointsClient ¶ 

type EndpointsClient struct {
	BaseClient
}

EndpointsClient is the use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure.

func NewEndpointsClient ¶ 

func NewEndpointsClient(subscriptionID string) EndpointsClient

NewEndpointsClient creates an instance of the EndpointsClient client.

func NewEndpointsClientWithBaseURI ¶ 

func NewEndpointsClientWithBaseURI(baseURI string, subscriptionID string) EndpointsClient

NewEndpointsClientWithBaseURI creates an instance of the EndpointsClient client.

func (EndpointsClient) Create ¶ 

func (client EndpointsClient) Create(ctx context.Context, resourceGroupName string, profileName string, endpointName string, endpoint Endpoint) (result EndpointsCreateFuture, err error)

Create creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally. endpoint is endpoint properties

func (EndpointsClient) CreatePreparer ¶ 

func (client EndpointsClient) CreatePreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string, endpoint Endpoint) (*http.Request, error)

CreatePreparer prepares the Create request.

func (EndpointsClient) CreateResponder ¶ 

func (client EndpointsClient) CreateResponder(resp *http.Response) (result Endpoint, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (EndpointsClient) CreateSender ¶ 

func (client EndpointsClient) CreateSender(req *http.Request) (future EndpointsCreateFuture, err error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (EndpointsClient) Delete ¶ 

func (client EndpointsClient) Delete(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (result EndpointsDeleteFuture, err error)

Delete deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally.

func (EndpointsClient) DeletePreparer ¶ 

func (client EndpointsClient) DeletePreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (EndpointsClient) DeleteResponder ¶ 

func (client EndpointsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (EndpointsClient) DeleteSender ¶ 

func (client EndpointsClient) DeleteSender(req *http.Request) (future EndpointsDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (EndpointsClient) Get ¶ 

func (client EndpointsClient) Get(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (result Endpoint, err error)

Get gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally.

func (EndpointsClient) GetPreparer ¶ 

func (client EndpointsClient) GetPreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (EndpointsClient) GetResponder ¶ 

func (client EndpointsClient) GetResponder(resp *http.Response) (result Endpoint, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (EndpointsClient) GetSender ¶ 

func (client EndpointsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (EndpointsClient) ListByProfile ¶ 

func (client EndpointsClient) ListByProfile(ctx context.Context, resourceGroupName string, profileName string) (result EndpointListResultPage, err error)

ListByProfile lists existing CDN endpoints.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group.

func (EndpointsClient) ListByProfileComplete ¶ 

func (client EndpointsClient) ListByProfileComplete(ctx context.Context, resourceGroupName string, profileName string) (result EndpointListResultIterator, err error)

ListByProfileComplete enumerates all values, automatically crossing page boundaries as required.

func (EndpointsClient) ListByProfilePreparer ¶ 

func (client EndpointsClient) ListByProfilePreparer(ctx context.Context, resourceGroupName string, profileName string) (*http.Request, error)

ListByProfilePreparer prepares the ListByProfile request.

func (EndpointsClient) ListByProfileResponder ¶ 

func (client EndpointsClient) ListByProfileResponder(resp *http.Response) (result EndpointListResult, err error)

ListByProfileResponder handles the response to the ListByProfile request. The method always closes the http.Response Body.

func (EndpointsClient) ListByProfileSender ¶ 

func (client EndpointsClient) ListByProfileSender(req *http.Request) (*http.Response, error)

ListByProfileSender sends the ListByProfile request. The method will close the http.Response Body if it receives an error.

func (EndpointsClient) ListResourceUsage ¶ 

func (client EndpointsClient) ListResourceUsage(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (result ResourceUsageListResultPage, err error)

ListResourceUsage checks the quota and usage of geo filters and custom domains under the given endpoint.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally.

func (EndpointsClient) ListResourceUsageComplete ¶ 

func (client EndpointsClient) ListResourceUsageComplete(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (result ResourceUsageListResultIterator, err error)

ListResourceUsageComplete enumerates all values, automatically crossing page boundaries as required.

func (EndpointsClient) ListResourceUsagePreparer ¶ 

func (client EndpointsClient) ListResourceUsagePreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (*http.Request, error)

ListResourceUsagePreparer prepares the ListResourceUsage request.

func (EndpointsClient) ListResourceUsageResponder ¶ 

func (client EndpointsClient) ListResourceUsageResponder(resp *http.Response) (result ResourceUsageListResult, err error)

ListResourceUsageResponder handles the response to the ListResourceUsage request. The method always closes the http.Response Body.

func (EndpointsClient) ListResourceUsageSender ¶ 

func (client EndpointsClient) ListResourceUsageSender(req *http.Request) (*http.Response, error)

ListResourceUsageSender sends the ListResourceUsage request. The method will close the http.Response Body if it receives an error.

func (EndpointsClient) LoadContent ¶ 

func (client EndpointsClient) LoadContent(ctx context.Context, resourceGroupName string, profileName string, endpointName string, contentFilePaths LoadParameters) (result EndpointsLoadContentFuture, err error)

LoadContent pre-loads a content to CDN. Available for Verizon Profiles.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally. contentFilePaths is the path to the content to be loaded. Path should be a full URL, e.g. ‘/pictires/city.png' which loads a single file

func (EndpointsClient) LoadContentPreparer ¶ 

func (client EndpointsClient) LoadContentPreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string, contentFilePaths LoadParameters) (*http.Request, error)

LoadContentPreparer prepares the LoadContent request.

func (EndpointsClient) LoadContentResponder ¶ 

func (client EndpointsClient) LoadContentResponder(resp *http.Response) (result autorest.Response, err error)

LoadContentResponder handles the response to the LoadContent request. The method always closes the http.Response Body.

func (EndpointsClient) LoadContentSender ¶ 

func (client EndpointsClient) LoadContentSender(req *http.Request) (future EndpointsLoadContentFuture, err error)

LoadContentSender sends the LoadContent request. The method will close the http.Response Body if it receives an error.

func (EndpointsClient) PurgeContent ¶ 

func (client EndpointsClient) PurgeContent(ctx context.Context, resourceGroupName string, profileName string, endpointName string, contentFilePaths PurgeParameters) (result EndpointsPurgeContentFuture, err error)

PurgeContent removes a content from CDN.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally. contentFilePaths is the path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.

func (EndpointsClient) PurgeContentPreparer ¶ 

func (client EndpointsClient) PurgeContentPreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string, contentFilePaths PurgeParameters) (*http.Request, error)

PurgeContentPreparer prepares the PurgeContent request.

func (EndpointsClient) PurgeContentResponder ¶ 

func (client EndpointsClient) PurgeContentResponder(resp *http.Response) (result autorest.Response, err error)

PurgeContentResponder handles the response to the PurgeContent request. The method always closes the http.Response Body.

func (EndpointsClient) PurgeContentSender ¶ 

func (client EndpointsClient) PurgeContentSender(req *http.Request) (future EndpointsPurgeContentFuture, err error)

PurgeContentSender sends the PurgeContent request. The method will close the http.Response Body if it receives an error.

func (EndpointsClient) Start ¶ 

func (client EndpointsClient) Start(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (result EndpointsStartFuture, err error)

Start starts an existing CDN endpoint that is on a stopped state.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally.

func (EndpointsClient) StartPreparer ¶ 

func (client EndpointsClient) StartPreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (*http.Request, error)

StartPreparer prepares the Start request.

func (EndpointsClient) StartResponder ¶ 

func (client EndpointsClient) StartResponder(resp *http.Response) (result Endpoint, err error)

StartResponder handles the response to the Start request. The method always closes the http.Response Body.

func (EndpointsClient) StartSender ¶ 

func (client EndpointsClient) StartSender(req *http.Request) (future EndpointsStartFuture, err error)

StartSender sends the Start request. The method will close the http.Response Body if it receives an error.

func (EndpointsClient) Stop ¶ 

func (client EndpointsClient) Stop(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (result EndpointsStopFuture, err error)

Stop stops an existing running CDN endpoint.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally.

func (EndpointsClient) StopPreparer ¶ 

func (client EndpointsClient) StopPreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (*http.Request, error)

StopPreparer prepares the Stop request.

func (EndpointsClient) StopResponder ¶ 

func (client EndpointsClient) StopResponder(resp *http.Response) (result Endpoint, err error)

StopResponder handles the response to the Stop request. The method always closes the http.Response Body.

func (EndpointsClient) StopSender ¶ 

func (client EndpointsClient) StopSender(req *http.Request) (future EndpointsStopFuture, err error)

StopSender sends the Stop request. The method will close the http.Response Body if it receives an error.

func (EndpointsClient) Update ¶ 

func (client EndpointsClient) Update(ctx context.Context, resourceGroupName string, profileName string, endpointName string, endpointUpdateProperties EndpointUpdateParameters) (result EndpointsUpdateFuture, err error)

Update updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags and Origin HostHeader can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update custom domains, use the Update Custom Domain operation.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally. endpointUpdateProperties is endpoint update properties

func (EndpointsClient) UpdatePreparer ¶ 

func (client EndpointsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string, endpointUpdateProperties EndpointUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (EndpointsClient) UpdateResponder ¶ 

func (client EndpointsClient) UpdateResponder(resp *http.Response) (result Endpoint, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (EndpointsClient) UpdateSender ¶ 

func (client EndpointsClient) UpdateSender(req *http.Request) (future EndpointsUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

func (EndpointsClient) ValidateCustomDomain ¶ 

func (client EndpointsClient) ValidateCustomDomain(ctx context.Context, resourceGroupName string, profileName string, endpointName string, customDomainProperties ValidateCustomDomainInput) (result ValidateCustomDomainOutput, err error)

ValidateCustomDomain validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally. customDomainProperties is custom domain to be validated.

func (EndpointsClient) ValidateCustomDomainPreparer ¶ 

func (client EndpointsClient) ValidateCustomDomainPreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string, customDomainProperties ValidateCustomDomainInput) (*http.Request, error)

ValidateCustomDomainPreparer prepares the ValidateCustomDomain request.

func (EndpointsClient) ValidateCustomDomainResponder ¶ 

func (client EndpointsClient) ValidateCustomDomainResponder(resp *http.Response) (result ValidateCustomDomainOutput, err error)

ValidateCustomDomainResponder handles the response to the ValidateCustomDomain request. The method always closes the http.Response Body.

func (EndpointsClient) ValidateCustomDomainSender ¶ 

func (client EndpointsClient) ValidateCustomDomainSender(req *http.Request) (*http.Response, error)

ValidateCustomDomainSender sends the ValidateCustomDomain request. The method will close the http.Response Body if it receives an error.

type EndpointsCreateFuture ¶ 

type EndpointsCreateFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

EndpointsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (EndpointsCreateFuture) Result ¶ 

func (future EndpointsCreateFuture) Result(client EndpointsClient) (e Endpoint, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type EndpointsDeleteFuture ¶ 

type EndpointsDeleteFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

EndpointsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (EndpointsDeleteFuture) Result ¶ 

func (future EndpointsDeleteFuture) Result(client EndpointsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type EndpointsLoadContentFuture ¶ 

type EndpointsLoadContentFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

EndpointsLoadContentFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (EndpointsLoadContentFuture) Result ¶ 

func (future EndpointsLoadContentFuture) Result(client EndpointsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type EndpointsPurgeContentFuture ¶ 

type EndpointsPurgeContentFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

EndpointsPurgeContentFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (EndpointsPurgeContentFuture) Result ¶ 

func (future EndpointsPurgeContentFuture) Result(client EndpointsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type EndpointsStartFuture ¶ 

type EndpointsStartFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

EndpointsStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (EndpointsStartFuture) Result ¶ 

func (future EndpointsStartFuture) Result(client EndpointsClient) (e Endpoint, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type EndpointsStopFuture ¶ 

type EndpointsStopFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

EndpointsStopFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (EndpointsStopFuture) Result ¶ 

func (future EndpointsStopFuture) Result(client EndpointsClient) (e Endpoint, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type EndpointsUpdateFuture ¶ 

type EndpointsUpdateFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

EndpointsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (EndpointsUpdateFuture) Result ¶ 

func (future EndpointsUpdateFuture) Result(client EndpointsClient) (e Endpoint, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ErrorResponse ¶ 

type ErrorResponse struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// Message - Error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
}

ErrorResponse error reponse indicates CDN service is not able to process the incoming request. The reason is provided in the error message.

type GeoFilter ¶ 

type GeoFilter struct {
	// RelativePath - Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.)
	RelativePath *string `json:"relativePath,omitempty"`
	// Action - Action of the geo filter, i.e. allow or block access. Possible values include: 'Block', 'Allow'
	Action GeoFilterActions `json:"action,omitempty"`
	// CountryCodes - Two letter country codes defining user country access in a geo filter, e.g. AU, MX, US.
	CountryCodes *[]string `json:"countryCodes,omitempty"`
}

GeoFilter rules defining user geo access within a CDN endpoint.

type GeoFilterActions ¶ 

type GeoFilterActions string

GeoFilterActions enumerates the values for geo filter actions. 

const (
	// Allow ...
	Allow GeoFilterActions = "Allow"
	// Block ...
	Block GeoFilterActions = "Block"
)

type IPAddressGroup ¶ 

type IPAddressGroup struct {
	// DeliveryRegion - The delivery region of the ip address group
	DeliveryRegion *string `json:"deliveryRegion,omitempty"`
	// Ipv4Addresses - The list of ip v4 addresses.
	Ipv4Addresses *[]CidrIPAddress `json:"ipv4Addresses,omitempty"`
	// Ipv6Addresses - The list of ip v6 addresses.
	Ipv6Addresses *[]CidrIPAddress `json:"ipv6Addresses,omitempty"`
}

IPAddressGroup CDN Ip address group

type LoadParameters ¶ 

type LoadParameters struct {
	// ContentPaths - The path to the content to be loaded. Path should be a relative file URL of the origin.
	ContentPaths *[]string `json:"contentPaths,omitempty"`
}

LoadParameters parameters required for content load.

type Operation ¶ 

type Operation struct {
	// Name - Operation name: {provider}/{resource}/{operation}
	Name *string `json:"name,omitempty"`
	// Display - The object that represents the operation.
	Display *OperationDisplay `json:"display,omitempty"`
}

Operation CDN REST API operation

type OperationDisplay ¶ 

type OperationDisplay struct {
	// Provider - Service provider: Microsoft.Cdn
	Provider *string `json:"provider,omitempty"`
	// Resource - Resource on which the operation is performed: Profile, endpoint, etc.
	Resource *string `json:"resource,omitempty"`
	// Operation - Operation type: Read, write, delete, etc.
	Operation *string `json:"operation,omitempty"`
}

OperationDisplay the object that represents the operation.

type OperationListResult ¶ 

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of CDN operations supported by the CDN resource provider.
	Value *[]Operation `json:"value,omitempty"`
	// NextLink - URL to get the next set of operation list results if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

OperationListResult result of the request to list CDN operations. It contains a list of operations and a URL link to get the next set of results.

func (OperationListResult) IsEmpty ¶ 

func (olr OperationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OperationListResultIterator ¶ 

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

OperationListResultIterator provides access to a complete listing of Operation values.

func (*OperationListResultIterator) Next ¶ 

func (iter *OperationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OperationListResultIterator) NotDone ¶ 

func (iter OperationListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OperationListResultIterator) Response ¶ 

func (iter OperationListResultIterator) Response() OperationListResult

Response returns the raw server response from the last page request.

func (OperationListResultIterator) Value ¶ 

func (iter OperationListResultIterator) Value() Operation

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OperationListResultPage ¶ 

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

OperationListResultPage contains a page of Operation values.

func (*OperationListResultPage) Next ¶ 

func (page *OperationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OperationListResultPage) NotDone ¶ 

func (page OperationListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OperationListResultPage) Response ¶ 

func (page OperationListResultPage) Response() OperationListResult

Response returns the raw server response from the last page request.

func (OperationListResultPage) Values ¶ 

func (page OperationListResultPage) Values() []Operation

Values returns the slice of values for the current page or nil if there are no values.

type OptimizationType ¶ 

type OptimizationType string

OptimizationType enumerates the values for optimization type. 

const (
	// DynamicSiteAcceleration ...
	DynamicSiteAcceleration OptimizationType = "DynamicSiteAcceleration"
	// GeneralMediaStreaming ...
	GeneralMediaStreaming OptimizationType = "GeneralMediaStreaming"
	// GeneralWebDelivery ...
	GeneralWebDelivery OptimizationType = "GeneralWebDelivery"
	// LargeFileDownload ...
	LargeFileDownload OptimizationType = "LargeFileDownload"
	// VideoOnDemandMediaStreaming ...
	VideoOnDemandMediaStreaming OptimizationType = "VideoOnDemandMediaStreaming"
)

type Origin ¶ 

type Origin struct {
	autorest.Response `json:"-"`
	*OriginProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

Origin CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.

func (Origin) MarshalJSON ¶ 

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

MarshalJSON is the custom marshaler for Origin.

func (*Origin) UnmarshalJSON ¶ 

func (o *Origin) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Origin struct.

type OriginListResult ¶ 

type OriginListResult struct {
	autorest.Response `json:"-"`
	// Value - List of CDN origins within an endpoint
	Value *[]Origin `json:"value,omitempty"`
	// NextLink - URL to get the next set of origin objects if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

OriginListResult result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.

func (OriginListResult) IsEmpty ¶ 

func (olr OriginListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OriginListResultIterator ¶ 

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

OriginListResultIterator provides access to a complete listing of Origin values.

func (*OriginListResultIterator) Next ¶ 

func (iter *OriginListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OriginListResultIterator) NotDone ¶ 

func (iter OriginListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (OriginListResultIterator) Response ¶ 

func (iter OriginListResultIterator) Response() OriginListResult

Response returns the raw server response from the last page request.

func (OriginListResultIterator) Value ¶ 

func (iter OriginListResultIterator) Value() Origin

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OriginListResultPage ¶ 

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

OriginListResultPage contains a page of Origin values.

func (*OriginListResultPage) Next ¶ 

func (page *OriginListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OriginListResultPage) NotDone ¶ 

func (page OriginListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OriginListResultPage) Response ¶ 

func (page OriginListResultPage) Response() OriginListResult

Response returns the raw server response from the last page request.

func (OriginListResultPage) Values ¶ 

func (page OriginListResultPage) Values() []Origin

Values returns the slice of values for the current page or nil if there are no values.

type OriginProperties ¶ 

type OriginProperties struct {
	// HostName - The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.
	HostName *string `json:"hostName,omitempty"`
	// HTTPPort - The value of the HTTP port. Must be between 1 and 65535.
	HTTPPort *int32 `json:"httpPort,omitempty"`
	// HTTPSPort - The value of the https port. Must be between 1 and 65535.
	HTTPSPort *int32 `json:"httpsPort,omitempty"`
	// ResourceState - Resource status of the origin. Possible values include: 'OriginResourceStateCreating', 'OriginResourceStateActive', 'OriginResourceStateDeleting'
	ResourceState OriginResourceState `json:"resourceState,omitempty"`
	// ProvisioningState - Provisioning status of the origin.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

OriginProperties the JSON object that contains the properties of the origin to create.

type OriginPropertiesParameters ¶ 

type OriginPropertiesParameters struct {
	// HostName - The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.
	HostName *string `json:"hostName,omitempty"`
	// HTTPPort - The value of the HTTP port. Must be between 1 and 65535.
	HTTPPort *int32 `json:"httpPort,omitempty"`
	// HTTPSPort - The value of the HTTPS port. Must be between 1 and 65535.
	HTTPSPort *int32 `json:"httpsPort,omitempty"`
}

OriginPropertiesParameters the JSON object that contains the properties of the origin to create.

type OriginResourceState ¶ 

type OriginResourceState string

OriginResourceState enumerates the values for origin resource state. 

const (
	// OriginResourceStateActive ...
	OriginResourceStateActive OriginResourceState = "Active"
	// OriginResourceStateCreating ...
	OriginResourceStateCreating OriginResourceState = "Creating"
	// OriginResourceStateDeleting ...
	OriginResourceStateDeleting OriginResourceState = "Deleting"
)

type OriginUpdateParameters ¶ 

type OriginUpdateParameters struct {
	*OriginPropertiesParameters `json:"properties,omitempty"`
}

OriginUpdateParameters origin properties needed for origin creation or update.

func (*OriginUpdateParameters) UnmarshalJSON ¶ 

func (oup *OriginUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OriginUpdateParameters struct.

type OriginsClient ¶ 

type OriginsClient struct {
	BaseClient
}

OriginsClient is the use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure.

func NewOriginsClient ¶ 

func NewOriginsClient(subscriptionID string) OriginsClient

NewOriginsClient creates an instance of the OriginsClient client.

func NewOriginsClientWithBaseURI ¶ 

func NewOriginsClientWithBaseURI(baseURI string, subscriptionID string) OriginsClient

NewOriginsClientWithBaseURI creates an instance of the OriginsClient client.

func (OriginsClient) Get ¶ 

func (client OriginsClient) Get(ctx context.Context, resourceGroupName string, profileName string, endpointName string, originName string) (result Origin, err error)

Get gets an existing origin within an endpoint.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally. originName is name of the origin which is unique within the endpoint.

func (OriginsClient) GetPreparer ¶ 

func (client OriginsClient) GetPreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string, originName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (OriginsClient) GetResponder ¶ 

func (client OriginsClient) GetResponder(resp *http.Response) (result Origin, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (OriginsClient) GetSender ¶ 

func (client OriginsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (OriginsClient) ListByEndpoint ¶ 

func (client OriginsClient) ListByEndpoint(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (result OriginListResultPage, err error)

ListByEndpoint lists all of the existing origins within an endpoint.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally.

func (OriginsClient) ListByEndpointComplete ¶ 

func (client OriginsClient) ListByEndpointComplete(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (result OriginListResultIterator, err error)

ListByEndpointComplete enumerates all values, automatically crossing page boundaries as required.

func (OriginsClient) ListByEndpointPreparer ¶ 

func (client OriginsClient) ListByEndpointPreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string) (*http.Request, error)

ListByEndpointPreparer prepares the ListByEndpoint request.

func (OriginsClient) ListByEndpointResponder ¶ 

func (client OriginsClient) ListByEndpointResponder(resp *http.Response) (result OriginListResult, err error)

ListByEndpointResponder handles the response to the ListByEndpoint request. The method always closes the http.Response Body.

func (OriginsClient) ListByEndpointSender ¶ 

func (client OriginsClient) ListByEndpointSender(req *http.Request) (*http.Response, error)

ListByEndpointSender sends the ListByEndpoint request. The method will close the http.Response Body if it receives an error.

func (OriginsClient) Update ¶ 

func (client OriginsClient) Update(ctx context.Context, resourceGroupName string, profileName string, endpointName string, originName string, originUpdateProperties OriginUpdateParameters) (result OriginsUpdateFuture, err error)

Update updates an existing origin within an endpoint.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. endpointName is name of the endpoint under the profile which is unique globally. originName is name of the origin which is unique within the endpoint. originUpdateProperties is origin properties

func (OriginsClient) UpdatePreparer ¶ 

func (client OriginsClient) UpdatePreparer(ctx context.Context, resourceGroupName string, profileName string, endpointName string, originName string, originUpdateProperties OriginUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (OriginsClient) UpdateResponder ¶ 

func (client OriginsClient) UpdateResponder(resp *http.Response) (result Origin, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (OriginsClient) UpdateSender ¶ 

func (client OriginsClient) UpdateSender(req *http.Request) (future OriginsUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type OriginsUpdateFuture ¶ 

type OriginsUpdateFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

OriginsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (OriginsUpdateFuture) Result ¶ 

func (future OriginsUpdateFuture) Result(client OriginsClient) (o Origin, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type Profile ¶ 

type Profile struct {
	autorest.Response `json:"-"`
	// Sku - The pricing tier (defines a CDN provider, feature list and rate) of the CDN profile.
	Sku                *Sku `json:"sku,omitempty"`
	*ProfileProperties `json:"properties,omitempty"`
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

Profile CDN profile represents the top level resource and the entry point into the CDN API. This allows users to set up a logical grouping of endpoints in addition to creating shared configuration settings and selecting pricing tiers and providers.

func (Profile) MarshalJSON ¶ 

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

MarshalJSON is the custom marshaler for Profile.

func (*Profile) UnmarshalJSON ¶ 

func (p *Profile) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Profile struct.

type ProfileListResult ¶ 

type ProfileListResult struct {
	autorest.Response `json:"-"`
	// Value - List of CDN profiles within a resource group.
	Value *[]Profile `json:"value,omitempty"`
	// NextLink - URL to get the next set of profile objects if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

ProfileListResult result of the request to list profiles. It contains a list of profile objects and a URL link to get the the next set of results.

func (ProfileListResult) IsEmpty ¶ 

func (plr ProfileListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ProfileListResultIterator ¶ 

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

ProfileListResultIterator provides access to a complete listing of Profile values.

func (*ProfileListResultIterator) Next ¶ 

func (iter *ProfileListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ProfileListResultIterator) NotDone ¶ 

func (iter ProfileListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ProfileListResultIterator) Response ¶ 

func (iter ProfileListResultIterator) Response() ProfileListResult

Response returns the raw server response from the last page request.

func (ProfileListResultIterator) Value ¶ 

func (iter ProfileListResultIterator) Value() Profile

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ProfileListResultPage ¶ 

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

ProfileListResultPage contains a page of Profile values.

func (*ProfileListResultPage) Next ¶ 

func (page *ProfileListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ProfileListResultPage) NotDone ¶ 

func (page ProfileListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ProfileListResultPage) Response ¶ 

func (page ProfileListResultPage) Response() ProfileListResult

Response returns the raw server response from the last page request.

func (ProfileListResultPage) Values ¶ 

func (page ProfileListResultPage) Values() []Profile

Values returns the slice of values for the current page or nil if there are no values.

type ProfileProperties ¶ 

type ProfileProperties struct {
	// ResourceState - Resource status of the profile. Possible values include: 'ProfileResourceStateCreating', 'ProfileResourceStateActive', 'ProfileResourceStateDeleting', 'ProfileResourceStateDisabled'
	ResourceState ProfileResourceState `json:"resourceState,omitempty"`
	// ProvisioningState - Provisioning status of the profile.
	ProvisioningState *string `json:"provisioningState,omitempty"`
}

ProfileProperties the JSON object that contains the properties required to create a profile.

type ProfileResourceState ¶ 

type ProfileResourceState string

ProfileResourceState enumerates the values for profile resource state. 

const (
	// ProfileResourceStateActive ...
	ProfileResourceStateActive ProfileResourceState = "Active"
	// ProfileResourceStateCreating ...
	ProfileResourceStateCreating ProfileResourceState = "Creating"
	// ProfileResourceStateDeleting ...
	ProfileResourceStateDeleting ProfileResourceState = "Deleting"
	// ProfileResourceStateDisabled ...
	ProfileResourceStateDisabled ProfileResourceState = "Disabled"
)

type ProfileUpdateParameters ¶ 

type ProfileUpdateParameters struct {
	// Tags - Profile tags
	Tags map[string]*string `json:"tags"`
}

ProfileUpdateParameters properties required to update a profile.

func (ProfileUpdateParameters) MarshalJSON ¶ 

func (pup ProfileUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProfileUpdateParameters.

type ProfilesClient ¶ 

type ProfilesClient struct {
	BaseClient
}

ProfilesClient is the use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure.

func NewProfilesClient ¶ 

func NewProfilesClient(subscriptionID string) ProfilesClient

NewProfilesClient creates an instance of the ProfilesClient client.

func NewProfilesClientWithBaseURI ¶ 

func NewProfilesClientWithBaseURI(baseURI string, subscriptionID string) ProfilesClient

NewProfilesClientWithBaseURI creates an instance of the ProfilesClient client.

func (ProfilesClient) Create ¶ 

func (client ProfilesClient) Create(ctx context.Context, resourceGroupName string, profileName string, profile Profile) (result ProfilesCreateFuture, err error)

Create creates a new CDN profile with a profile name under the specified subscription and resource group.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. profile is profile properties needed to create a new profile.

func (ProfilesClient) CreatePreparer ¶ 

func (client ProfilesClient) CreatePreparer(ctx context.Context, resourceGroupName string, profileName string, profile Profile) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ProfilesClient) CreateResponder ¶ 

func (client ProfilesClient) CreateResponder(resp *http.Response) (result Profile, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (ProfilesClient) CreateSender ¶ 

func (client ProfilesClient) CreateSender(req *http.Request) (future ProfilesCreateFuture, err error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (ProfilesClient) Delete ¶ 

func (client ProfilesClient) Delete(ctx context.Context, resourceGroupName string, profileName string) (result ProfilesDeleteFuture, err error)

Delete deletes an existing CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group.

func (ProfilesClient) DeletePreparer ¶ 

func (client ProfilesClient) DeletePreparer(ctx context.Context, resourceGroupName string, profileName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ProfilesClient) DeleteResponder ¶ 

func (client ProfilesClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ProfilesClient) DeleteSender ¶ 

func (client ProfilesClient) DeleteSender(req *http.Request) (future ProfilesDeleteFuture, err error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ProfilesClient) GenerateSsoURI ¶ 

func (client ProfilesClient) GenerateSsoURI(ctx context.Context, resourceGroupName string, profileName string) (result SsoURI, err error)

GenerateSsoURI generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemnetal portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group.

func (ProfilesClient) GenerateSsoURIPreparer ¶ 

func (client ProfilesClient) GenerateSsoURIPreparer(ctx context.Context, resourceGroupName string, profileName string) (*http.Request, error)

GenerateSsoURIPreparer prepares the GenerateSsoURI request.

func (ProfilesClient) GenerateSsoURIResponder ¶ 

func (client ProfilesClient) GenerateSsoURIResponder(resp *http.Response) (result SsoURI, err error)

GenerateSsoURIResponder handles the response to the GenerateSsoURI request. The method always closes the http.Response Body.

func (ProfilesClient) GenerateSsoURISender ¶ 

func (client ProfilesClient) GenerateSsoURISender(req *http.Request) (*http.Response, error)

GenerateSsoURISender sends the GenerateSsoURI request. The method will close the http.Response Body if it receives an error.

func (ProfilesClient) Get ¶ 

func (client ProfilesClient) Get(ctx context.Context, resourceGroupName string, profileName string) (result Profile, err error)

Get gets a CDN profile with the specified profile name under the specified subscription and resource group.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group.

func (ProfilesClient) GetPreparer ¶ 

func (client ProfilesClient) GetPreparer(ctx context.Context, resourceGroupName string, profileName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ProfilesClient) GetResponder ¶ 

func (client ProfilesClient) GetResponder(resp *http.Response) (result Profile, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ProfilesClient) GetSender ¶ 

func (client ProfilesClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ProfilesClient) GetSupportedOptimizationTypes ¶ 

func (client ProfilesClient) GetSupportedOptimizationTypes(ctx context.Context, resourceGroupName string, profileName string) (result SupportedOptimizationTypesResult, err error)

GetSupportedOptimizationTypes gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group.

func (ProfilesClient) GetSupportedOptimizationTypesPreparer ¶ 

func (client ProfilesClient) GetSupportedOptimizationTypesPreparer(ctx context.Context, resourceGroupName string, profileName string) (*http.Request, error)

GetSupportedOptimizationTypesPreparer prepares the GetSupportedOptimizationTypes request.

func (ProfilesClient) GetSupportedOptimizationTypesResponder ¶ 

func (client ProfilesClient) GetSupportedOptimizationTypesResponder(resp *http.Response) (result SupportedOptimizationTypesResult, err error)

GetSupportedOptimizationTypesResponder handles the response to the GetSupportedOptimizationTypes request. The method always closes the http.Response Body.

func (ProfilesClient) GetSupportedOptimizationTypesSender ¶ 

func (client ProfilesClient) GetSupportedOptimizationTypesSender(req *http.Request) (*http.Response, error)

GetSupportedOptimizationTypesSender sends the GetSupportedOptimizationTypes request. The method will close the http.Response Body if it receives an error.

func (ProfilesClient) List ¶ 

func (client ProfilesClient) List(ctx context.Context) (result ProfileListResultPage, err error)

List lists all of the CDN profiles within an Azure subscription.

func (ProfilesClient) ListByResourceGroup ¶ 

func (client ProfilesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string) (result ProfileListResultPage, err error)

ListByResourceGroup lists all of the CDN profiles within a resource group.

resourceGroupName is name of the Resource group within the Azure subscription.

func (ProfilesClient) ListByResourceGroupComplete ¶ 

func (client ProfilesClient) ListByResourceGroupComplete(ctx context.Context, resourceGroupName string) (result ProfileListResultIterator, err error)

ListByResourceGroupComplete enumerates all values, automatically crossing page boundaries as required.

func (ProfilesClient) ListByResourceGroupPreparer ¶ 

func (client ProfilesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (ProfilesClient) ListByResourceGroupResponder ¶ 

func (client ProfilesClient) ListByResourceGroupResponder(resp *http.Response) (result ProfileListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (ProfilesClient) ListByResourceGroupSender ¶ 

func (client ProfilesClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (ProfilesClient) ListComplete ¶ 

func (client ProfilesClient) ListComplete(ctx context.Context) (result ProfileListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (ProfilesClient) ListPreparer ¶ 

func (client ProfilesClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (ProfilesClient) ListResourceUsage ¶ 

func (client ProfilesClient) ListResourceUsage(ctx context.Context, resourceGroupName string, profileName string) (result ResourceUsageListResultPage, err error)

ListResourceUsage checks the quota and actual usage of endpoints under the given CDN profile.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group.

func (ProfilesClient) ListResourceUsageComplete ¶ 

func (client ProfilesClient) ListResourceUsageComplete(ctx context.Context, resourceGroupName string, profileName string) (result ResourceUsageListResultIterator, err error)

ListResourceUsageComplete enumerates all values, automatically crossing page boundaries as required.

func (ProfilesClient) ListResourceUsagePreparer ¶ 

func (client ProfilesClient) ListResourceUsagePreparer(ctx context.Context, resourceGroupName string, profileName string) (*http.Request, error)

ListResourceUsagePreparer prepares the ListResourceUsage request.

func (ProfilesClient) ListResourceUsageResponder ¶ 

func (client ProfilesClient) ListResourceUsageResponder(resp *http.Response) (result ResourceUsageListResult, err error)

ListResourceUsageResponder handles the response to the ListResourceUsage request. The method always closes the http.Response Body.

func (ProfilesClient) ListResourceUsageSender ¶ 

func (client ProfilesClient) ListResourceUsageSender(req *http.Request) (*http.Response, error)

ListResourceUsageSender sends the ListResourceUsage request. The method will close the http.Response Body if it receives an error.

func (ProfilesClient) ListResponder ¶ 

func (client ProfilesClient) ListResponder(resp *http.Response) (result ProfileListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ProfilesClient) ListSender ¶ 

func (client ProfilesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (ProfilesClient) Update ¶ 

func (client ProfilesClient) Update(ctx context.Context, resourceGroupName string, profileName string, profileUpdateParameters ProfileUpdateParameters) (result ProfilesUpdateFuture, err error)

Update updates an existing CDN profile with the specified profile name under the specified subscription and resource group.

resourceGroupName is name of the Resource group within the Azure subscription. profileName is name of the CDN profile which is unique within the resource group. profileUpdateParameters is profile properties needed to update an existing profile.

func (ProfilesClient) UpdatePreparer ¶ 

func (client ProfilesClient) UpdatePreparer(ctx context.Context, resourceGroupName string, profileName string, profileUpdateParameters ProfileUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ProfilesClient) UpdateResponder ¶ 

func (client ProfilesClient) UpdateResponder(resp *http.Response) (result Profile, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (ProfilesClient) UpdateSender ¶ 

func (client ProfilesClient) UpdateSender(req *http.Request) (future ProfilesUpdateFuture, err error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type ProfilesCreateFuture ¶ 

type ProfilesCreateFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

ProfilesCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (ProfilesCreateFuture) Result ¶ 

func (future ProfilesCreateFuture) Result(client ProfilesClient) (p Profile, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ProfilesDeleteFuture ¶ 

type ProfilesDeleteFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

ProfilesDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (ProfilesDeleteFuture) Result ¶ 

func (future ProfilesDeleteFuture) Result(client ProfilesClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type ProfilesUpdateFuture ¶ 

type ProfilesUpdateFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

ProfilesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (ProfilesUpdateFuture) Result ¶ 

func (future ProfilesUpdateFuture) Result(client ProfilesClient) (p Profile, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type PurgeParameters ¶ 

type PurgeParameters struct {
	// ContentPaths - The path to the content to be purged. Can describe a file path or a wild card directory.
	ContentPaths *[]string `json:"contentPaths,omitempty"`
}

PurgeParameters parameters required for content purge.

type QueryStringCachingBehavior ¶ 

type QueryStringCachingBehavior string

QueryStringCachingBehavior enumerates the values for query string caching behavior. 

const (
	// BypassCaching ...
	BypassCaching QueryStringCachingBehavior = "BypassCaching"
	// IgnoreQueryString ...
	IgnoreQueryString QueryStringCachingBehavior = "IgnoreQueryString"
	// NotSet ...
	NotSet QueryStringCachingBehavior = "NotSet"
	// UseQueryString ...
	UseQueryString QueryStringCachingBehavior = "UseQueryString"
)

type Resource ¶ 

type Resource struct {
	// ID - Resource ID.
	ID *string `json:"id,omitempty"`
	// Name - Resource name.
	Name *string `json:"name,omitempty"`
	// Type - Resource type.
	Type *string `json:"type,omitempty"`
	// Location - Resource location.
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags.
	Tags map[string]*string `json:"tags"`
}

Resource the Resource definition.

func (Resource) MarshalJSON ¶ 

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

MarshalJSON is the custom marshaler for Resource.

type ResourceType ¶ 

type ResourceType string

ResourceType enumerates the values for resource type. 

const (
	// MicrosoftCdnProfilesEndpoints ...
	MicrosoftCdnProfilesEndpoints ResourceType = "Microsoft.Cdn/Profiles/Endpoints"
)

type ResourceUsage ¶ 

type ResourceUsage struct {
	// ResourceType - Resource type of the usages.
	ResourceType *string `json:"resourceType,omitempty"`
	// Unit - Unit of the usage. e.g. Count.
	Unit *string `json:"unit,omitempty"`
	// CurrentValue - Actual value of the resource type.
	CurrentValue *int32 `json:"currentValue,omitempty"`
	// Limit - Quota of the resource type.
	Limit *int32 `json:"limit,omitempty"`
}

ResourceUsage output of check resource usage API.

type ResourceUsageListResult ¶ 

type ResourceUsageListResult struct {
	autorest.Response `json:"-"`
	// Value - List of resource usages.
	Value *[]ResourceUsage `json:"value,omitempty"`
	// NextLink - URL to get the next set of custom domain objects if there are any.
	NextLink *string `json:"nextLink,omitempty"`
}

ResourceUsageListResult output of check resource usage API.

func (ResourceUsageListResult) IsEmpty ¶ 

func (rulr ResourceUsageListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ResourceUsageListResultIterator ¶ 

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

ResourceUsageListResultIterator provides access to a complete listing of ResourceUsage values.

func (*ResourceUsageListResultIterator) Next ¶ 

func (iter *ResourceUsageListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ResourceUsageListResultIterator) NotDone ¶ 

func (iter ResourceUsageListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ResourceUsageListResultIterator) Response ¶ 

func (iter ResourceUsageListResultIterator) Response() ResourceUsageListResult

Response returns the raw server response from the last page request.

func (ResourceUsageListResultIterator) Value ¶ 

func (iter ResourceUsageListResultIterator) Value() ResourceUsage

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ResourceUsageListResultPage ¶ 

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

ResourceUsageListResultPage contains a page of ResourceUsage values.

func (*ResourceUsageListResultPage) Next ¶ 

func (page *ResourceUsageListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ResourceUsageListResultPage) NotDone ¶ 

func (page ResourceUsageListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ResourceUsageListResultPage) Response ¶ 

func (page ResourceUsageListResultPage) Response() ResourceUsageListResult

Response returns the raw server response from the last page request.

func (ResourceUsageListResultPage) Values ¶ 

func (page ResourceUsageListResultPage) Values() []ResourceUsage

Values returns the slice of values for the current page or nil if there are no values.

type Sku ¶ 

type Sku struct {
	// Name - Name of the pricing tier. Possible values include: 'StandardVerizon', 'PremiumVerizon', 'CustomVerizon', 'StandardAkamai', 'StandardChinaCdn'
	Name SkuName `json:"name,omitempty"`
}

Sku the pricing tier (defines a CDN provider, feature list and rate) of the CDN profile.

type SkuName ¶ 

type SkuName string

SkuName enumerates the values for sku name. 

const (
	// CustomVerizon ...
	CustomVerizon SkuName = "Custom_Verizon"
	// PremiumVerizon ...
	PremiumVerizon SkuName = "Premium_Verizon"
	// StandardAkamai ...
	StandardAkamai SkuName = "Standard_Akamai"
	// StandardChinaCdn ...
	StandardChinaCdn SkuName = "Standard_ChinaCdn"
	// StandardVerizon ...
	StandardVerizon SkuName = "Standard_Verizon"
)

type SsoURI ¶ 

type SsoURI struct {
	autorest.Response `json:"-"`
	// SsoURIValue - The URI used to login to the supplemental portal.
	SsoURIValue *string `json:"ssoUriValue,omitempty"`
}

SsoURI SSO URI required to login to the supplemental portal.

type SupportedOptimizationTypesResult ¶ 

type SupportedOptimizationTypesResult struct {
	autorest.Response `json:"-"`
	// SupportedOptimizationTypes - Supported optimization types for a profile.
	SupportedOptimizationTypes *[]OptimizationType `json:"supportedOptimizationTypes,omitempty"`
}

SupportedOptimizationTypesResult the result of the GetSupportedOptimizationTypes API

type ValidateCustomDomainInput ¶ 

type ValidateCustomDomainInput struct {
	// HostName - The host name of the custom domain. Must be a domain name.
	HostName *string `json:"hostName,omitempty"`
}

ValidateCustomDomainInput input of the custom domain to be validated for DNS mapping.

type ValidateCustomDomainOutput ¶ 

type ValidateCustomDomainOutput struct {
	autorest.Response `json:"-"`
	// CustomDomainValidated - Indicates whether the custom domain is validated or not.
	CustomDomainValidated *bool `json:"customDomainValidated,omitempty"`
	// Reason - The reason why the custom domain is not valid.
	Reason *string `json:"reason,omitempty"`
	// Message - Error message describing why the custom domain is not valid.
	Message *string `json:"message,omitempty"`
}

ValidateCustomDomainOutput output of custom domain validation.

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.