Skip to content
3 changes: 2 additions & 1 deletion custom-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2719,4 +2719,5 @@ xlargerc
largerc
mediumrc
smallrc
Autotune
Autotune
guardrailsversions
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"parameters": {
"api-version": "2022-08-02-preview",
"subscriptionId": "subid1",
"resourceGroupName": "rg1",
"resourceName": "clustername1"
},
"responses": {
"200": {
"body": {
"version": "v1",
"isPreview": true,
"default": true,
"data": [
{
"isPreview": false,
"version": "v2"
}
]
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2891,6 +2891,48 @@
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/guardrailsversions": {
"get": {
"tags": [
"guardrailsVersions"
],
"operationId": "GuardrailsVersions_List",
"summary": "List available guardrails versions.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ResourceNameParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ListGuardrailsVersionsResponse"
}
},
"default": {
"description": "Error details",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"List Guardrails versions": {
"$ref": "./examples/GuardrailsVersions_List.json"
}
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -6979,6 +7021,91 @@
"required": [
"enabled"
]
},
"GuardrailsProfile": {
"type": "object",
"properties": {
"systemExcludedNamespaces": {
"readOnly": true,
"type": "array",
"description": "List of namespaces specified by AKS to be excluded from Guardrails",
"items": {
"type": "string"
}
},
"version": {
"type": "string",
"description": "The version of constraints to use"
},
"level": {
"type": "string",
"enum": [
"Off",
"Warning",
"Enforcement"
],
"x-ms-enum": {
"name": "level",
"modelAsString": true
},
"description": "The guardrails level to be used"
},
"includedNamespaces": {
"description": "Customer-specified list of namespaces that must be included in guardrails",
"type": "array",
"items": {
"type": "string"
}
},
"excludedNamespaces": {
"description": "Customer-specified list of namespaces that must be excluded from guardrails",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"level",
"version"
],
"description": "The Guardrails profile."
},
"ListGuardrailsVersionsResponse": {
"type": "object",
"properties": {
"version": {
"readOnly": true,
"type": "string"
},
"isPreview": {
"type": "boolean",
"description": "Describes whether this version is in preview"
},
"default": {
"type": "boolean",
"description": "Describes whether this version is default"
},
"data": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From CI, missing identifier for this array.

May add"x-ms-identifiers": [], to bypass the check.

"type": "array",
"items": {
"$ref": "#/definitions/GuardrailsVersionUpgradeList"
}
}
}
},
"GuardrailsVersionUpgradeList": {
"type": "object",
"properties": {
"isPreview": {
"type": "boolean",
"description": "Describes whether this version is in preview"
},
"version": {
"type": "string",
"description": "The guardrails version identifier"
}
}
}
},
"parameters": {
Expand Down