deployment_safeguards

Creates, updates, deletes, gets or lists a deployment_safeguards resource.

Overview

Name	deployment_safeguards
Type	Resource
Id	azure.container_service_safeguards.deployment_safeguards

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
excludedNamespaces	array	User defined list of namespaces to exclude from Deployment Safeguards. Deployments in these namespaces will not be checked against any safeguards.
level	string	The deployment safeguards level. Possible values are Warn and Enforce. Required. Known values are: "Warn" and "Enforce". (Warn, Enforce)
podSecurityStandardsLevel	string	The pod security standards level. Known values are: "Privileged", "Baseline", and "Restricted". (Privileged, Baseline, Restricted)
provisioningState	string	Provisioning State. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Updating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemExcludedNamespaces	array	System defined list of namespaces excluded from Deployment Safeguards. These are determined by the underlying provider (such as AKS), and cannot be changed. Deployments in these namespaces will not be checked. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_uri		Fetch a deployment safeguard by name.
create	insert	resource_uri		Creates or updates a deploymentSafeguard.
delete	delete	resource_uri		Delete DeploymentSafeguards.
list_raw	exec	resource_uri		List DeploymentSafeguards by parent resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.

SELECT examples

get

Fetch a deployment safeguard by name.

SELECT
id,
name,
eTag,
excludedNamespaces,
level,
podSecurityStandardsLevel,
provisioningState,
systemData,
systemExcludedNamespaces,
type
FROM azure.container_service_safeguards.deployment_safeguards
WHERE resource_uri = '{{ resource_uri }}' -- required
;

INSERT examples

create

Creates or updates a deploymentSafeguard.

INSERT INTO azure.container_service_safeguards.deployment_safeguards (
properties,
resource_uri
)
SELECT 
'{{ properties }}',
'{{ resource_uri }}'
RETURNING
id,
name,
eTag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: deployment_safeguards
props:
  - name: resource_uri
    value: "{{ resource_uri }}"
    description: Required parameter for the deployment_safeguards resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      level: "{{ level }}"
      excludedNamespaces:
        - "{{ excludedNamespaces }}"
      systemExcludedNamespaces:
        - "{{ systemExcludedNamespaces }}"
      podSecurityStandardsLevel: "{{ podSecurityStandardsLevel }}"

DELETE examples

delete

Delete DeploymentSafeguards.

DELETE FROM azure.container_service_safeguards.deployment_safeguards
WHERE resource_uri = '{{ resource_uri }}' --required
;

Lifecycle Methods

list_raw

List DeploymentSafeguards by parent resource.

EXEC azure.container_service_safeguards.deployment_safeguards.list_raw 
@resource_uri='{{ resource_uri }}' --required
;