cdn

package
v49.0.0+incompatible Latest Latest
Warning

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

Go to latest
Published: Dec 1, 2020 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

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

Cdn Management Client

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

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 CustomDomain

type CustomDomain struct {
	autorest.Response       `json:"-"`
	*CustomDomainProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Resource ID
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
}

CustomDomain CDN CustomDomain represents a mapping between a user specified domain name and a CDN endpoint. This is to use custom domain names to represent the URLs for branding purposes.

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"`
}

CustomDomainListResult ...

type CustomDomainParameters

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

CustomDomainParameters customDomain properties required for custom domain creation or update.

func (CustomDomainParameters) MarshalJSON

func (cdp CustomDomainParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CustomDomainParameters.

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 - READ-ONLY; Resource status of the custom domain. Possible values include: 'Creating', 'Active', 'Deleting'
	ResourceState CustomDomainResourceState `json:"resourceState,omitempty"`
	// ProvisioningState - Provisioning status of the custom domain. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}

CustomDomainProperties ...

func (CustomDomainProperties) MarshalJSON

func (cdp CustomDomainProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CustomDomainProperties.

type CustomDomainPropertiesParameters

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

CustomDomainPropertiesParameters ...

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"
)

func PossibleCustomDomainResourceStateValues

func PossibleCustomDomainResourceStateValues() []CustomDomainResourceState

PossibleCustomDomainResourceStateValues returns an array of possible values for the CustomDomainResourceState const type.

type CustomDomainsClient

type CustomDomainsClient struct {
	BaseClient
}

CustomDomainsClient is the cdn Management Client

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (CustomDomainsClient) Create

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

Create sends the create request. Parameters: customDomainName - name of the custom domain within an endpoint. customDomainProperties - custom domain properties required for creation. endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (CustomDomainsClient) CreatePreparer

func (client CustomDomainsClient) CreatePreparer(ctx context.Context, customDomainName string, customDomainProperties CustomDomainParameters, endpointName string, profileName string, resourceGroupName string) (*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) DeleteIfExists

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

DeleteIfExists sends the delete if exists request. Parameters: customDomainName - name of the custom domain within an endpoint. endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (CustomDomainsClient) DeleteIfExistsPreparer

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

DeleteIfExistsPreparer prepares the DeleteIfExists request.

func (CustomDomainsClient) DeleteIfExistsResponder

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

DeleteIfExistsResponder handles the response to the DeleteIfExists request. The method always closes the http.Response Body.

func (CustomDomainsClient) DeleteIfExistsSender

func (client CustomDomainsClient) DeleteIfExistsSender(req *http.Request) (future CustomDomainsDeleteIfExistsFuture, err error)

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

func (CustomDomainsClient) Get

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

Get sends the get request. Parameters: customDomainName - name of the custom domain within an endpoint. endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (CustomDomainsClient) GetPreparer

func (client CustomDomainsClient) GetPreparer(ctx context.Context, customDomainName string, endpointName string, profileName string, resourceGroupName 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, endpointName string, profileName string, resourceGroupName string) (result CustomDomainListResult, err error)

ListByEndpoint sends the list by endpoint request. Parameters: endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (CustomDomainsClient) ListByEndpointPreparer

func (client CustomDomainsClient) ListByEndpointPreparer(ctx context.Context, endpointName string, profileName string, resourceGroupName 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.

func (CustomDomainsClient) Update

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

Update sends the update request. Parameters: customDomainName - name of the custom domain within an endpoint. customDomainProperties - custom domain properties to update. endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (CustomDomainsClient) UpdatePreparer

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

UpdatePreparer prepares the Update request.

func (CustomDomainsClient) UpdateResponder

func (client CustomDomainsClient) UpdateResponder(resp *http.Response) (result ErrorResponse, err error)

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

func (CustomDomainsClient) UpdateSender

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

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

type CustomDomainsCreateFuture

type CustomDomainsCreateFuture struct {
	azure.Future
}

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 CustomDomainsDeleteIfExistsFuture

type CustomDomainsDeleteIfExistsFuture struct {
	azure.Future
}

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

func (*CustomDomainsDeleteIfExistsFuture) Result

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

type DeepCreatedOrigin

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

DeepCreatedOrigin deep created origins within a CDN endpoint.

func (DeepCreatedOrigin) MarshalJSON

func (dco DeepCreatedOrigin) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DeepCreatedOrigin.

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. 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"`
}

DeepCreatedOriginProperties properties of deep created origin on a CDN endpoint.

type Endpoint

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

Endpoint CDN endpoint is the entity within a CDN profile containing configuration information regarding caching behaviors and origins. The CDN endpoint is exposed using the URL format <endpointname>.azureedge.net by default, but custom domains can also be created.

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 EndpointCreateParameters

type EndpointCreateParameters struct {
	// Location - Endpoint location
	Location *string `json:"location,omitempty"`
	// Tags - Endpoint tags
	Tags                                map[string]*string `json:"tags"`
	*EndpointPropertiesCreateParameters `json:"properties,omitempty"`
}

EndpointCreateParameters endpoint properties required for new endpoint creation.

func (EndpointCreateParameters) MarshalJSON

func (ecp EndpointCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EndpointCreateParameters.

func (*EndpointCreateParameters) UnmarshalJSON

func (ecp *EndpointCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for EndpointCreateParameters struct.

type EndpointListResult

type EndpointListResult struct {
	autorest.Response `json:"-"`
	// Value - List of CDN endpoints within a profile
	Value *[]Endpoint `json:"value,omitempty"`
}

EndpointListResult ...

type EndpointProperties

type EndpointProperties struct {
	// HostName - READ-ONLY; The host name of the endpoint {endpointName}.{DNSZone}
	HostName *string `json:"hostName,omitempty"`
	// OriginHostHeader - The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin.
	OriginHostHeader *string `json:"originHostHeader,omitempty"`
	// OriginPath - The path used for origin requests.
	OriginPath *string `json:"originPath,omitempty"`
	// ContentTypesToCompress - List of content types on which compression will be applied. The value for the elements should be a valid MIME type.
	ContentTypesToCompress *[]string `json:"contentTypesToCompress,omitempty"`
	// IsCompressionEnabled - Indicates whether the compression is enabled. Default value is false. If compression is enabled, the content transferred from cdn endpoint to end user will be compressed. The requested content must be larger than 1 byte and smaller 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"`
	// Origins - The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options.
	Origins *[]DeepCreatedOrigin `json:"origins,omitempty"`
	// ResourceState - READ-ONLY; 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. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}

EndpointProperties ...

func (EndpointProperties) MarshalJSON

func (ep EndpointProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for EndpointProperties.

type EndpointPropertiesCreateParameters

type EndpointPropertiesCreateParameters struct {
	// OriginHostHeader - The host header CDN provider will send along with content requests to origins. The default value is the host name of the origin.
	OriginHostHeader *string `json:"originHostHeader,omitempty"`
	// OriginPath - The path used for origin requests.
	OriginPath *string `json:"originPath,omitempty"`
	// ContentTypesToCompress - List of content types on which compression will be applied. The value for the elements should be a valid MIME type.
	ContentTypesToCompress *[]string `json:"contentTypesToCompress,omitempty"`
	// IsCompressionEnabled - Indicates whether content compression is enabled. Default value is false. If compression is enabled, the content transferred from the CDN endpoint to the end user will be compressed. The requested content must be larger than 1 byte and smaller 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"`
	// Origins - The set of origins for the CDN endpoint. When multiple origins exist, the first origin will be used as primary and rest will be used as failover options.
	Origins *[]DeepCreatedOrigin `json:"origins,omitempty"`
}

EndpointPropertiesCreateParameters ...

type EndpointPropertiesUpdateParameters

type EndpointPropertiesUpdateParameters struct {
	// OriginHostHeader - The host header the CDN provider will send along with content requests to origins. The default value is the host name of the origin.
	OriginHostHeader *string `json:"originHostHeader,omitempty"`
	// OriginPath - The path used for origin requests.
	OriginPath *string `json:"originPath,omitempty"`
	// ContentTypesToCompress - List of content types on which compression will be applied. The value for the elements should be a valid MIME type.
	ContentTypesToCompress *[]string `json:"contentTypesToCompress,omitempty"`
	// IsCompressionEnabled - Indicates whether content compression is enabled. Default value is false. If compression is enabled, the content transferred from the CDN endpoint to the end user will be compressed. The requested content must be larger than 1 byte and smaller 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"`
}

EndpointPropertiesUpdateParameters ...

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"
)

func PossibleEndpointResourceStateValues

func PossibleEndpointResourceStateValues() []EndpointResourceState

PossibleEndpointResourceStateValues returns an array of possible values for the EndpointResourceState const type.

type EndpointUpdateParameters

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

EndpointUpdateParameters endpoint properties required for new endpoint creation.

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 cdn Management Client

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (EndpointsClient) Create

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

Create sends the create request. Parameters: endpointName - name of the endpoint within the CDN profile. endpointProperties - endpoint properties profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (EndpointsClient) CreatePreparer

func (client EndpointsClient) CreatePreparer(ctx context.Context, endpointName string, endpointProperties EndpointCreateParameters, profileName string, resourceGroupName string) (*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) DeleteIfExists

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

DeleteIfExists sends the delete if exists request. Parameters: endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (EndpointsClient) DeleteIfExistsPreparer

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

DeleteIfExistsPreparer prepares the DeleteIfExists request.

func (EndpointsClient) DeleteIfExistsResponder

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

DeleteIfExistsResponder handles the response to the DeleteIfExists request. The method always closes the http.Response Body.

func (EndpointsClient) DeleteIfExistsSender

func (client EndpointsClient) DeleteIfExistsSender(req *http.Request) (future EndpointsDeleteIfExistsFuture, err error)

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

func (EndpointsClient) Get

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

Get sends the get request. Parameters: endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (EndpointsClient) GetPreparer

func (client EndpointsClient) GetPreparer(ctx context.Context, endpointName string, profileName string, resourceGroupName 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, profileName string, resourceGroupName string) (result EndpointListResult, err error)

ListByProfile sends the list by profile request. Parameters: profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (EndpointsClient) ListByProfilePreparer

func (client EndpointsClient) ListByProfilePreparer(ctx context.Context, profileName string, resourceGroupName 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) LoadContent

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

LoadContent sends the load content request. Parameters: endpointName - name of the endpoint within the CDN profile. contentFilePaths - the path to the content to be loaded. Path should describe a file. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (EndpointsClient) LoadContentPreparer

func (client EndpointsClient) LoadContentPreparer(ctx context.Context, endpointName string, contentFilePaths LoadParameters, profileName string, resourceGroupName string) (*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, endpointName string, contentFilePaths PurgeParameters, profileName string, resourceGroupName string) (result EndpointsPurgeContentFuture, err error)

PurgeContent sends the purge content request. Parameters: endpointName - name of the endpoint within the CDN profile. contentFilePaths - the path to the content to be purged. Path can describe a file or directory. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (EndpointsClient) PurgeContentPreparer

func (client EndpointsClient) PurgeContentPreparer(ctx context.Context, endpointName string, contentFilePaths PurgeParameters, profileName string, resourceGroupName string) (*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, endpointName string, profileName string, resourceGroupName string) (result EndpointsStartFuture, err error)

Start sends the start request. Parameters: endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (EndpointsClient) StartPreparer

func (client EndpointsClient) StartPreparer(ctx context.Context, endpointName string, profileName string, resourceGroupName 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, endpointName string, profileName string, resourceGroupName string) (result EndpointsStopFuture, err error)

Stop sends the stop request. Parameters: endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (EndpointsClient) StopPreparer

func (client EndpointsClient) StopPreparer(ctx context.Context, endpointName string, profileName string, resourceGroupName 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, endpointName string, endpointProperties EndpointUpdateParameters, profileName string, resourceGroupName string) (result EndpointsUpdateFuture, err error)

Update sends the update request. Parameters: endpointName - name of the endpoint within the CDN profile. endpointProperties - endpoint properties profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (EndpointsClient) UpdatePreparer

func (client EndpointsClient) UpdatePreparer(ctx context.Context, endpointName string, endpointProperties EndpointUpdateParameters, profileName string, resourceGroupName string) (*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, endpointName string, customDomainProperties ValidateCustomDomainInput, profileName string, resourceGroupName string) (result ValidateCustomDomainOutput, err error)

ValidateCustomDomain sends the validate custom domain request. Parameters: endpointName - name of the endpoint within the CDN profile. customDomainProperties - custom domain to validate. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (EndpointsClient) ValidateCustomDomainPreparer

func (client EndpointsClient) ValidateCustomDomainPreparer(ctx context.Context, endpointName string, customDomainProperties ValidateCustomDomainInput, profileName string, resourceGroupName string) (*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
}

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 EndpointsDeleteIfExistsFuture

type EndpointsDeleteIfExistsFuture struct {
	azure.Future
}

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

func (*EndpointsDeleteIfExistsFuture) Result

func (future *EndpointsDeleteIfExistsFuture) 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
}

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
}

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
}

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
}

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
}

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 {
	autorest.Response `json:"-"`
	// Code - Error code
	Code *string `json:"code,omitempty"`
	// Message - Error message indicating why the operation failed.
	Message *string `json:"message,omitempty"`
}

ErrorResponse ...

type LoadParameters

type LoadParameters struct {
	// ContentPaths - The path to the content to be loaded. Should describe a file path.
	ContentPaths *[]string `json:"contentPaths,omitempty"`
}

LoadParameters parameters required for endpoint load.

type NameAvailabilityClient

type NameAvailabilityClient struct {
	BaseClient
}

NameAvailabilityClient is the cdn Management Client

func NewNameAvailabilityClient

func NewNameAvailabilityClient(subscriptionID string) NameAvailabilityClient

NewNameAvailabilityClient creates an instance of the NameAvailabilityClient client.

func NewNameAvailabilityClientWithBaseURI

func NewNameAvailabilityClientWithBaseURI(baseURI string, subscriptionID string) NameAvailabilityClient

NewNameAvailabilityClientWithBaseURI creates an instance of the NameAvailabilityClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (NameAvailabilityClient) CheckNameAvailability

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

CheckNameAvailability sends the check name availability request. Parameters: checkNameAvailabilityInput - input to check.

func (NameAvailabilityClient) CheckNameAvailabilityPreparer

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

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (NameAvailabilityClient) CheckNameAvailabilityResponder

func (client NameAvailabilityClient) 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 (NameAvailabilityClient) CheckNameAvailabilitySender

func (client NameAvailabilityClient) 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.

type Operation

type Operation struct {
	// Name - Operation name: {provider}/{resource}/{operation}
	Name    *string           `json:"name,omitempty"`
	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 ...

type OperationListResult

type OperationListResult struct {
	autorest.Response `json:"-"`
	// Value - List of CDN operations supported by the CDN resource provider.
	Value *[]Operation `json:"value,omitempty"`
}

OperationListResult ...

type OperationsClient

type OperationsClient struct {
	BaseClient
}

OperationsClient is the cdn Management Client

func NewOperationsClient

func NewOperationsClient(subscriptionID string) OperationsClient

NewOperationsClient creates an instance of the OperationsClient client.

func NewOperationsClientWithBaseURI

func NewOperationsClientWithBaseURI(baseURI string, subscriptionID string) OperationsClient

NewOperationsClientWithBaseURI creates an instance of the OperationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OperationsClient) List

func (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)

List sends the list request.

func (OperationsClient) ListPreparer

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

ListPreparer prepares the List request.

func (OperationsClient) ListResponder

func (client OperationsClient) ListResponder(resp *http.Response) (result OperationListResult, err error)

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

func (OperationsClient) ListSender

func (client OperationsClient) 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 Origin

type Origin struct {
	autorest.Response `json:"-"`
	*OriginProperties `json:"properties,omitempty"`
	// ID - READ-ONLY; Resource ID
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
}

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"`
}

OriginListResult ...

type OriginParameters

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

OriginParameters origin properties needed for origin creation or update.

func (OriginParameters) MarshalJSON

func (op OriginParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OriginParameters.

func (*OriginParameters) UnmarshalJSON

func (op *OriginParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OriginParameters struct.

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 - READ-ONLY; Resource status of the origin. Possible values include: 'OriginResourceStateCreating', 'OriginResourceStateActive', 'OriginResourceStateDeleting'
	ResourceState OriginResourceState `json:"resourceState,omitempty"`
	// ProvisioningState - Provisioning status of the origin. Possible values include: 'ProvisioningStateCreating', 'ProvisioningStateSucceeded', 'ProvisioningStateFailed'
	ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
}

OriginProperties ...

func (OriginProperties) MarshalJSON

func (op OriginProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OriginProperties.

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 ...

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"
)

func PossibleOriginResourceStateValues

func PossibleOriginResourceStateValues() []OriginResourceState

PossibleOriginResourceStateValues returns an array of possible values for the OriginResourceState const type.

type OriginsClient

type OriginsClient struct {
	BaseClient
}

OriginsClient is the cdn Management Client

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OriginsClient) Create

func (client OriginsClient) Create(ctx context.Context, originName string, originProperties OriginParameters, endpointName string, profileName string, resourceGroupName string) (result OriginsCreateFuture, err error)

Create sends the create request. Parameters: originName - name of the origin, an arbitrary value but it needs to be unique under endpoint originProperties - origin properties endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (OriginsClient) CreatePreparer

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

CreatePreparer prepares the Create request.

func (OriginsClient) CreateResponder

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

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

func (OriginsClient) CreateSender

func (client OriginsClient) CreateSender(req *http.Request) (future OriginsCreateFuture, err error)

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

func (OriginsClient) DeleteIfExists

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

DeleteIfExists sends the delete if exists request. Parameters: originName - name of the origin. Must be unique within endpoint. endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (OriginsClient) DeleteIfExistsPreparer

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

DeleteIfExistsPreparer prepares the DeleteIfExists request.

func (OriginsClient) DeleteIfExistsResponder

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

DeleteIfExistsResponder handles the response to the DeleteIfExists request. The method always closes the http.Response Body.

func (OriginsClient) DeleteIfExistsSender

func (client OriginsClient) DeleteIfExistsSender(req *http.Request) (future OriginsDeleteIfExistsFuture, err error)

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

func (OriginsClient) Get

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

Get sends the get request. Parameters: originName - name of the origin, an arbitrary value but it needs to be unique under endpoint endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (OriginsClient) GetPreparer

func (client OriginsClient) GetPreparer(ctx context.Context, originName string, endpointName string, profileName string, resourceGroupName 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, endpointName string, profileName string, resourceGroupName string) (result OriginListResult, err error)

ListByEndpoint sends the list by endpoint request. Parameters: endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (OriginsClient) ListByEndpointPreparer

func (client OriginsClient) ListByEndpointPreparer(ctx context.Context, endpointName string, profileName string, resourceGroupName 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, originName string, originProperties OriginParameters, endpointName string, profileName string, resourceGroupName string) (result OriginsUpdateFuture, err error)

Update sends the update request. Parameters: originName - name of the origin. Must be unique within endpoint. originProperties - origin properties endpointName - name of the endpoint within the CDN profile. profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (OriginsClient) UpdatePreparer

func (client OriginsClient) UpdatePreparer(ctx context.Context, originName string, originProperties OriginParameters, endpointName string, profileName string, resourceGroupName string) (*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 OriginsCreateFuture

type OriginsCreateFuture struct {
	azure.Future
}

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

func (*OriginsCreateFuture) Result

func (future *OriginsCreateFuture) 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 OriginsDeleteIfExistsFuture

type OriginsDeleteIfExistsFuture struct {
	azure.Future
}

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

func (*OriginsDeleteIfExistsFuture) Result

func (future *OriginsDeleteIfExistsFuture) 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 OriginsUpdateFuture

type OriginsUpdateFuture struct {
	azure.Future
}

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 SKU (pricing tier) of the CDN profile.
	Sku                *Sku `json:"sku,omitempty"`
	*ProfileProperties `json:"properties,omitempty"`
	// Location - Resource location
	Location *string `json:"location,omitempty"`
	// Tags - Resource tags
	Tags map[string]*string `json:"tags"`
	// ID - READ-ONLY; Resource ID
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
}

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 ProfileCreateParameters

type ProfileCreateParameters struct {
	// Location - Profile location
	Location *string `json:"location,omitempty"`
	// Tags - Profile tags
	Tags map[string]*string `json:"tags"`
	// Sku - The SKU (pricing tier) of the CDN profile.
	Sku *Sku `json:"sku,omitempty"`
}

ProfileCreateParameters profile properties required for profile creation.

func (ProfileCreateParameters) MarshalJSON

func (pcp ProfileCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProfileCreateParameters.

type ProfileListResult

type ProfileListResult struct {
	autorest.Response `json:"-"`
	// Value - List of CDN profiles within a resource group.
	Value *[]Profile `json:"value,omitempty"`
}

ProfileListResult ...

type ProfileProperties

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

ProfileProperties ...

func (ProfileProperties) MarshalJSON

func (pp ProfileProperties) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ProfileProperties.

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"
)

func PossibleProfileResourceStateValues

func PossibleProfileResourceStateValues() []ProfileResourceState

PossibleProfileResourceStateValues returns an array of possible values for the ProfileResourceState const type.

type ProfileUpdateParameters

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

ProfileUpdateParameters profile properties required for profile update.

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 cdn Management Client

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 using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ProfilesClient) Create

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

Create sends the create request. Parameters: profileName - name of the CDN profile within the resource group. profileProperties - profile properties needed for creation. resourceGroupName - name of the resource group within the Azure subscription.

func (ProfilesClient) CreatePreparer

func (client ProfilesClient) CreatePreparer(ctx context.Context, profileName string, profileProperties ProfileCreateParameters, resourceGroupName string) (*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) DeleteIfExists

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

DeleteIfExists sends the delete if exists request. Parameters: profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (ProfilesClient) DeleteIfExistsPreparer

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

DeleteIfExistsPreparer prepares the DeleteIfExists request.

func (ProfilesClient) DeleteIfExistsResponder

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

DeleteIfExistsResponder handles the response to the DeleteIfExists request. The method always closes the http.Response Body.

func (ProfilesClient) DeleteIfExistsSender

func (client ProfilesClient) DeleteIfExistsSender(req *http.Request) (future ProfilesDeleteIfExistsFuture, err error)

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

func (ProfilesClient) GenerateSsoURI

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

GenerateSsoURI sends the generate sso uri request. Parameters: profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (ProfilesClient) GenerateSsoURIPreparer

func (client ProfilesClient) GenerateSsoURIPreparer(ctx context.Context, profileName string, resourceGroupName 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, profileName string, resourceGroupName string) (result Profile, err error)

Get sends the get request. Parameters: profileName - name of the CDN profile within the resource group. resourceGroupName - name of the resource group within the Azure subscription.

func (ProfilesClient) GetPreparer

func (client ProfilesClient) GetPreparer(ctx context.Context, profileName string, resourceGroupName 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) ListByResourceGroup

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

ListByResourceGroup sends the list by resource group request. Parameters: resourceGroupName - name of the resource group within the Azure subscription.

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) ListBySubscriptionID

func (client ProfilesClient) ListBySubscriptionID(ctx context.Context) (result ProfileListResult, err error)

ListBySubscriptionID sends the list by subscription id request.

func (ProfilesClient) ListBySubscriptionIDPreparer

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

ListBySubscriptionIDPreparer prepares the ListBySubscriptionID request.

func (ProfilesClient) ListBySubscriptionIDResponder

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

ListBySubscriptionIDResponder handles the response to the ListBySubscriptionID request. The method always closes the http.Response Body.

func (ProfilesClient) ListBySubscriptionIDSender

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

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

func (ProfilesClient) Update

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

Update sends the update request. Parameters: profileName - name of the CDN profile within the resource group. profileProperties - profile properties needed for update. resourceGroupName - name of the resource group within the Azure subscription.

func (ProfilesClient) UpdatePreparer

func (client ProfilesClient) UpdatePreparer(ctx context.Context, profileName string, profileProperties ProfileUpdateParameters, resourceGroupName string) (*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
}

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 ProfilesDeleteIfExistsFuture

type ProfilesDeleteIfExistsFuture struct {
	azure.Future
}

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

func (*ProfilesDeleteIfExistsFuture) Result

func (future *ProfilesDeleteIfExistsFuture) 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
}

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 ProvisioningState

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

const (
	// ProvisioningStateCreating ...
	ProvisioningStateCreating ProvisioningState = "Creating"
	// ProvisioningStateFailed ...
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateSucceeded ...
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

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 endpoint 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"
)

func PossibleQueryStringCachingBehaviorValues

func PossibleQueryStringCachingBehaviorValues() []QueryStringCachingBehavior

PossibleQueryStringCachingBehaviorValues returns an array of possible values for the QueryStringCachingBehavior const type.

type Resource

type Resource struct {
	// ID - READ-ONLY; Resource ID
	ID *string `json:"id,omitempty"`
	// Name - READ-ONLY; Resource name
	Name *string `json:"name,omitempty"`
	// Type - READ-ONLY; Resource type
	Type *string `json:"type,omitempty"`
}

Resource ...

type ResourceType

type ResourceType string

ResourceType enumerates the values for resource type.

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

func PossibleResourceTypeValues

func PossibleResourceTypeValues() []ResourceType

PossibleResourceTypeValues returns an array of possible values for the ResourceType const type.

type Sku

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

Sku the SKU (pricing tier) 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"
	// StandardVerizon ...
	StandardVerizon SkuName = "Standard_Verizon"
)

func PossibleSkuNameValues

func PossibleSkuNameValues() []SkuName

PossibleSkuNameValues returns an array of possible values for the SkuName const type.

type SsoURI

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

SsoURI SSO URI required to login to third party web portal.

type TrackedResource

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

TrackedResource ARM tracked resource

func (TrackedResource) MarshalJSON

func (tr TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrackedResource.

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.

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 - The message describing why the custom domain is not valid.
	Message *string `json:"message,omitempty"`
}

ValidateCustomDomainOutput output of custom domain validation.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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