const (
// DefaultBaseURI is the default URI used for the service Cdn
DefaultBaseURI = "https://management.azure.com"
)
func UserAgent() string
UserAgent returns the UserAgent string to use when sending http.Requests.
func Version() string
Version returns the semantic version (see http://semver.org) of the client.
BaseClient is the base client for Cdn.
type BaseClient struct {
autorest.Client
BaseURI string
SubscriptionID string
}
func New(subscriptionID string) BaseClient
New creates an instance of the BaseClient client.
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).
CheckNameAvailabilityInput input of CheckNameAvailability API.
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"`
}
CheckNameAvailabilityOutput output of check name availability API.
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"`
}
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.
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"`
}
func (cd CustomDomain) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CustomDomain.
func (cd *CustomDomain) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CustomDomain struct.
CustomDomainListResult ...
type CustomDomainListResult struct {
autorest.Response `json:"-"`
// Value - List of CDN CustomDomains within an endpoint.
Value *[]CustomDomain `json:"value,omitempty"`
}
CustomDomainParameters customDomain properties required for custom domain creation or update.
type CustomDomainParameters struct {
*CustomDomainPropertiesParameters `json:"properties,omitempty"`
}
func (cdp CustomDomainParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CustomDomainParameters.
func (cdp *CustomDomainParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for CustomDomainParameters struct.
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"`
}
func (cdp CustomDomainProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for CustomDomainProperties.
CustomDomainPropertiesParameters ...
type CustomDomainPropertiesParameters struct {
// HostName - The host name of the custom domain. Must be a domain name.
HostName *string `json:"hostName,omitempty"`
}
CustomDomainResourceState enumerates the values for custom domain resource state.
type CustomDomainResourceState string
const (
// Active ...
Active CustomDomainResourceState = "Active"
// Creating ...
Creating CustomDomainResourceState = "Creating"
// Deleting ...
Deleting CustomDomainResourceState = "Deleting"
)
func PossibleCustomDomainResourceStateValues() []CustomDomainResourceState
PossibleCustomDomainResourceStateValues returns an array of possible values for the CustomDomainResourceState const type.
CustomDomainsClient is the cdn Management Client
type CustomDomainsClient struct {
BaseClient
}
func NewCustomDomainsClient(subscriptionID string) CustomDomainsClient
NewCustomDomainsClient creates an instance of the CustomDomainsClient client.
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 (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 (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 (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 (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 (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 (client CustomDomainsClient) DeleteIfExistsPreparer(ctx context.Context, customDomainName string, endpointName string, profileName string, resourceGroupName string) (*http.Request, error)
DeleteIfExistsPreparer prepares the DeleteIfExists request.
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 (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 (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 (client CustomDomainsClient) GetPreparer(ctx context.Context, customDomainName string, endpointName string, profileName string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (client CustomDomainsClient) ListByEndpointPreparer(ctx context.Context, endpointName string, profileName string, resourceGroupName string) (*http.Request, error)
ListByEndpointPreparer prepares the ListByEndpoint request.
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 (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 (client CustomDomainsClient) Update(ctx context.Context, customDomainName string, customDomainProperties CustomDomainParameters, endpointName string, profileName string, resourceGroupName string) (result autorest.Response, 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 (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 (client CustomDomainsClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)
UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.
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.
CustomDomainsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CustomDomainsCreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CustomDomainsClient) (CustomDomain, error)
}
func (future *CustomDomainsCreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
CustomDomainsDeleteIfExistsFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type CustomDomainsDeleteIfExistsFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(CustomDomainsClient) (CustomDomain, error)
}
func (future *CustomDomainsDeleteIfExistsFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
DeepCreatedOrigin deep created origins within a CDN endpoint.
type DeepCreatedOrigin struct {
// Name - Origin name
Name *string `json:"name,omitempty"`
*DeepCreatedOriginProperties `json:"properties,omitempty"`
}
func (dco DeepCreatedOrigin) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for DeepCreatedOrigin.
func (dco *DeepCreatedOrigin) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for DeepCreatedOrigin struct.
DeepCreatedOriginProperties properties of deep created origin on a CDN endpoint.
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"`
}
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.
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"`
}
func (e Endpoint) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Endpoint.
func (e *Endpoint) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Endpoint struct.
EndpointCreateParameters endpoint properties required for new endpoint creation.
type EndpointCreateParameters struct {
// Location - Endpoint location
Location *string `json:"location,omitempty"`
// Tags - Endpoint tags
Tags map[string]*string `json:"tags"`
*EndpointPropertiesCreateParameters `json:"properties,omitempty"`
}
func (ecp EndpointCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EndpointCreateParameters.
func (ecp *EndpointCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for EndpointCreateParameters struct.
EndpointListResult ...
type EndpointListResult struct {
autorest.Response `json:"-"`
// Value - List of CDN endpoints within a profile
Value *[]Endpoint `json:"value,omitempty"`
}
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"`
}
func (ep EndpointProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EndpointProperties.
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"`
}
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"`
}
EndpointResourceState enumerates the values for endpoint resource state.
type EndpointResourceState string
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() []EndpointResourceState
PossibleEndpointResourceStateValues returns an array of possible values for the EndpointResourceState const type.
EndpointUpdateParameters endpoint properties required for new endpoint creation.
type EndpointUpdateParameters struct {
// Tags - Endpoint tags
Tags map[string]*string `json:"tags"`
*EndpointPropertiesUpdateParameters `json:"properties,omitempty"`
}
func (eup EndpointUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for EndpointUpdateParameters.
func (eup *EndpointUpdateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for EndpointUpdateParameters struct.
EndpointsClient is the cdn Management Client
type EndpointsClient struct {
BaseClient
}
func NewEndpointsClient(subscriptionID string) EndpointsClient
NewEndpointsClient creates an instance of the EndpointsClient client.
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 (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 (client EndpointsClient) CreatePreparer(ctx context.Context, endpointName string, endpointProperties EndpointCreateParameters, profileName string, resourceGroupName string) (*http.Request, error)
CreatePreparer prepares the Create request.
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 (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 (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 (client EndpointsClient) DeleteIfExistsPreparer(ctx context.Context, endpointName string, profileName string, resourceGroupName string) (*http.Request, error)
DeleteIfExistsPreparer prepares the DeleteIfExists request.
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 (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 (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 (client EndpointsClient) GetPreparer(ctx context.Context, endpointName string, profileName string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (client EndpointsClient) ListByProfilePreparer(ctx context.Context, profileName string, resourceGroupName string) (*http.Request, error)
ListByProfilePreparer prepares the ListByProfile request.
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 (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 (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 (client EndpointsClient) LoadContentPreparer(ctx context.Context, endpointName string, contentFilePaths LoadParameters, profileName string, resourceGroupName string) (*http.Request, error)
LoadContentPreparer prepares the LoadContent request.
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 (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 (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 (client EndpointsClient) PurgeContentPreparer(ctx context.Context, endpointName string, contentFilePaths PurgeParameters, profileName string, resourceGroupName string) (*http.Request, error)
PurgeContentPreparer prepares the PurgeContent request.
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 (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 (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 (client EndpointsClient) StartPreparer(ctx context.Context, endpointName string, profileName string, resourceGroupName string) (*http.Request, error)
StartPreparer prepares the Start request.
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 (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 (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 (client EndpointsClient) StopPreparer(ctx context.Context, endpointName string, profileName string, resourceGroupName string) (*http.Request, error)
StopPreparer prepares the Stop request.
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 (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 (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 (client EndpointsClient) UpdatePreparer(ctx context.Context, endpointName string, endpointProperties EndpointUpdateParameters, profileName string, resourceGroupName string) (*http.Request, error)
UpdatePreparer prepares the Update request.
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 (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 (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 (client EndpointsClient) ValidateCustomDomainPreparer(ctx context.Context, endpointName string, customDomainProperties ValidateCustomDomainInput, profileName string, resourceGroupName string) (*http.Request, error)
ValidateCustomDomainPreparer prepares the ValidateCustomDomain request.
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 (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.
EndpointsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EndpointsCreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(EndpointsClient) (Endpoint, error)
}
func (future *EndpointsCreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
EndpointsDeleteIfExistsFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EndpointsDeleteIfExistsFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(EndpointsClient) (autorest.Response, error)
}
func (future *EndpointsDeleteIfExistsFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
EndpointsLoadContentFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EndpointsLoadContentFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(EndpointsClient) (autorest.Response, error)
}
func (future *EndpointsLoadContentFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
EndpointsPurgeContentFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EndpointsPurgeContentFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(EndpointsClient) (autorest.Response, error)
}
func (future *EndpointsPurgeContentFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
EndpointsStartFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EndpointsStartFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(EndpointsClient) (Endpoint, error)
}
func (future *EndpointsStartFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
EndpointsStopFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EndpointsStopFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(EndpointsClient) (Endpoint, error)
}
func (future *EndpointsStopFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
EndpointsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type EndpointsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(EndpointsClient) (Endpoint, error)
}
func (future *EndpointsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
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"`
}
LoadParameters parameters required for endpoint load.
type LoadParameters struct {
// ContentPaths - The path to the content to be loaded. Should describe a file path.
ContentPaths *[]string `json:"contentPaths,omitempty"`
}
NameAvailabilityClient is the cdn Management Client
type NameAvailabilityClient struct {
BaseClient
}
func NewNameAvailabilityClient(subscriptionID string) NameAvailabilityClient
NewNameAvailabilityClient creates an instance of the NameAvailabilityClient client.
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 (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 (client NameAvailabilityClient) CheckNameAvailabilityPreparer(ctx context.Context, checkNameAvailabilityInput CheckNameAvailabilityInput) (*http.Request, error)
CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.
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 (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.
Operation CDN REST API operation
type Operation struct {
// Name - Operation name: {provider}/{resource}/{operation}
Name *string `json:"name,omitempty"`
Display *OperationDisplay `json:"display,omitempty"`
}
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"`
}
OperationListResult ...
type OperationListResult struct {
autorest.Response `json:"-"`
// Value - List of CDN operations supported by the CDN resource provider.
Value *[]Operation `json:"value,omitempty"`
}
OperationsClient is the cdn Management Client
type OperationsClient struct {
BaseClient
}
func NewOperationsClient(subscriptionID string) OperationsClient
NewOperationsClient creates an instance of the OperationsClient client.
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 (client OperationsClient) List(ctx context.Context) (result OperationListResult, err error)
List sends the list request.
func (client OperationsClient) ListPreparer(ctx context.Context) (*http.Request, error)
ListPreparer prepares the List request.
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 (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.
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.
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"`
}
func (o Origin) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Origin.
func (o *Origin) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Origin struct.
OriginListResult ...
type OriginListResult struct {
autorest.Response `json:"-"`
// Value - List of CDN origins within an endpoint
Value *[]Origin `json:"value,omitempty"`
}
OriginParameters origin properties needed for origin creation or update.
type OriginParameters struct {
*OriginPropertiesParameters `json:"properties,omitempty"`
}
func (op OriginParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OriginParameters.
func (op *OriginParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for OriginParameters struct.
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"`
}
func (op OriginProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for OriginProperties.
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"`
}
OriginResourceState enumerates the values for origin resource state.
type OriginResourceState string
const (
// OriginResourceStateActive ...
OriginResourceStateActive OriginResourceState = "Active"
// OriginResourceStateCreating ...
OriginResourceStateCreating OriginResourceState = "Creating"
// OriginResourceStateDeleting ...
OriginResourceStateDeleting OriginResourceState = "Deleting"
)
func PossibleOriginResourceStateValues() []OriginResourceState
PossibleOriginResourceStateValues returns an array of possible values for the OriginResourceState const type.
OriginsClient is the cdn Management Client
type OriginsClient struct {
BaseClient
}
func NewOriginsClient(subscriptionID string) OriginsClient
NewOriginsClient creates an instance of the OriginsClient client.
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 (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 (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 (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 (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 (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 (client OriginsClient) DeleteIfExistsPreparer(ctx context.Context, originName string, endpointName string, profileName string, resourceGroupName string) (*http.Request, error)
DeleteIfExistsPreparer prepares the DeleteIfExists request.
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 (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 (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 (client OriginsClient) GetPreparer(ctx context.Context, originName string, endpointName string, profileName string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (client OriginsClient) ListByEndpointPreparer(ctx context.Context, endpointName string, profileName string, resourceGroupName string) (*http.Request, error)
ListByEndpointPreparer prepares the ListByEndpoint request.
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 (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 (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 (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 (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 (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.
OriginsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type OriginsCreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(OriginsClient) (Origin, error)
}
func (future *OriginsCreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
OriginsDeleteIfExistsFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type OriginsDeleteIfExistsFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(OriginsClient) (Origin, error)
}
func (future *OriginsDeleteIfExistsFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
OriginsUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type OriginsUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(OriginsClient) (Origin, error)
}
func (future *OriginsUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
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.
type Profile struct {
autorest.Response `json:"-"`
*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"`
}
func (p Profile) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Profile.
func (p *Profile) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for Profile struct.
ProfileCreateParameters profile properties required for profile creation.
type ProfileCreateParameters struct {
// Location - Profile location
Location *string `json:"location,omitempty"`
// Tags - Profile tags
Tags map[string]*string `json:"tags"`
*ProfilePropertiesCreateParameters `json:"properties,omitempty"`
}
func (pcp ProfileCreateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProfileCreateParameters.
func (pcp *ProfileCreateParameters) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaler for ProfileCreateParameters struct.
ProfileListResult ...
type ProfileListResult struct {
autorest.Response `json:"-"`
// Value - List of CDN profiles within a resource group.
Value *[]Profile `json:"value,omitempty"`
}
ProfileProperties ...
type ProfileProperties struct {
// Sku - The SKU (pricing tier) of the CDN profile.
Sku *Sku `json:"sku,omitempty"`
// 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"`
}
func (pp ProfileProperties) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProfileProperties.
ProfilePropertiesCreateParameters ...
type ProfilePropertiesCreateParameters struct {
// Sku - Profile SKU
Sku *Sku `json:"sku,omitempty"`
}
ProfileResourceState enumerates the values for profile resource state.
type ProfileResourceState string
const (
// ProfileResourceStateActive ...
ProfileResourceStateActive ProfileResourceState = "Active"
// ProfileResourceStateCreating ...
ProfileResourceStateCreating ProfileResourceState = "Creating"
// ProfileResourceStateDeleting ...
ProfileResourceStateDeleting ProfileResourceState = "Deleting"
// ProfileResourceStateDisabled ...
ProfileResourceStateDisabled ProfileResourceState = "Disabled"
)
func PossibleProfileResourceStateValues() []ProfileResourceState
PossibleProfileResourceStateValues returns an array of possible values for the ProfileResourceState const type.
ProfileUpdateParameters profile properties required for profile update.
type ProfileUpdateParameters struct {
// Tags - Profile tags
Tags map[string]*string `json:"tags"`
}
func (pup ProfileUpdateParameters) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for ProfileUpdateParameters.
ProfilesClient is the cdn Management Client
type ProfilesClient struct {
BaseClient
}
func NewProfilesClient(subscriptionID string) ProfilesClient
NewProfilesClient creates an instance of the ProfilesClient client.
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 (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 (client ProfilesClient) CreatePreparer(ctx context.Context, profileName string, profileProperties ProfileCreateParameters, resourceGroupName string) (*http.Request, error)
CreatePreparer prepares the Create request.
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 (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 (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 (client ProfilesClient) DeleteIfExistsPreparer(ctx context.Context, profileName string, resourceGroupName string) (*http.Request, error)
DeleteIfExistsPreparer prepares the DeleteIfExists request.
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 (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 (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 (client ProfilesClient) GenerateSsoURIPreparer(ctx context.Context, profileName string, resourceGroupName string) (*http.Request, error)
GenerateSsoURIPreparer prepares the GenerateSsoURI request.
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 (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 (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 (client ProfilesClient) GetPreparer(ctx context.Context, profileName string, resourceGroupName string) (*http.Request, error)
GetPreparer prepares the Get request.
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 (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 (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 (client ProfilesClient) ListByResourceGroupPreparer(ctx context.Context, resourceGroupName string) (*http.Request, error)
ListByResourceGroupPreparer prepares the ListByResourceGroup request.
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 (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 (client ProfilesClient) ListBySubscriptionID(ctx context.Context) (result ProfileListResult, err error)
ListBySubscriptionID sends the list by subscription id request.
func (client ProfilesClient) ListBySubscriptionIDPreparer(ctx context.Context) (*http.Request, error)
ListBySubscriptionIDPreparer prepares the ListBySubscriptionID request.
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 (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 (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 (client ProfilesClient) UpdatePreparer(ctx context.Context, profileName string, profileProperties ProfileUpdateParameters, resourceGroupName string) (*http.Request, error)
UpdatePreparer prepares the Update request.
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 (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.
ProfilesCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ProfilesCreateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ProfilesClient) (Profile, error)
}
func (future *ProfilesCreateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ProfilesDeleteIfExistsFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ProfilesDeleteIfExistsFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ProfilesClient) (autorest.Response, error)
}
func (future *ProfilesDeleteIfExistsFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ProfilesUpdateFuture an abstraction for monitoring and retrieving the results of a long-running operation.
type ProfilesUpdateFuture struct {
azure.FutureAPI
// Result returns the result of the asynchronous operation.
// If the operation has not completed it will return an error.
Result func(ProfilesClient) (Profile, error)
}
func (future *ProfilesUpdateFuture) UnmarshalJSON(body []byte) error
UnmarshalJSON is the custom unmarshaller for CreateFuture.
ProvisioningState enumerates the values for provisioning state.
type ProvisioningState string
const (
// ProvisioningStateCreating ...
ProvisioningStateCreating ProvisioningState = "Creating"
// ProvisioningStateFailed ...
ProvisioningStateFailed ProvisioningState = "Failed"
// ProvisioningStateSucceeded ...
ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)
func PossibleProvisioningStateValues() []ProvisioningState
PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.
PurgeParameters parameters required for endpoint purge.
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"`
}
QueryStringCachingBehavior enumerates the values for query string caching behavior.
type QueryStringCachingBehavior string
const (
// BypassCaching ...
BypassCaching QueryStringCachingBehavior = "BypassCaching"
// IgnoreQueryString ...
IgnoreQueryString QueryStringCachingBehavior = "IgnoreQueryString"
// NotSet ...
NotSet QueryStringCachingBehavior = "NotSet"
// UseQueryString ...
UseQueryString QueryStringCachingBehavior = "UseQueryString"
)
func PossibleQueryStringCachingBehaviorValues() []QueryStringCachingBehavior
PossibleQueryStringCachingBehaviorValues returns an array of possible values for the QueryStringCachingBehavior const 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"`
}
func (r Resource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for Resource.
ResourceType enumerates the values for resource type.
type ResourceType string
const (
// MicrosoftCdnProfilesEndpoints ...
MicrosoftCdnProfilesEndpoints ResourceType = "Microsoft.Cdn/Profiles/Endpoints"
)
func PossibleResourceTypeValues() []ResourceType
PossibleResourceTypeValues returns an array of possible values for the ResourceType const type.
Sku the SKU (pricing tier) of the CDN profile.
type Sku struct {
// Name - Name of the pricing tier. Possible values include: 'Standard', 'Premium'
Name SkuName `json:"name,omitempty"`
}
SkuName enumerates the values for sku name.
type SkuName string
const (
// Premium ...
Premium SkuName = "Premium"
// Standard ...
Standard SkuName = "Standard"
)
func PossibleSkuNameValues() []SkuName
PossibleSkuNameValues returns an array of possible values for the SkuName const type.
SsoURI SSO URI required to login to third party web portal.
type SsoURI struct {
autorest.Response `json:"-"`
// SsoURIValue - The URI used to login to third party web portal.
SsoURIValue *string `json:"ssoUriValue,omitempty"`
}
TrackedResource ARM tracked resource
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"`
}
func (tr TrackedResource) MarshalJSON() ([]byte, error)
MarshalJSON is the custom marshaler for TrackedResource.
ValidateCustomDomainInput input of the custom domain to be validated.
type ValidateCustomDomainInput struct {
// HostName - The host name of the custom domain. Must be a domain name.
HostName *string `json:"hostName,omitempty"`
}
ValidateCustomDomainOutput output of custom domain validation.
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"`
}