Skip to content

Commit 0207d12

Browse files
NickKellerahnj12
NickKeller
and
ahnj12
authored
Replace "GuardrailsProfile" with "SafeguardsProfile", add ListSafeguardsVersions entities (#26798)
* Update readme.md Reverting global tag to stable GA version for SDK release * Change guardrails to safeguards * clean up remaining references * fix casing * Add back guardrailsVersions * Fix typos --------- Co-authored-by: Jooneil Ahn <[email protected]>
1 parent 430ce44 commit 0207d12

File tree

3 files changed

+208
-9
lines changed

3 files changed

+208
-9
lines changed

‎specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/GetSafeguardsVersions.json

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-11-02-preview",
4+
"subscriptionId": "00000000-0000-0000-0000-000000000000",
5+
"location": "location1",
6+
"version": "v1.0.0"
7+
},
8+
"responses": {
9+
"200": {
10+
"body": {
11+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/safeguardsVersions/v1.0.0",
12+
"type": "Microsoft.ContainerService/locations/safeguardsVersions",
13+
"name": "v1.0.0",
14+
"properties": {
15+
"isDefaultVersion": true,
16+
"support": "Preview"
17+
}
18+
}
19+
}
20+
}
21+
}

‎specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ListSafeguardsVersions.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-11-02-preview",
4+
"subscriptionId": "00000000-0000-0000-0000-000000000000",
5+
"location": "location1"
6+
},
7+
"responses": {
8+
"200": {
9+
"body": {
10+
"value": [
11+
{
12+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/safeguardsVersions/v1.0.0",
13+
"type": "Microsoft.ContainerService/locations/safeguardsVersions",
14+
"name": "v1.0.0",
15+
"properties": {
16+
"isDefaultVersion": true,
17+
"support": "Preview"
18+
}
19+
}
20+
]
21+
}
22+
}
23+
}
24+
}

‎specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/managedClusters.json

Lines changed: 163 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3465,6 +3465,92 @@
34653465
}
34663466
}
34673467
},
3468+
"/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions/{version}": {
3469+
"get": {
3470+
"tags": [
3471+
"ManagedClusters"
3472+
],
3473+
"operationId": "ManagedClusters_GetSafeguardsVersions",
3474+
"summary": "Gets supported Safeguards version in the specified subscription and location.",
3475+
"description": "Contains Safeguards version along with its support info and whether it is a default version.",
3476+
"parameters": [
3477+
{
3478+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
3479+
},
3480+
{
3481+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
3482+
},
3483+
{
3484+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter"
3485+
},
3486+
{
3487+
"$ref": "#/parameters/VersionParameter"
3488+
}
3489+
],
3490+
"responses": {
3491+
"200": {
3492+
"description": "OK",
3493+
"schema": {
3494+
"$ref": "#/definitions/SafeguardsAvailableVersion"
3495+
}
3496+
},
3497+
"default": {
3498+
"description": "Error response describing why the operation failed",
3499+
"schema": {
3500+
"$ref": "#/definitions/CloudError"
3501+
}
3502+
}
3503+
},
3504+
"x-ms-examples": {
3505+
"Get Safeguards available versions": {
3506+
"$ref": "./examples/GetSafeguardsVersions.json"
3507+
}
3508+
}
3509+
}
3510+
},
3511+
"/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions": {
3512+
"get": {
3513+
"tags": [
3514+
"ManagedClusters"
3515+
],
3516+
"operationId": "ManagedClusters_ListSafeguardsVersions",
3517+
"summary": "Gets a list of supported Safeguards versions in the specified subscription and location.",
3518+
"description": "Contains list of Safeguards version along with its support info and whether it is a default version.",
3519+
"parameters": [
3520+
{
3521+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
3522+
},
3523+
{
3524+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
3525+
},
3526+
{
3527+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter"
3528+
}
3529+
],
3530+
"responses": {
3531+
"200": {
3532+
"description": "OK",
3533+
"schema": {
3534+
"$ref": "#/definitions/SafeguardsAvailableVersionsList"
3535+
}
3536+
},
3537+
"default": {
3538+
"description": "Error response describing why the operation failed.",
3539+
"schema": {
3540+
"$ref": "#/definitions/CloudError"
3541+
}
3542+
}
3543+
},
3544+
"x-ms-pageable": {
3545+
"nextLinkName": "nextLink"
3546+
},
3547+
"x-ms-examples": {
3548+
"List Safeguards Versions": {
3549+
"$ref": "./examples/ListSafeguardsVersions.json"
3550+
}
3551+
}
3552+
}
3553+
},
34683554
"/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles": {
34693555
"get": {
34703556
"tags": [
@@ -5726,9 +5812,9 @@
57265812
"azureMonitorProfile": {
57275813
"$ref": "#/definitions/ManagedClusterAzureMonitorProfile"
57285814
},
5729-
"guardrailsProfile": {
5730-
"$ref": "#/definitions/GuardrailsProfile",
5731-
"description": "The guardrails profile holds all the guardrails information for a given cluster"
5815+
"safeguardsProfile": {
5816+
"$ref": "#/definitions/SafeguardsProfile",
5817+
"description": "The Safeguards profile holds all the safeguards information for a given cluster"
57325818
},
57335819
"serviceMeshProfile": {
57345820
"$ref": "#/definitions/ServiceMeshProfile"
@@ -7554,6 +7640,74 @@
75547640
}
75557641
}
75567642
},
7643+
"SafeguardsAvailableVersionsProperties": {
7644+
"type": "object",
7645+
"description": "Whether the version is default or not and support info.",
7646+
"properties": {
7647+
"isDefaultVersion": {
7648+
"type": "boolean",
7649+
"readOnly": true
7650+
},
7651+
"support": {
7652+
"type": "string",
7653+
"enum": [
7654+
"Preview",
7655+
"Stable"
7656+
],
7657+
"x-ms-enum": {
7658+
"name": "SafeguardsSupport",
7659+
"modelAsString": true,
7660+
"values": [
7661+
{
7662+
"value": "Preview",
7663+
"description": "The version is preview. It is not recommended to use preview versions on critical production clusters. The preview version may not support all use-cases."
7664+
},
7665+
{
7666+
"value": "Stable",
7667+
"description": "The version is stable and can be used on critical production clusters."
7668+
}
7669+
]
7670+
},
7671+
"description": "Whether the version is preview or stable.",
7672+
"readOnly": true
7673+
}
7674+
}
7675+
},
7676+
"SafeguardsAvailableVersion": {
7677+
"type": "object",
7678+
"description": "Available Safeguards Version",
7679+
"allOf": [
7680+
{
7681+
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource"
7682+
}
7683+
],
7684+
"properties": {
7685+
"properties": {
7686+
"$ref": "#/definitions/SafeguardsAvailableVersionsProperties"
7687+
}
7688+
},
7689+
"required": [
7690+
"properties"
7691+
]
7692+
},
7693+
"SafeguardsAvailableVersionsList": {
7694+
"type": "object",
7695+
"description": "Hold values properties, which is array of SafeguardsVersions",
7696+
"properties": {
7697+
"value": {
7698+
"type": "array",
7699+
"items": {
7700+
"$ref": "#/definitions/SafeguardsAvailableVersion"
7701+
},
7702+
"description": "Array of AKS supported Safeguards versions."
7703+
},
7704+
"nextLink": {
7705+
"type": "string",
7706+
"description": "The URL to get the next Safeguards available version.",
7707+
"readOnly": true
7708+
}
7709+
}
7710+
},
75577711
"EndpointDependency": {
75587712
"description": "A domain name that AKS agent nodes are reaching at.",
75597713
"type": "object",
@@ -8562,13 +8716,13 @@
85628716
"enabled"
85638717
]
85648718
},
8565-
"GuardrailsProfile": {
8719+
"SafeguardsProfile": {
85668720
"type": "object",
85678721
"properties": {
85688722
"systemExcludedNamespaces": {
85698723
"readOnly": true,
85708724
"type": "array",
8571-
"description": "List of namespaces specified by AKS to be excluded from Guardrails",
8725+
"description": "List of namespaces specified by AKS to be excluded from Safeguards",
85728726
"items": {
85738727
"type": "string"
85748728
}
@@ -8588,10 +8742,10 @@
85888742
"name": "level",
85898743
"modelAsString": true
85908744
},
8591-
"description": "The guardrails level to be used. By default, Guardrails is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces"
8745+
"description": "The Safeguards level to be used. By default, Safeguards is enabled for all namespaces except those that AKS excludes via systemExcludedNamespaces"
85928746
},
85938747
"excludedNamespaces": {
8594-
"description": "List of namespaces excluded from guardrails checks",
8748+
"description": "List of namespaces excluded from Safeguards checks",
85958749
"type": "array",
85968750
"items": {
85978751
"type": "string"
@@ -8601,7 +8755,7 @@
86018755
"required": [
86028756
"level"
86038757
],
8604-
"description": "The Guardrails profile."
8758+
"description": "The Safeguards profile."
86058759
},
86068760
"ServiceMeshProfile": {
86078761
"type": "object",
@@ -9277,7 +9431,7 @@
92779431
"type": "string",
92789432
"minLength": 1,
92799433
"maxLength": 24,
9280-
"description": "Guardrails version",
9434+
"description": "Safeguards version",
92819435
"x-ms-parameter-location": "method"
92829436
}
92839437
}

0 commit comments

Comments
 (0)