Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 39 additions & 8 deletions Commands/aks/safeguards/_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,39 @@ Enable Deployment Safeguards for a Managed Cluster

## Versions

### [2025-04-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-04-01.xml) **Stable**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-04-01 -->

#### examples

- Create a DeploymentSafeguards resource at Warn level with a managed cluster resource id
```bash
aks safeguards create --resource /subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1 --level Warn
```

- Create a DeploymentSafeguards resource at Warn level using subscription, resourcegroup, and name tags
```bash
aks safeguards create --subscription subid1 -g rg1 -n cluster1 --level Warn
```

- Create a DeploymentSafeguards resource at Warn level with ignored namespaces
```bash
aks safeguards create -g rg1 -n mc1 --excluded-ns ns1 ns2 --level Warn
```

### [2025-05-02-preview](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-05-02-preview.xml) **Preview**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-05-02-preview -->

#### examples

- Creates a DeploymentSafeguards resource at Warn level with a managed cluster resource id
- Create a DeploymentSafeguards resource at Warn level with a managed cluster resource id
```bash
aks safeguards create --resource /subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1 --level Warn
```

- Creates a DeploymentSafeguards resource at Warn level using subscription, resourcegroup, and name tags
- Create a DeploymentSafeguards resource at Warn level using subscription, resourcegroup, and name tags
```bash
aks safeguards create --subscription subid1 -g rg1 -n cluster1 --level Warn
```
Expand All @@ -25,28 +46,28 @@ Enable Deployment Safeguards for a Managed Cluster
aks safeguards create -g rg1 -n mc1 --excluded-ns ns1 ns2 --level Warn
```

- Creates a DeploymentSafeguards resource at Warn level with Pod Security Standards level set to Baseline
- Create a DeploymentSafeguards resource at Warn level with Pod Security Standards level set to Baseline
```bash
aks safeguards create --managed-cluster /subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1 --level Warn --pss-level Baseline
```

- Creates a DeploymentSafeguards resource with PSS level set to Restricted using -g/-n pattern
- Create a DeploymentSafeguards resource with PSS level set to Restricted using -g/-n pattern
```bash
aks safeguards create -g rg1 -n cluster1 --level Enforce --pss-level Restricted
```

### [2025-04-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-04-01.xml) **Stable**
### [2025-07-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-07-01.xml) **Stable**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-04-01 -->
<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-07-01 -->

#### examples

- Creates a DeploymentSafeguards resource at Warn level with a managed cluster resource id
- Create a DeploymentSafeguards resource at Warn level with a managed cluster resource id
```bash
aks safeguards create --resource /subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1 --level Warn
```

- Creates a DeploymentSafeguards resource at Warn level using subscription, resourcegroup, and name tags
- Create a DeploymentSafeguards resource at Warn level using subscription, resourcegroup, and name tags
```bash
aks safeguards create --subscription subid1 -g rg1 -n cluster1 --level Warn
```
Expand All @@ -55,3 +76,13 @@ Enable Deployment Safeguards for a Managed Cluster
```bash
aks safeguards create -g rg1 -n mc1 --excluded-ns ns1 ns2 --level Warn
```

- Create a DeploymentSafeguards resource at Warn level with Pod Security Standards level set to Baseline
```bash
aks safeguards create --managed-cluster /subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1 --level Warn --pss-level Baseline
```

- Create a DeploymentSafeguards resource with PSS level set to Restricted using -g/-n pattern
```bash
aks safeguards create -g rg1 -n cluster1 --level Enforce --pss-level Restricted
```
24 changes: 20 additions & 4 deletions Commands/aks/safeguards/_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Disable Deployment Safeguards for a Managed Cluster

## Versions

### [2025-05-02-preview](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-05-02-preview.xml) **Preview**
### [2025-04-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-04-01.xml) **Stable**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-05-02-preview -->
<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-04-01 -->

#### examples

Expand All @@ -20,9 +20,9 @@ Disable Deployment Safeguards for a Managed Cluster
aks safeguards delete -g rg1 -n cluster1
```

### [2025-04-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-04-01.xml) **Stable**
### [2025-05-02-preview](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-05-02-preview.xml) **Preview**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-04-01 -->
<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-05-02-preview -->

#### examples

Expand All @@ -35,3 +35,19 @@ Disable Deployment Safeguards for a Managed Cluster
```bash
aks safeguards delete -g rg1 -n cluster1
```

### [2025-07-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-07-01.xml) **Stable**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-07-01 -->

#### examples

- Delete a DeploymentSafeguard resource by managed cluster id
```bash
aks safeguards delete -c subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1
```

- Delete a DeploymentSafeguard resource with resourceGroup and clusterName arguments
```bash
aks safeguards delete -g rg1 -n cluster1
```
20 changes: 18 additions & 2 deletions Commands/aks/safeguards/_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@ List DeploymentSafeguards by parent resource

## Versions

### [2025-04-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRz/2025-04-01.xml) **Stable**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards 2025-04-01 -->

#### examples

- List DeploymentSafeguards by parent resource
```bash
aks safeguards list --managed-cluster subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1
```

- List DeploymentSafeguards by parent resource
```bash
aks safeguards list -g rg1 -n cluster1
```

### [2025-05-02-preview](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRz/2025-05-02-preview.xml) **Preview**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards 2025-05-02-preview -->
Expand All @@ -20,9 +36,9 @@ List DeploymentSafeguards by parent resource
aks safeguards list -g rg1 -n cluster1
```

### [2025-04-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRz/2025-04-01.xml) **Stable**
### [2025-07-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRz/2025-07-01.xml) **Stable**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards 2025-04-01 -->
<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards 2025-07-01 -->

#### examples

Expand Down
24 changes: 20 additions & 4 deletions Commands/aks/safeguards/_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Show Deployment Safeguards Configuration for a Managed Cluster

## Versions

### [2025-05-02-preview](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-05-02-preview.xml) **Preview**
### [2025-04-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-04-01.xml) **Stable**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-05-02-preview -->
<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-04-01 -->

#### examples

Expand All @@ -20,9 +20,9 @@ Show Deployment Safeguards Configuration for a Managed Cluster
aks safeguards show -g rg1 -n cluster1
```

### [2025-04-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-04-01.xml) **Stable**
### [2025-05-02-preview](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-05-02-preview.xml) **Preview**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-04-01 -->
<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-05-02-preview -->

#### examples

Expand All @@ -35,3 +35,19 @@ Show Deployment Safeguards Configuration for a Managed Cluster
```bash
aks safeguards show -g rg1 -n cluster1
```

### [2025-07-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-07-01.xml) **Stable**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-07-01 -->

#### examples

- Get a DeploymentSafeguard resource by managed cluster id
```bash
aks safeguards show --managed-cluster subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1
```

- Get a DeploymentSafeguard resource with resourceGroup and clusterName arguments
```bash
aks safeguards show -g rg1 -n cluster1
```
40 changes: 38 additions & 2 deletions Commands/aks/safeguards/_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,27 @@ Update Deployment Safeguards configuration for a Managed Cluster

## Versions

### [2025-04-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-04-01.xml) **Stable**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-04-01 -->

#### examples

- Update a DeploymentSafeguards resource by cluster id to Enforce level
```bash
aks safeguards update -c /subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/mc1 --level Enforce
```

- Update a DeploymentSafeguards resource to Enforce level using resourceGroup and name arguments
```bash
aks safeguards update --level Enforce -g rg1 -n mc1
```

- Update a DeploymentSafeguards resource by adding 2 new namespaces to ignore
```bash
aks safeguards update -g rg1 -n mc1 --excluded-ns ns1 ns2
```

### [2025-05-02-preview](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-05-02-preview.xml) **Preview**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-05-02-preview -->
Expand Down Expand Up @@ -40,9 +61,9 @@ Update Deployment Safeguards configuration for a Managed Cluster
aks safeguards update -g rg1 -n cluster1 --level Enforce --pss-level Restricted
```

### [2025-04-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-04-01.xml) **Stable**
### [2025-07-01](/Resources/mgmt-plane/L3tyZXNvdXJjZXVyaX0vcHJvdmlkZXJzL21pY3Jvc29mdC5jb250YWluZXJzZXJ2aWNlL2RlcGxveW1lbnRzYWZlZ3VhcmRzL2RlZmF1bHQ=/2025-07-01.xml) **Stable**

<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-04-01 -->
<!-- mgmt-plane /{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards/default 2025-07-01 -->

#### examples

Expand All @@ -60,3 +81,18 @@ Update Deployment Safeguards configuration for a Managed Cluster
```bash
aks safeguards update -g rg1 -n mc1 --excluded-ns ns1 ns2
```

- Update Pod Security Standards level to Restricted
```bash
aks safeguards update --managed-cluster /subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1 --pss-level Restricted
```

- Update PSS level to Baseline using -g/-n pattern
```bash
aks safeguards update -g rg1 -n cluster1 --pss-level Baseline
```

- Update both safeguards level and PSS level
```bash
aks safeguards update -g rg1 -n cluster1 --level Enforce --pss-level Restricted
```
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards", "version": "2025-07-01", "swagger": "mgmt-plane/containerservice/ResourceProviders/Microsoft.ContainerService/Paths/L3tyZXNvdXJjZVVyaX0vcHJvdmlkZXJzL01pY3Jvc29mdC5Db250YWluZXJTZXJ2aWNlL2RlcGxveW1lbnRTYWZlZ3VhcmRz/V/MjAyNS0wNy0wMQ=="}], "commandGroups": [{"name": "aks safeguards", "commands": [{"name": "list", "version": "2025-07-01", "resources": [{"id": "/{resourceuri}/providers/microsoft.containerservice/deploymentsafeguards", "version": "2025-07-01", "swagger": "mgmt-plane/containerservice/ResourceProviders/Microsoft.ContainerService/Paths/L3tyZXNvdXJjZVVyaX0vcHJvdmlkZXJzL01pY3Jvc29mdC5Db250YWluZXJTZXJ2aWNlL2RlcGxveW1lbnRTYWZlZ3VhcmRz/V/MjAyNS0wNy0wMQ=="}], "argGroups": [{"name": "", "args": [{"type": "string", "var": "$Path.resourceUri", "options": ["c", "cluster", "managed-cluster"], "required": true, "group": "", "help": {"short": "The fully qualified Azure Resource manager identifier of the Managed Cluster."}}]}], "operations": [{"operationId": "DeploymentSafeguards_List", "http": {"path": "/{resourceUri}/providers/Microsoft.ContainerService/deploymentSafeguards", "request": {"method": "get", "path": {"params": [{"type": "string", "name": "resourceUri", "arg": "$Path.resourceUri", "required": true}]}, "query": {"consts": [{"readOnly": true, "const": true, "default": {"value": "2025-07-01"}, "type": "string", "name": "api-version", "required": true, "format": {"minLength": 1}}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"type": "string", "name": "nextLink"}, {"type": "array<object>", "name": "value", "required": true, "item": {"type": "object", "props": [{"readOnly": true, "type": "string", "name": "eTag"}, {"readOnly": true, "type": "ResourceId", "name": "id"}, {"readOnly": true, "type": "string", "name": "name"}, {"type": "object", "name": "properties", "props": [{"type": "array<string>", "name": "excludedNamespaces", "item": {"type": "string"}}, {"type": "string", "name": "level", "required": true, "enum": {"items": [{"value": "Enforce"}, {"value": "Warn"}]}}, {"type": "string", "name": "podSecurityStandardsLevel", "enum": {"items": [{"value": "Baseline"}, {"value": "Privileged"}, {"value": "Restricted"}]}}, {"readOnly": true, "type": "string", "name": "provisioningState", "enum": {"items": [{"value": "Canceled"}, {"value": "Creating"}, {"value": "Deleting"}, {"value": "Failed"}, {"value": "Succeeded"}, {"value": "Updating"}]}}, {"readOnly": true, "type": "array<string>", "name": "systemExcludedNamespaces", "item": {"type": "string"}}]}, {"readOnly": true, "type": "object", "name": "systemData", "props": [{"type": "dateTime", "name": "createdAt"}, {"type": "string", "name": "createdBy"}, {"type": "string", "name": "createdByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}, {"type": "dateTime", "name": "lastModifiedAt"}, {"type": "string", "name": "lastModifiedBy"}, {"type": "string", "name": "lastModifiedByType", "enum": {"items": [{"value": "Application"}, {"value": "Key"}, {"value": "ManagedIdentity"}, {"value": "User"}]}}]}, {"readOnly": true, "type": "string", "name": "type"}]}}]}}}}, {"isError": true, "body": {"json": {"schema": {"readOnly": true, "type": "@MgmtErrorFormat"}}}}]}}], "outputs": [{"type": "array", "ref": "$Instance.value", "clientFlatten": true, "nextLink": "$Instance.nextLink"}], "confirmation": ""}]}]}
Loading