Skip to content

Replace "GuardrailsProfile" with "SafeguardsProfile", add ListSafeguardsVersions entities #26798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FumingZhang merged 7 commits into from
Dec 25, 2023
Merged

Replace "GuardrailsProfile" with "SafeguardsProfile", add ListSafeguardsVersions entities #26798

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1396730
Update readme.md
ahnj12 Oct 25, 2023
beff350
Merge branch 'FumingZhang-containerservice-Microsoft.ContainerService…
NickKeller Nov 21, 2023
c4329d5
Change guardrails to safeguards
NickKeller Nov 21, 2023
c58ff0d
clean up remaining references
NickKeller Nov 21, 2023
b09c302
fix casing
NickKeller Nov 21, 2023
bb5d250
Add back guardrailsVersions
NickKeller Nov 30, 2023
9972ae8
Fix typos
NickKeller Nov 30, 2023
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
4 changes: 2 additions & 2 deletions ...eview/examples/GetGuardrailsVersions.json → ...eview/examples/GetSafeguardsVersions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"responses": {
"200": {
"body": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/guardrailsVersions/v1.0.0",
"type": "Microsoft.ContainerService/locations/guardrailsVersions",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/safeguardsVersions/v1.0.0",
"type": "Microsoft.ContainerService/locations/safeguardsVersions",
"name": "v1.0.0",
"properties": {
"isDefaultVersion": true,
Expand Down
4 changes: 2 additions & 2 deletions ...view/examples/ListGuardrailsVersions.json → ...view/examples/ListSafeguardsVersions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
"body": {
"value": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/guardrailsVersions/v1.0.0",
"type": "Microsoft.ContainerService/locations/guardrailsVersions",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/safeguardsVersions/v1.0.0",
"type": "Microsoft.ContainerService/locations/safeguardsVersions",
"name": "v1.0.0",
"properties": {
"isDefaultVersion": true,
Expand Down
66 changes: 33 additions & 33 deletions ...ce-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/managedClusters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3379,14 +3379,14 @@
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/guardrailsVersions/{version}": {
"/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions/{version}": {
"get": {
"tags": [
"ManagedClusters"
],
"operationId": "ManagedClusters_GetGuardrailsVersions",
"summary": "Gets supported Guardrails version in the specified subscription and location.",
"description": "Contains Guardrails version along with its support info and whether it is a default version.",
"operationId": "ManagedClusters_GetSafeguardsVersions",
"summary": "Gets supported Safeguards version in the specified subscription and location.",
"description": "Contains Safeguards version along with its support info and whether it is a default version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
Expand All @@ -3405,7 +3405,7 @@
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/GuardrailsAvailableVersion"
"$ref": "#/definitions/SafeguardsAvailableVersion"
}
},
"default": {
Expand All @@ -3416,20 +3416,20 @@
}
},
"x-ms-examples": {
"Get guardrails available versions": {
"$ref": "./examples/GetGuardrailsVersions.json"
"Get Safeguards available versions": {
"$ref": "./examples/GetSafeguardsVersions.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/guardrailsVersions": {
"/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions": {
"get": {
"tags": [
"ManagedClusters"
],
"operationId": "ManagedClusters_ListGuardrailsVersions",
"summary": "Gets a list of supported Guardrails versions in the specified subscription and location.",
"description": "Contains list of Guardrails version along with its support info and whether it is a default version.",
"operationId": "ManagedClusters_ListSafeguardsVersions",
"summary": "Gets a list of supported Safeguards versions in the specified subscription and location.",
"description": "Contains list of Safeguards version along with its support info and whether it is a default version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
Expand All @@ -3445,7 +3445,7 @@
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/GuardrailsAvailableVersionsList"
"$ref": "#/definitions/SafeguardsAvailableVersionsList"
}
},
"default": {
Expand All @@ -3459,8 +3459,8 @@
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"List Guardrails Versions": {
"$ref": "./examples/ListGuardrailsVersions.json"
"List Safeguards Versions": {
"$ref": "./examples/ListSafeguardsVersions.json"
}
}
}
Expand Down Expand Up @@ -5726,9 +5726,9 @@
"azureMonitorProfile": {
"$ref": "#/definitions/ManagedClusterAzureMonitorProfile"
},
"guardrailsProfile": {
"$ref": "#/definitions/GuardrailsProfile",
"description": "The guardrails profile holds all the guardrails information for a given cluster"
"safeguardsProfile": {
"$ref": "#/definitions/SafeguardsProfile",
"description": "The Safeguards profile holds all the safeguards information for a given cluster"
},
"serviceMeshProfile": {
"$ref": "#/definitions/ServiceMeshProfile"
Expand Down Expand Up @@ -7478,7 +7478,7 @@
],
"description": "The OS option profile."
},
"GuardrailsAvailableVersionsProperties": {
"SafeguardsAvailableVersionsProperties": {
"type": "object",
"description": "Whether the version is default or not and support info.",
"properties": {
Expand All @@ -7493,7 +7493,7 @@
"Stable"
],
"x-ms-enum": {
"name": "GuardrailsSupport",
"name": "SafeguardsSupport",
"modelAsString": true,
"values": [
{
Expand All @@ -7511,37 +7511,37 @@
}
}
},
"GuardrailsAvailableVersion": {
"SafeguardsAvailableVersion": {
"type": "object",
"description": "Available Guardrails Version",
"description": "Available Safeguards Version",
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource"
}
],
"properties": {
"properties": {
"$ref": "#/definitions/GuardrailsAvailableVersionsProperties"
"$ref": "#/definitions/SafeguardsAvailableVersionsProperties"
}
},
"required": [
"properties"
]
},
"GuardrailsAvailableVersionsList": {
"SafeguardsAvailableVersionsList": {
"type": "object",
"description": "Hold values properties, which is array of GuardrailsVersions",
"description": "Hold values properties, which is array of SafeguardsVersions",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/GuardrailsAvailableVersion"
"$ref": "#/definitions/SafeguardsAvailableVersion"
},
"description": "Array of AKS supported Guardrails versions."
"description": "Array of AKS supported Safeguards versions."
},
"nextLink": {
"type": "string",
"description": "The URL to get the next Guardrails available version.",
"description": "The URL to get the next Safeguards available version.",
"readOnly": true
}
}
Expand Down Expand Up @@ -8554,13 +8554,13 @@
"enabled"
]
},
"GuardrailsProfile": {
"SafeguardsProfile": {
"type": "object",
"properties": {
"systemExcludedNamespaces": {
"readOnly": true,
"type": "array",
"description": "List of namespaces specified by AKS to be excluded from Guardrails",
"description": "List of namespaces specified by AKS to be excluded from Safeguards",
"items": {
"type": "string"
}
Expand All @@ -8580,10 +8580,10 @@
"name": "level",
"modelAsString": true
},
"description": "The guardrails level to be used. By default, Guardrails is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces"
"description": "The Safeguards level to be used. By default, Safeguards is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces"
},
"excludedNamespaces": {
"description": "List of namespaces excluded from guardrails checks",
"description": "List of namespaces excluded from Safeguards checks",
"type": "array",
"items": {
"type": "string"
Expand All @@ -8593,7 +8593,7 @@
"required": [
"level"
],
"description": "The Guardrails profile."
"description": "The Safeguards profile."
},
"ServiceMeshProfile": {
"type": "object",
Expand Down Expand Up @@ -9269,7 +9269,7 @@
"type": "string",
"minLength": 1,
"maxLength": 24,
"description": "Guardrails version",
"description": "Safeguards version",
"x-ms-parameter-location": "method"
}
}
Expand Down