azure_cdn_profile Resource
Use the azure_cdn_profile
Chef InSpec audit resource to test the properties and configuration of an Azure CDN profile.
Azure REST API Version, Endpoint, and HTTP Client Parameters
This resource interacts with API versions supported by the resource provider.
The api_version
can be defined as a resource parameter.
If not provided, this resource uses the latest version.
For more information, refer to the azure_generic_resource
document.
Unless defined, this resource uses the azure_cloud
global endpoint and default values for the HTTP client.
For more information, refer to the resource pack README.
Install
This resource is available in the Chef InSpec Azure resource pack.
For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.
Syntax
Either the resource_group
and name
, or the resource_id
are required .
describe azure_cdn_profile(resource_group: 'RESOURCE_GROUP', name: 'NAME') do
it { should exist }
end
describe azure_cdn_profile(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}') do
it { should exist }
end
Parameters
resource_group
- Azure resource group that the targeted resource resides in.
name
- The unique name of the CDN profile name.
resource_id
- The unique resource ID.
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}
.
Provide one of the following parameter sets for a valid query:
resource_id
resource_group
andname
Properties
properties.frontDoorId
- The ID of the frontdoor.
For properties applicable to all resources, such as type
, name
, id
, properties
, refer to azure_generic_resource
.
See the Azure CDN profile documentation for other available properties.
Any attribute in the response may be accessed with the key names separated by dots (.
).
Examples
Check the resource state of a CDN profile.
describe azure_cdn_profile(resource_group: 'RESOURCE_GROUP', name: 'NAME') do
its('properties.resourceState') { should eq 'Active' }
end
Check the resource state of all profiles in a subscription.
azure_cdn_profiles.ids.each do |id|
describe azure_cdn_profile(resource_id: id) do
its('properties.resourceState') { should eq 'Active' }
end
end
Matchers
This Chef InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.
exists
Use exist
if a resource should exist.
describe azure_cdn_profile(resource_group: 'RESOURCE_GROUP', name: 'NAME') do
it { should exist }
end
Use should_not
for a resource that should not exist.
describe azure_cdn_profile(resource_group: 'RESOURCE_GROUP', name: 'NAME') do
it { should_not exist }
end
Azure Permissions
Your Service Principal must be set up with at least a reader
role on the subscription you wish to test.