{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-cdn","description":"CdnManagementClient","version":"2019-06-15-preview","base_url":"https://management.azure.com","endpoints":35,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api CdnManagementClient\n@base https://management.azure.com\n@version 2019-06-15-preview\n@auth OAuth2\n@common_fields {api-version: any # Version of the API to be used with the client request. Current version is 2017-04-02.}\n@endpoints 35\n@hint download_for_search\n@toc subscriptions(32), providers(3)\n\n@group subscriptions\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/profiles\n@desc Lists all of the CDN profiles within an Azure subscription.\n@required {subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles\n@desc Lists all of the CDN profiles within a resource group.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}\n@desc Gets a CDN profile with the specified profile name under the specified subscription and resource group.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}\n@desc Creates a new CDN profile with a profile name under the specified subscription and resource group.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., profile: map # Profile properties needed to create a new profile., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n@returns(201) Created. The request has been fulfilled and a new profile has been created.\n@returns(202) Accepted. The request has been accepted for processing and the operation will complete asynchronously.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}\n@desc Updates an existing CDN profile with the specified profile name under the specified subscription and resource group.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., profileUpdateParameters: map # Profile properties needed to update an existing profile., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n@returns(202) Accepted. The request has been accepted for processing and the operation will complete asynchronously.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}\n@desc Deletes an existing CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., subscriptionId: any # Azure Subscription ID.}\n@returns(202) Accepted. The request has been accepted for processing and the operation will complete asynchronously.\n@returns(204) No Content. The request has been accepted but the profile was not found.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri\n@desc Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getSupportedOptimizationTypes\n@desc Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkResourceUsage\n@desc Checks the quota and actual usage of endpoints under the given CDN profile.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints\n@desc Lists existing CDN endpoints.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}\n@desc Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}\n@desc Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., endpoint: map # Endpoint properties, subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n@returns(201) Created. The request has been fulfilled and a new endpoint has been created.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}\n@desc Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags and Origin HostHeader can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update custom domains, use the Update Custom Domain operation.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., endpointUpdateProperties: map # Endpoint update properties, subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n@returns(202) Accepted and the operation will complete asynchronously\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}\n@desc Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., subscriptionId: any # Azure Subscription ID.}\n@returns(202) Accepted and the operation will complete asynchronously.\n@returns(204) No Content. The request has been accepted but the endpoint was not found.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start\n@desc Starts an existing CDN endpoint that is on a stopped state.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop\n@desc Stops an existing running CDN endpoint.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge\n@desc Removes a content from CDN.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., contentFilePaths: map # The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load\n@desc Pre-loads a content to CDN. Available for Verizon Profiles.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., contentFilePaths: map # The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file, subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain\n@desc Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., customDomainProperties: map # Custom domain to be validated., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage\n@desc Checks the quota and usage of geo filters and custom domains under the given endpoint.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins\n@desc Lists all of the existing origins within an endpoint.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}\n@desc Gets an existing origin within an endpoint.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., originName: any # Name of the origin which is unique within the endpoint., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}\n@desc Updates an existing origin within an endpoint.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., originName: any # Name of the origin which is unique within the endpoint., originUpdateProperties: map # Origin properties, subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains\n@desc Lists all of the existing custom domains within an endpoint.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}\n@desc Gets an existing custom domain within an endpoint.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., customDomainName: any # Name of the custom domain within an endpoint., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}\n@desc Creates a new custom domain within an endpoint.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., customDomainName: any # Name of the custom domain within an endpoint., customDomainProperties: map # Properties required to create a new custom domain., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n@returns(201) Created. The request has been fulfilled and a new custom domain has been created.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}\n@desc Deletes an existing custom domain within an endpoint.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., customDomainName: any # Name of the custom domain within an endpoint., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n@returns(202) Accepted and the operation will complete asynchronously.\n@returns(204) No Content. The request has been accepted but the custom domain was not found\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/disableCustomHttps\n@desc Disable https delivery of the custom domain.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., customDomainName: any # Name of the custom domain within an endpoint., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps\n@desc Enable https delivery of the custom domain.\n@required {resourceGroupName: any # Name of the Resource group within the Azure subscription., profileName: any # Name of the CDN profile which is unique within the resource group., endpointName: any # Name of the endpoint under the profile which is unique globally., customDomainName: any # Name of the custom domain within an endpoint., subscriptionId: any # Azure Subscription ID.}\n@optional {customDomainHttpsParameters: any # The configuration specifying how to enable HTTPS for the custom domain - using CDN managed certificate or user's own certificate. If not specified, enabling ssl uses CDN managed certificate by default.}\n@returns(200) OK. The request has succeeded.\n@returns(202) Accepted and the operation will complete asynchronously.\n\n@endgroup\n\n@group providers\n@endpoint POST /providers/Microsoft.Cdn/checkNameAvailability\n@desc Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.\n@required {checkNameAvailabilityInput: map # Input to check.}\n@returns(200) OK. The request has succeeded.\n\n@endgroup\n\n@group subscriptions\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkNameAvailability\n@desc Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.\n@required {checkNameAvailabilityInput: map # Input to check., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateProbe\n@desc Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.\n@required {validateProbeInput: map # Input to check., subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkResourceUsage\n@desc Check the quota and actual usage of the CDN profiles under the given subscription.\n@required {subscriptionId: any # Azure Subscription ID.}\n@returns(200) OK. The request has succeeded.\n\n@endgroup\n\n@group providers\n@endpoint GET /providers/Microsoft.Cdn/operations\n@desc Lists all of the available CDN REST API operations.\n@returns(200) OK. The request has succeeded.\n\n@endpoint GET /providers/Microsoft.Cdn/edgenodes\n@desc Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.\n@returns(200) OK. The request has succeeded.\n\n@endgroup\n\n@end\n"}