azure_container_registry Resource
Use the azure_container_registry
InSpec audit resource to test the properties and configuration of an Azure Container Registry.
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
This resource requires the resource_group
and name
parameters, or the resource_id
parameter.
describe azure_container_registry(resource_group: 'RESOURCE_GROUP', name: 'NAME') do
it { should exist }
end
describe azure_container_registry(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ContainerRegistry/registries/{registryName}') do
it { should exist }
end
Parameters
resource_group
- Azure resource group where the targeted resource resides.
name
- The unique name of the targeted resource.
container_registry_name
- Alias for the
name
parameter. resource_id
- The unique resource ID.
Either one of the parameter sets can be provided for a valid query:
resource_id
resource_group
andname
resource_group
andcontainer_registry_name
Properties
id
- The identity of the container registry, if configured.
sku
- The SKU of the container registry.
For properties applicable to all resources, such as type
, name
, id
, and properties
, refer to azure_generic_resource
.
Also, refer to the Azure documentation for other available properties. Any attribute in the response may be accessed with the key names separated by dots (.
).
Examples
Test the status of the retention policy for the container registry
describe azure_container_registry(resource_group: 'RESOURCE_GROUP', name: 'NAME') do
its('properties.status.retentionPolicy') { should cmp 'enabled' }
end
describe azure_container_registry(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ContainerRegistry/registries/{registryName}') do
its('properties.status.retentionPolicy') { should cmp 'enabled' }
end
See integration tests for more examples.
Matchers
This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.
exists
# If we expect 'CR-1' to always exist.
describe azure_container_registry(resource_group: 'RESOURCE_GROUP', name: 'CR-1') do
it { should exist }
end
not_exists
# If we expect 'CR-1' to never exist.
describe azure_container_registry(resource_group: 'RESOURCE_GROUP', name: 'CR-1') do
it { should_not exist }
end
Azure Permissions
Your Service Principal must be set up with at least a contributor
role on the subscription you wish to test.