diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ScheduledEventsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ScheduledEventsGet.json new file mode 100644 index 000000000000..a291893522d1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/examples/ScheduledEventsGet.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-11-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "scheduledEventName": "event1" + }, + "responses": { + "200": { + "body": { + "eventId": "event1" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/scheduledEvents.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/scheduledEvents.json new file mode 100644 index 000000000000..25a74071123b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2023-11-02-preview/scheduledEvents.json @@ -0,0 +1,175 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2023-11-02-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/scheduledEvents/{scheduledEventName}": { + "get": { + "tags": [ + "ScheduledEvents" + ], + "operationId": "ScheduledEvents_Get", + "summary": "Access to this resource type is not currently available via GET. To consume please use System Topics or Azure Resource Graph.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./managedClusters.json#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ScheduledEventNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ScheduledEvent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./managedClusters.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Scheduled Event": { + "$ref": "./examples/ScheduledEventsGet.json" + } + } + } + } + }, + "definitions": { + "ScheduledEvent": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of a scheduled event." + }, + "eventId": { + "type": "string", + "description": "The event id of a scheduled event." + }, + "eventSource": { + "type": "string", + "description": "The source of a scheduled event." + }, + "eventStatus": { + "type": "string", + "enum": [ + "Scheduled", + "Started", + "Completed", + "Cancelled", + "Failed" + ], + "x-ms-enum": { + "name": "eventStatus", + "modelAsString": true + }, + "description": "The status of a scheduled event." + }, + "scheduledTime": { + "type": "string", + "format": "date-time", + "description": "The time of a scheduled event." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time of a scheduled event starts." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The time of a scheduled event last updates." + }, + "resources": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ContainerService/managedClusters" + }, + { + "type": "Microsoft.ContainerService/managedClusters/agentPools" + } + ] + } + }, + "description": "The list of resources of a scheduled event." + }, + "resourceType": { + "type": "string", + "enum": [ + "ManagedCluster", + "AgentPool" + ], + "x-ms-enum": { + "name": "resourceType", + "modelAsString": true + }, + "description": "The resource type of a scheduled event." + } + } + } + }, + "parameters": { + "ScheduledEventNameParameter": { + "name": "scheduledEventName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the scheduled event.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md index 6a3886234103..d099b96aaa9a 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md @@ -45,6 +45,7 @@ These settings apply only when `--tag=package-preview-2023-11` is specified on t ```yaml $(tag) == 'package-preview-2023-11' input-file: - preview/2023-11-02-preview/managedClusters.json + - preview/2023-11-02-preview/scheduledEvents.json ``` ### Tag: package-2023-10