From ec8b6e1d4cd75b086721cade6b5ab0daf1bb9063 Mon Sep 17 00:00:00 2001 From: Priyanshi Jain <87351063+priyjain358@users.noreply.github.com> Date: Fri, 24 Mar 2023 10:25:34 +0530 Subject: [PATCH] [Hub Generated] Review request for Microsoft.AzureStackHCI to add version stable/2023-03-01 (#23255) * Adds base for updating Microsoft.AzureStackHCI from version stable/2023-02-01 to version 2023-03-01 * Updates readme * Updates API version in new specs and examples * Consent and Disable APIs added * add managed by for extensions * prettier fix --- .../stable/2023-03-01/arcSettings.json | 778 ++++++++++++++ .../stable/2023-03-01/clusters.json | 992 ++++++++++++++++++ .../ConsentAndInstallDefaultExtensions.json | 51 + .../examples/CreateArcIdentity.json | 26 + .../2023-03-01/examples/CreateCluster.json | 59 ++ .../examples/CreateClusterIdentity.json | 25 + .../2023-03-01/examples/DeleteArcSetting.json | 18 + .../2023-03-01/examples/DeleteCluster.json | 17 + .../2023-03-01/examples/DeleteExtension.json | 19 + .../2023-03-01/examples/DeleteUpdateRuns.json | 19 + .../examples/DeleteUpdateSummaries.json | 17 + .../2023-03-01/examples/DeleteUpdates.json | 18 + .../ExtendSoftwareAssuranceBenefit.json | 82 ++ .../examples/Extensions_Upgrade.json | 22 + .../2023-03-01/examples/GeneratePassword.json | 19 + .../2023-03-01/examples/GetArcSetting.json | 55 + .../2023-03-01/examples/GetCluster.json | 93 ++ .../2023-03-01/examples/GetExtension.json | 80 ++ .../stable/2023-03-01/examples/GetOffer.json | 34 + .../2023-03-01/examples/GetPublisher.json | 18 + .../stable/2023-03-01/examples/GetSku.json | 36 + .../2023-03-01/examples/GetUpdateRuns.json | 43 + .../examples/GetUpdateSummaries.json | 41 + .../2023-03-01/examples/GetUpdates.json | 44 + .../examples/InitializeDisableProcess.json | 19 + .../examples/ListArcSettingsByCluster.json | 58 + .../examples/ListClustersByResourceGroup.json | 123 +++ .../examples/ListClustersBySubscription.json | 122 +++ .../examples/ListExtensionsByArcSetting.json | 95 ++ .../examples/ListOffersByCluster.json | 36 + .../examples/ListOffersByPublisher.json | 37 + .../2023-03-01/examples/ListOperations.json | 453 ++++++++ .../examples/ListPublishersByCluster.json | 21 + .../2023-03-01/examples/ListSkusByOffer.json | 39 + .../2023-03-01/examples/ListUpdateRuns.json | 46 + .../examples/ListUpdateSummaries.json | 45 + .../2023-03-01/examples/ListUpdates.json | 47 + .../2023-03-01/examples/PatchArcSetting.json | 62 ++ .../2023-03-01/examples/PatchExtension.json | 97 ++ .../2023-03-01/examples/PostUpdates.json | 17 + .../2023-03-01/examples/PutArcSetting.json | 52 + .../2023-03-01/examples/PutExtension.json | 164 +++ .../2023-03-01/examples/PutUpdateRuns.json | 68 ++ .../examples/PutUpdateSummaries.json | 52 + .../2023-03-01/examples/PutUpdates.json | 71 ++ .../2023-03-01/examples/UpdateCluster.json | 117 +++ .../examples/UploadCertificate.json | 23 + .../stable/2023-03-01/extensions.json | 663 ++++++++++++ .../stable/2023-03-01/offers.json | 302 ++++++ .../stable/2023-03-01/operations.json | 73 ++ .../stable/2023-03-01/publishers.json | 188 ++++ .../stable/2023-03-01/skus.json | 275 +++++ .../stable/2023-03-01/updateRuns.json | 408 +++++++ .../stable/2023-03-01/updateSummaries.json | 482 +++++++++ .../stable/2023-03-01/updates.json | 654 ++++++++++++ .../azurestackhci/resource-manager/readme.md | 22 +- 56 files changed, 7535 insertions(+), 2 deletions(-) create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/arcSettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/clusters.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ConsentAndInstallDefaultExtensions.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/CreateArcIdentity.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/CreateCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/CreateClusterIdentity.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteExtension.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteUpdateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteUpdateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ExtendSoftwareAssuranceBenefit.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/Extensions_Upgrade.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GeneratePassword.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetExtension.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetOffer.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetPublisher.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetSku.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetUpdateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetUpdateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/InitializeDisableProcess.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListArcSettingsByCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListClustersByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListClustersBySubscription.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListExtensionsByArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListOffersByCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListOffersByPublisher.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListOperations.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListPublishersByCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListSkusByOffer.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListUpdateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListUpdateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PatchArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PatchExtension.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PostUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutExtension.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutUpdateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutUpdateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/UpdateCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/UploadCertificate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/extensions.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/offers.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/operations.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/publishers.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/skus.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/updateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/updateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/updates.json diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/arcSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/arcSettings.json new file mode 100644 index 000000000000..e468e7e07aa2 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/arcSettings.json @@ -0,0 +1,778 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-03-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/arcSettings": { + "get": { + "operationId": "ArcSettings_ListByCluster", + "description": "Get ArcSetting resources of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List ArcSetting resources by HCI Cluster": { + "$ref": "./examples/ListArcSettingsByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}": { + "get": { + "operationId": "ArcSettings_Get", + "description": "Get ArcSetting resource details of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ArcSetting": { + "$ref": "./examples/GetArcSetting.json" + } + } + }, + "put": { + "operationId": "ArcSettings_Create", + "description": "Create ArcSetting for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "name": "arcSetting", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArcSetting" + }, + "description": "Parameters supplied to the Create ArcSetting resource for this HCI cluster." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create ArcSetting": { + "$ref": "./examples/PutArcSetting.json" + } + } + }, + "patch": { + "operationId": "ArcSettings_Update", + "description": "Update ArcSettings for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "name": "arcSetting", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArcSettingsPatch" + }, + "description": "ArcSettings parameters that needs to be updated" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch ArcSetting": { + "$ref": "./examples/PatchArcSetting.json" + } + } + }, + "delete": { + "operationId": "ArcSettings_Delete", + "description": "Delete ArcSetting resource details of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete ArcSetting": { + "$ref": "./examples/DeleteArcSetting.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/generatePassword": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_GeneratePassword", + "description": "Generate password for arc settings.", + "x-ms-examples": { + "Generate Password": { + "$ref": "./examples/GeneratePassword.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PasswordCredential" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/createArcIdentity": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_CreateIdentity", + "description": "Create Aad identity for arc settings.", + "x-ms-examples": { + "Create Arc Identity": { + "$ref": "./examples/CreateArcIdentity.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcIdentityResponse" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/consentAndInstallDefaultExtensions": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_ConsentAndInstallDefaultExtensions", + "description": "Add consent time for default extensions and initiate extensions installation", + "x-ms-examples": { + "Consent And Install Default Extensions": { + "$ref": "./examples/ConsentAndInstallDefaultExtensions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/initializeDisableProcess": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_InitializeDisableProcess", + "description": "Initializes ARC Disable process on the cluster", + "x-ms-examples": { + "Trigger ARC Disable": { + "$ref": "./examples/InitializeDisableProcess.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "ArcSettingList": { + "description": "List of ArcSetting proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of ArcSetting proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ArcSetting" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ArcSettingsPatch": { + "description": "ArcSetting details to update.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "ArcSettings properties.", + "$ref": "#/definitions/ArcSettingsPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ArcSettingsPatchProperties": { + "description": "ArcSettings properties.", + "type": "object", + "properties": { + "connectivityProperties": { + "description": "contains connectivity related configuration for ARC resources", + "type": "object", + "items": { + "$ref": "#/definitions/ArcConnectivityProperties" + } + } + } + }, + "ArcSetting": { + "description": "ArcSetting details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "ArcSetting properties.", + "$ref": "#/definitions/ArcSettingProperties", + "x-ms-client-flatten": true + } + } + }, + "ArcSettingProperties": { + "description": "ArcSetting properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the ArcSetting proxy resource.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Failed", + "Canceled", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "DisableInProgress" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "arcInstanceResourceGroup": { + "description": "The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.", + "type": "string" + }, + "arcApplicationClientId": { + "description": "App id of arc AAD identity.", + "type": "string" + }, + "arcApplicationTenantId": { + "description": "Tenant id of arc AAD identity.", + "type": "string" + }, + "arcServicePrincipalObjectId": { + "description": "Object id of arc AAD service principal.", + "type": "string" + }, + "arcApplicationObjectId": { + "description": "Object id of arc AAD identity.", + "type": "string" + }, + "aggregateState": { + "description": "Aggregate state of Arc agent across the nodes in this HCI cluster.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "DisableInProgress" + ], + "x-ms-enum": { + "name": "ArcSettingAggregateState", + "modelAsString": true + }, + "readOnly": true + }, + "perNodeDetails": { + "description": "State of Arc agent in each of the nodes.", + "type": "array", + "items": { + "$ref": "#/definitions/PerNodeState" + }, + "readOnly": true + }, + "connectivityProperties": { + "description": "contains connectivity related configuration for ARC resources", + "type": "object", + "items": { + "$ref": "#/definitions/ArcConnectivityProperties" + } + }, + "defaultExtensions": { + "description": "Properties for each of the default extensions category", + "type": "array", + "items": { + "$ref": "#/definitions/DefaultExtensionDetails" + }, + "x-ms-identifiers": [ + "category" + ], + "readOnly": true + } + } + }, + "PerNodeState": { + "description": "Status of Arc agent for a particular node in HCI Cluster.", + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the Node in HCI Cluster" + }, + "arcInstance": { + "description": "Fully qualified resource ID for the Arc agent of this node.", + "type": "string", + "readOnly": true + }, + "state": { + "description": "State of Arc agent in this node.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "DisableInProgress" + ], + "x-ms-enum": { + "name": "NodeArcState", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "DefaultExtensionDetails": { + "description": "Properties for a particular default extension category.", + "type": "object", + "properties": { + "category": { + "description": "Default extension category", + "type": "string", + "readOnly": true + }, + "consentTime": { + "description": "Consent time for extension category", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "ArcConnectivityProperties": { + "description": "Connectivity related configuration required by arc server.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "True indicates ARC connectivity is enabled" + } + }, + "additionalProperties": false + }, + "PasswordCredential": { + "type": "object", + "properties": { + "secretText": { + "type": "string" + }, + "keyId": { + "type": "string" + }, + "startDateTime": { + "type": "string", + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false, + "readOnly": true + }, + "ArcIdentityResponse": { + "description": "ArcIdentity details.", + "type": "object", + "properties": { + "properties": { + "description": "ArcIdentity properties.", + "$ref": "#/definitions/ArcIdentityResponseProperties", + "x-ms-client-flatten": true + } + } + }, + "ArcIdentityResponseProperties": { + "type": "object", + "properties": { + "arcApplicationClientId": { + "type": "string" + }, + "arcApplicationTenantId": { + "type": "string" + }, + "arcServicePrincipalObjectId": { + "type": "string" + }, + "arcApplicationObjectId": { + "type": "string" + } + }, + "additionalProperties": false, + "readOnly": true + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ArcSettingNameParameter": { + "name": "arcSettingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proxy resource holding details of HCI ArcSetting information.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/clusters.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/clusters.json new file mode 100644 index 000000000000..27a9abe0d7e4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/clusters.json @@ -0,0 +1,992 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-03-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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}/providers/Microsoft.AzureStackHCI/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListBySubscription", + "x-ms-examples": { + "List clusters in a given subscription": { + "$ref": "./examples/ListClustersBySubscription.json" + } + }, + "description": "List all HCI clusters in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListByResourceGroup", + "x-ms-examples": { + "List clusters in a given resource group": { + "$ref": "./examples/ListClustersByResourceGroup.json" + } + }, + "description": "List all HCI clusters in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Get", + "x-ms-examples": { + "Get cluster": { + "$ref": "./examples/GetCluster.json" + } + }, + "description": "Get HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Create", + "x-ms-examples": { + "Create cluster": { + "$ref": "./examples/CreateCluster.json" + } + }, + "description": "Create an HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "cluster", + "in": "body", + "description": "Details of the HCI cluster.", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Update", + "x-ms-examples": { + "Update cluster": { + "$ref": "./examples/UpdateCluster.json" + } + }, + "description": "Update an HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "cluster", + "in": "body", + "description": "Details of the HCI cluster.", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Delete", + "x-ms-examples": { + "Delete cluster": { + "$ref": "./examples/DeleteCluster.json" + } + }, + "description": "Delete an HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/uploadCertificate": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_UploadCertificate", + "x-ms-examples": { + "Upload certificate": { + "$ref": "./examples/UploadCertificate.json" + } + }, + "description": "Upload certificate.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "uploadCertificateRequest", + "in": "body", + "description": "Upload certificate request.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadCertificateRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/createClusterIdentity": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_CreateIdentity", + "description": "Create cluster identity.", + "x-ms-examples": { + "Create cluster Identity": { + "$ref": "./examples/CreateClusterIdentity.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterIdentityResponse" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/extendSoftwareAssuranceBenefit": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_ExtendSoftwareAssuranceBenefit", + "description": "Extends Software Assurance Benefit to a cluster", + "x-ms-examples": { + "Create cluster Identity": { + "$ref": "./examples/ExtendSoftwareAssuranceBenefit.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "softwareAssuranceChangeRequest", + "in": "body", + "description": "Software Assurance Change Request Payload", + "required": true, + "schema": { + "$ref": "#/definitions/SoftwareAssuranceChangeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "ClusterList": { + "description": "List of clusters.", + "type": "object", + "properties": { + "value": { + "description": "List of clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Cluster": { + "description": "Cluster details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Identity of Cluster resource", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Cluster properties.", + "$ref": "#/definitions/ClusterProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterPatch": { + "description": "Cluster details to update.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "description": "Identity of Cluster resource", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Cluster properties.", + "$ref": "#/definitions/ClusterPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterProperties": { + "description": "Cluster properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning", + "NotSpecified", + "Creating", + "Updating", + "Deleting", + "Moving", + "Deleted", + "PartiallySucceeded", + "InProgress", + "DisableInProgress", + "Connected", + "PartiallyConnected", + "Disconnected" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "status": { + "description": "Status of the cluster agent.", + "type": "string", + "enum": [ + "NotYetRegistered", + "ConnectedRecently", + "NotConnectedRecently", + "Disconnected", + "Error", + "NotSpecified" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + }, + "readOnly": true + }, + "cloudId": { + "description": "Unique, immutable resource id.", + "type": "string", + "readOnly": true + }, + "cloudManagementEndpoint": { + "description": "Endpoint configured for management from the Azure portal.", + "type": "string" + }, + "aadClientId": { + "description": "App id of cluster AAD identity.", + "type": "string" + }, + "aadTenantId": { + "description": "Tenant id of cluster AAD identity.", + "type": "string" + }, + "aadApplicationObjectId": { + "description": "Object id of cluster AAD identity.", + "type": "string" + }, + "aadServicePrincipalObjectId": { + "description": "Id of cluster identity service principal.", + "type": "string" + }, + "softwareAssuranceProperties": { + "description": "Software Assurance properties of the cluster.", + "$ref": "#/definitions/SoftwareAssuranceProperties" + }, + "desiredProperties": { + "description": "Desired properties of the cluster.", + "$ref": "#/definitions/ClusterDesiredProperties" + }, + "reportedProperties": { + "description": "Properties reported by cluster agent.", + "$ref": "#/definitions/ClusterReportedProperties", + "readOnly": true + }, + "trialDaysRemaining": { + "description": "Number of days remaining in the trial period.", + "type": "number", + "readOnly": true + }, + "billingModel": { + "description": "Type of billing applied to the resource.", + "type": "string", + "readOnly": true + }, + "registrationTimestamp": { + "description": "First cluster sync timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastSyncTimestamp": { + "description": "Most recent cluster sync timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastBillingTimestamp": { + "description": "Most recent billing meter timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "serviceEndpoint": { + "description": "Region specific DataPath Endpoint of the cluster.", + "type": "string", + "readOnly": true + }, + "resourceProviderObjectId": { + "description": "Object id of RP Service Principal", + "type": "string", + "readOnly": true + } + } + }, + "ClusterPatchProperties": { + "description": "Cluster properties.", + "type": "object", + "properties": { + "cloudManagementEndpoint": { + "description": "Endpoint configured for management from the Azure portal", + "type": "string" + }, + "aadClientId": { + "description": "App id of cluster AAD identity.", + "type": "string" + }, + "aadTenantId": { + "description": "Tenant id of cluster AAD identity.", + "type": "string" + }, + "desiredProperties": { + "description": "Desired properties of the cluster.", + "$ref": "#/definitions/ClusterDesiredProperties" + } + } + }, + "SoftwareAssuranceProperties": { + "description": "Software Assurance properties of the cluster.", + "type": "object", + "properties": { + "softwareAssuranceStatus": { + "description": "Status of the Software Assurance for the cluster.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SoftwareAssuranceStatus", + "modelAsString": true + } + }, + "softwareAssuranceIntent": { + "description": "Customer Intent for Software Assurance Benefit.", + "type": "string", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SoftwareAssuranceIntent", + "modelAsString": true + } + }, + "lastUpdated": { + "description": "TimeStamp denoting the latest SA benefit applicability is validated.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "ClusterDesiredProperties": { + "description": "Desired properties of the cluster.", + "type": "object", + "properties": { + "windowsServerSubscription": { + "description": "Desired state of Windows Server Subscription.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WindowsServerSubscription", + "modelAsString": true + } + }, + "diagnosticLevel": { + "description": "Desired level of diagnostic data emitted by the cluster.", + "type": "string", + "enum": [ + "Off", + "Basic", + "Enhanced" + ], + "x-ms-enum": { + "name": "DiagnosticLevel", + "modelAsString": true + } + } + } + }, + "ClusterReportedProperties": { + "description": "Properties reported by cluster agent.", + "type": "object", + "properties": { + "clusterName": { + "description": "Name of the on-prem cluster connected to this resource.", + "type": "string", + "readOnly": true + }, + "clusterId": { + "description": "Unique id generated by the on-prem cluster.", + "type": "string", + "readOnly": true + }, + "clusterVersion": { + "description": "Version of the cluster software.", + "type": "string", + "readOnly": true + }, + "nodes": { + "description": "List of nodes reported by the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterNode" + }, + "readOnly": true + }, + "lastUpdated": { + "description": "Last time the cluster reported the data.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "imdsAttestation": { + "description": "IMDS attestation status of the cluster.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ImdsAttestation", + "modelAsString": true + }, + "readOnly": true + }, + "diagnosticLevel": { + "description": "Level of diagnostic data emitted by the cluster.", + "type": "string", + "enum": [ + "Off", + "Basic", + "Enhanced" + ], + "x-ms-enum": { + "name": "DiagnosticLevel", + "modelAsString": true + } + }, + "supportedCapabilities": { + "description": "Capabilities supported by the cluster.", + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "readOnly": true + } + } + } + }, + "ClusterNode": { + "description": "Cluster node details.", + "type": "object", + "properties": { + "name": { + "description": "Name of the cluster node.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the node in the cluster.", + "type": "number", + "readOnly": true + }, + "windowsServerSubscription": { + "description": "State of Windows Server Subscription.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WindowsServerSubscription", + "modelAsString": true + }, + "readOnly": true + }, + "nodeType": { + "description": "Type of the cluster node hardware.", + "type": "string", + "enum": [ + "FirstParty", + "ThirdParty" + ], + "x-ms-enum": { + "name": "ClusterNodeType", + "modelAsString": true + }, + "readOnly": true + }, + "ehcResourceId": { + "description": "Edge Hardware Center Resource Id", + "type": "string", + "readOnly": true + }, + "manufacturer": { + "description": "Manufacturer of the cluster node hardware.", + "type": "string", + "readOnly": true + }, + "model": { + "description": "Model name of the cluster node hardware.", + "type": "string", + "readOnly": true + }, + "osName": { + "description": "Operating system running on the cluster node.", + "type": "string", + "readOnly": true + }, + "osVersion": { + "description": "Version of the operating system running on the cluster node.", + "type": "string", + "readOnly": true + }, + "osDisplayVersion": { + "description": "Display version of the operating system running on the cluster node.", + "type": "string", + "readOnly": true + }, + "serialNumber": { + "description": "Immutable id of the cluster node.", + "type": "string", + "readOnly": true + }, + "coreCount": { + "description": "Number of physical cores on the cluster node.", + "type": "number", + "readOnly": true + }, + "memoryInGiB": { + "description": "Total available memory on the cluster node (in GiB).", + "type": "number", + "readOnly": true + }, + "lastLicensingTimestamp": { + "description": "Most recent licensing timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "RawCertificateData": { + "type": "object", + "properties": { + "certificates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "UploadCertificateRequest": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RawCertificateData" + } + }, + "additionalProperties": false + }, + "SoftwareAssuranceChangeRequestProperties": { + "type": "object", + "properties": { + "softwareAssuranceIntent": { + "type": "string", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SoftwareAssuranceIntent", + "modelAsString": true + } + } + }, + "additionalProperties": false + }, + "SoftwareAssuranceChangeRequest": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SoftwareAssuranceChangeRequestProperties" + } + }, + "additionalProperties": false + }, + "ClusterIdentityResponse": { + "description": "Cluster Identity details.", + "type": "object", + "properties": { + "properties": { + "description": "Cluster identity properties.", + "$ref": "#/definitions/ClusterIdentityResponseProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterIdentityResponseProperties": { + "type": "object", + "properties": { + "aadClientId": { + "type": "string" + }, + "aadTenantId": { + "type": "string" + }, + "aadServicePrincipalObjectId": { + "type": "string" + }, + "aadApplicationObjectId": { + "type": "string" + } + }, + "additionalProperties": false, + "readOnly": true + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ConsentAndInstallDefaultExtensions.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ConsentAndInstallDefaultExtensions.json new file mode 100644 index 000000000000..3da2a8d49336 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ConsentAndInstallDefaultExtensions.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "Creating", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Creating" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Creating" + } + ], + "connectivityProperties": { + "enabled": false + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/CreateArcIdentity.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/CreateArcIdentity.json new file mode 100644 index 000000000000..0de97df29642 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/CreateArcIdentity.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "arcApplicationClientId": "7b93bf67-60ac-4909-a987-ac438e69f9ba", + "arcApplicationTenantId": "bdb2c88c-9cfd-4e19-927d-51e875f6912b", + "arcApplicationObjectId": "400bd05f-395f-45a6-ba75-72601df80107", + "arcServicePrincipalObjectId": "00cc4014-482e-4de9-9932-83415cc75f45" + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/CreateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/CreateCluster.json new file mode 100644 index 000000000000..9d13a300deb7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/CreateCluster.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-03-01", + "cluster": { + "location": "East US", + "properties": { + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "identity": { + "principalId": "87a834db-2e45-409e-911b-e16a44562ec3", + "tenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "type": "SystemAssigned" + }, + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "NotYetRegistered", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Disabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": {}, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "serviceEndpoint": "https://azurestackhci.azurefd.net/eastus" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/CreateClusterIdentity.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/CreateClusterIdentity.json new file mode 100644 index 000000000000..eb2f9bb14740 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/CreateClusterIdentity.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "aadClientId": "7b93bf67-60ac-4909-a987-ac438e69f9ba", + "aadTenantId": "bdb2c88c-9cfd-4e19-927d-51e875f6912b", + "aadServicePrincipalObjectId": "400bd05f-395f-45a6-ba75-72601df80107", + "aadApplicationObjectId": "00cc4014-482e-4de9-9932-83415cc75f45" + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteArcSetting.json new file mode 100644 index 000000000000..b4b47f0f7c0b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteArcSetting.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-03-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteCluster.json new file mode 100644 index 000000000000..50730e5c9883 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteCluster.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-03-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteExtension.json new file mode 100644 index 000000000000..76d90b469d80 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteExtension.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2023-03-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteUpdateRuns.json new file mode 100644 index 000000000000..368d3ad3ccc1 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteUpdateRuns.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3", + "api-version": "2023-03-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteUpdateSummaries.json new file mode 100644 index 000000000000..9145b333356f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteUpdateSummaries.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2023-03-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteUpdates.json new file mode 100644 index 000000000000..ee84c8991ae9 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/DeleteUpdates.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2023-03-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ExtendSoftwareAssuranceBenefit.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ExtendSoftwareAssuranceBenefit.json new file mode 100644 index 000000000000..918f01d843cb --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ExtendSoftwareAssuranceBenefit.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-03-01", + "softwareAssuranceChangeRequest": { + "properties": { + "softwareAssuranceIntent": "Enable" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "softwareAssuranceProperties": { + "softwareAssuranceStatus": "Enabled", + "lastUpdated": "2022-08-18T22:01:12.4191603Z", + "softwareAssuranceIntent": "Enable" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "nodeType": "ThirdParty", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/Extensions_Upgrade.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/Extensions_Upgrade.json new file mode 100644 index 000000000000..20a98985cf89 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/Extensions_Upgrade.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2023-03-01", + "extensionUpgradeParameters": { + "targetVersion": "1.0.18062.0" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses", + "Retry-After": 200, + "Azure-AsyncOperation": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GeneratePassword.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GeneratePassword.json new file mode 100644 index 000000000000..0b1ca1ee022e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GeneratePassword.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "secretText": "secretText", + "startDateTime": "2022-02-17T16:24:23.6264005+05:30", + "endDateTime": "2121-02-17T16:24:23.6264377+05:30", + "keyId": "00000000-2d47-4fb2-8ed2-fed71a5c197b" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetArcSetting.json new file mode 100644 index 000000000000..88fc013ef937 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetArcSetting.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "PartiallyConnected", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Connected" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Disconnected" + } + ], + "connectivityProperties": { + "enabled": false + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + }, + { + "category": "Supportability", + "consentTime": null + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetCluster.json new file mode 100644 index 000000000000..0f1fc481f12d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetCluster.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + }, + { + "name": "Node2", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + }, + { + "name": "Node3", + "id": 3, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetExtension.json new file mode 100644 index 000000000000..98922d546b05 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetExtension.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "enableAutomaticUpgrade": true, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "Azure" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetOffer.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetOffer.json new file mode 100644 index 000000000000..28214e28322e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetOffer.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "offerName": "offer1", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers", + "name": "offer1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetPublisher.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetPublisher.json new file mode 100644 index 000000000000..caefae6f4279 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetPublisher.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1", + "type": "Microsoft.AzureStackHCI/clusters/publishers", + "name": "publisher1" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetSku.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetSku.json new file mode 100644 index 000000000000..3d1b1f572df6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetSku.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "offerName": "offer1", + "skuName": "sku1", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1/skus/sku1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers/skus", + "name": "sku1", + "properties": { + "publisherId": "publisher1", + "offerId": "offer1", + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetUpdateRuns.json new file mode 100644 index 000000000000..e1df0cba9d16 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetUpdateRuns.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3", + "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3", + "type": "Microsoft.AzureStackHCI/updates/updateRuns", + "location": "West US", + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetUpdateSummaries.json new file mode 100644 index 000000000000..2011c74f898d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetUpdateSummaries.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/updateSummaries", + "location": "West US", + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "packageVersions": [ + { + "packageType": "OEM", + "version": "2.2.2108.6", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Services", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Infrastructure", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + } + ], + "currentVersion": "4.2203.2.32", + "state": "AppliedSuccessfully" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetUpdates.json new file mode 100644 index 000000000000..58886b6356d0 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/GetUpdates.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32", + "name": "Microsoft4.2203.2.32", + "type": "Microsoft.AzureStackHCI/updates", + "location": "West US", + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/InitializeDisableProcess.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/InitializeDisableProcess.json new file mode 100644 index 000000000000..6df46cb34611 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/InitializeDisableProcess.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-03-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses", + "Retry-After": 200, + "Azure-AsyncOperation": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListArcSettingsByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListArcSettingsByCluster.json new file mode 100644 index 000000000000..e8d924c3b878 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListArcSettingsByCluster.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "PartiallyConnected", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Connected" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Disconnected" + } + ], + "connectivityProperties": { + "enabled": false + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + }, + { + "category": "Supportability", + "consentTime": null + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListClustersByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListClustersByResourceGroup.json new file mode 100644 index 000000000000..fc5fc3cdf635 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListClustersByResourceGroup.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster1", + "name": "myCluster1", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "NotYetRegistered", + "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": {}, + "trialDaysRemaining": 29, + "billingModel": "Trial" + } + }, + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster2", + "name": "myCluster2", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 0, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + }, + { + "name": "Node2", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128 + }, + { + "name": "Node3", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListClustersBySubscription.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListClustersBySubscription.json new file mode 100644 index 000000000000..b289c53e5e0c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListClustersBySubscription.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg1/providers/Microsoft.AzureStackHCI/clusters/myCluster1", + "name": "myCluster1", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "NotYetRegistered", + "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": {}, + "trialDaysRemaining": 29, + "billingModel": "Trial" + } + }, + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg2/providers/Microsoft.AzureStackHCI/clusters/myCluster2", + "name": "myCluster2", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "West US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 0, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + }, + { + "name": "Node2", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128 + }, + { + "name": "Node3", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListExtensionsByArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListExtensionsByArcSetting.json new file mode 100644 index 000000000000..780b3d8c3a2b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListExtensionsByArcSetting.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallyConnected", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Connected" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Disconnected" + } + ], + "managedBy": "Azure" + } + }, + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/Extensions/SecurityExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.CustomScriptExtension", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "scriptLocation": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/SecurityExtension", + "state": "Succeeded" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/SecurityExtension", + "state": "Failed" + } + ], + "managedBy": "Azure" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListOffersByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListOffersByCluster.json new file mode 100644 index 000000000000..7d51223444d0 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListOffersByCluster.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers", + "name": "offer1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListOffersByPublisher.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListOffersByPublisher.json new file mode 100644 index 000000000000..c4a28a0f7b60 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListOffersByPublisher.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers", + "name": "offer1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListOperations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListOperations.json new file mode 100644 index 000000000000..d783e2df4303 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListOperations.json @@ -0,0 +1,453 @@ +{ + "parameters": { + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureStackHCI/Register/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Register", + "operation": "Registers the Azure Stack HCI Resource Provider", + "description": "Registers the subscription for the Azure Stack HCI resource provider and enables the creation of Azure Stack HCI resources." + } + }, + { + "name": "Microsoft.AzureStackHCI/Unregister/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Unregister", + "operation": "Unregisters the Azure Stack HCI Resource Provider", + "description": "Unregisters the subscription for the Azure Stack HCI resource provider." + } + }, + { + "name": "Microsoft.AzureStackHCI/Operations/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Operations", + "operation": "Gets/List operations resources", + "description": "Gets operations" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters", + "operation": "Gets/List cluster resources", + "description": "Gets clusters" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters", + "operation": "Create/update cluster resources", + "description": "Creates or updates a cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters", + "operation": "Deletes cluster resource", + "description": "Deletes cluster resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings", + "operation": "Gets/List arc resources", + "description": "Gets arc resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings", + "operation": "Create/Update arc resources", + "description": "Create or updates arc resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings", + "operation": "Delete arc resources", + "description": "Delete arc resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings/Extensions", + "operation": "Gets/List extension resources of HCI cluster", + "description": "Gets extension resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings/Extensions", + "operation": "Create/Update extension resources of HCI cluster", + "description": "Create or update extension resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings/Extensions", + "operation": "Delete extension resources of HCI cluster", + "description": "Delete extension resources of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Restart/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Restarts virtual machine resource", + "description": "Restarts virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Start/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Starts virtual machine resource", + "description": "Starts virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Stop/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Stops virtual machine resource", + "description": "Stops virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Deletes virtual machine resource", + "description": "Deletes virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Creates/Updates virtual machine resource", + "description": "Creates/Updates virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Gets/Lists virtual machine resource", + "description": "Gets/Lists virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualNetworks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualNetworks", + "operation": "Deletes virtual networks resource", + "description": "Deletes virtual networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualNetworks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualNetworks", + "operation": "Creates/Updates virtual networks resource", + "description": "Creates/Updates virtual networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualNetworks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualNetworks", + "operation": "Gets/Lists virtual networks resource", + "description": "Gets/Lists virtual networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Deletes virtual hard disk resource", + "description": "Deletes virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Creates/Updates virtual hard disk resource", + "description": "Creates/Updates virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Gets/Lists virtual hard disk resource", + "description": "Gets/Lists virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Deletes network interfaces resource", + "description": "Deletes network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Creates/Updates network interfaces resource", + "description": "Creates/Updates network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Gets/Lists network interfaces resource", + "description": "Gets/Lists network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Deletes gallery images resource", + "description": "Deletes gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Creates/Updates gallery images resource", + "description": "Creates/Updates gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Gets/Lists gallery images resource", + "description": "Gets/Lists gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/HybridIdentityMetadata/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/HybridIdentityMetadata", + "operation": "Gets/Lists virtual machine hybrid identity metadata proxy resource", + "description": "Gets/Lists virtual machine hybrid identity metadata proxy resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/Extensions", + "operation": "Gets/Lists virtual machine extensions resource", + "description": "Gets/Lists virtual machine extensions resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/Extensions", + "operation": "Creates/Updates virtual machine extensions resource", + "description": "Creates/Updates virtual machine extensions resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/Extensions", + "operation": "Deletes virtual machine extensions resource", + "description": "Deletes virtual machine extensions resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/RegisteredSubscriptions/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "RegisteredSubscriptions", + "operation": "Gets/Lists registered subscriptions", + "description": "Reads registered subscriptions" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates", + "operation": "Gets/List available updates for HCI cluster", + "description": "Gets available updates for HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates", + "operation": "Create/Update updates resource of HCI cluster", + "description": "Create or update updates resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates", + "operation": "Delete updates resources of HCI cluster", + "description": "Delete updates resources of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/UpdateSummaries", + "operation": "Gets/List available update summaries for HCI cluster", + "description": "Gets available update summaries for HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/UpdateSummaries", + "operation": "Create/Update update summaries resource of HCI cluster", + "description": "Create or update update summaries resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/UpdateSummaries", + "operation": "Delete updates resource summaries of HCI cluster", + "description": "Delete update summaries resources of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates/UpdateRuns", + "operation": "Gets/List available update runs for HCI cluster", + "description": "Gets available update runs for HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates/UpdateRuns", + "operation": "Create/Update update runs resource of HCI cluster", + "description": "Create or update update runs resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates/UpdateRuns", + "operation": "Delete updates resource runs of HCI cluster", + "description": "Delete update runs resources of HCI cluster" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListPublishersByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListPublishersByCluster.json new file mode 100644 index 000000000000..35b3737a667f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListPublishersByCluster.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1", + "type": "Microsoft.AzureStackHCI/clusters/publishers", + "name": "publisher1" + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListSkusByOffer.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListSkusByOffer.json new file mode 100644 index 000000000000..e00d03cbc7ce --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListSkusByOffer.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "offerName": "offer1", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1/skus/sku1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers/skus", + "name": "sku1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see Ubuntu on Azure and using Juju to deploy your workloads.

Legal Terms

By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the legal terms of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the privacy statement from Canonical.

\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "offerId": "offer1", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListUpdateRuns.json new file mode 100644 index 000000000000..6344b7e704db --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListUpdateRuns.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3", + "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3", + "type": "Microsoft.AzureStackHCI/updates/updateRuns", + "location": "West US", + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListUpdateSummaries.json new file mode 100644 index 000000000000..1a6fba71953e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListUpdateSummaries.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/updateSummaries", + "location": "West US", + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "packageVersions": [ + { + "packageType": "OEM", + "version": "2.2.2108.6", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Services", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Infrastructure", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + } + ], + "currentVersion": "4.2203.2.32", + "state": "AppliedSuccessfully" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListUpdates.json new file mode 100644 index 000000000000..3955d67ecb34 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/ListUpdates.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32", + "name": "Microsoft4.2203.2.32", + "type": " Microsoft. AzureStackHCI/updates", + "location": "West US", + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PatchArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PatchArcSetting.json new file mode 100644 index 000000000000..6aefe877df79 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PatchArcSetting.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "arcSetting": { + "properties": { + "connectivityProperties": { + "enabled": true + } + } + }, + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "Creating", + "connectivityProperties": { + "enabled": true + }, + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Creating" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Creating" + } + ], + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + }, + { + "category": "Supportability", + "consentTime": null + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PatchExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PatchExtension.json new file mode 100644 index 000000000000..46aedfe5f03b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PatchExtension.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "extension": { + "properties": { + "extensionParameters": { + "publisher": "Microsoft.Compute", + "typeHandlerVersion": "1.10", + "type": "MicrosoftMonitoringAgent", + "settings": { + "workspaceId": "xx" + } + } + } + }, + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "enableAutomaticUpgrade": false, + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallyConnected", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Connected", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Disconnected", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "User" + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PostUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PostUpdates.json new file mode 100644 index 000000000000..283757772a05 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PostUpdates.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2023-03-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutArcSetting.json new file mode 100644 index 000000000000..55b86e00847d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutArcSetting.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "arcSetting": {}, + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "Creating", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Creating" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Creating" + } + ], + "connectivityProperties": { + "enabled": false + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutExtension.json new file mode 100644 index 000000000000..2c5ce45e4bf5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutExtension.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "extension": { + "properties": { + "extensionParameters": { + "publisher": "Microsoft.Compute", + "typeHandlerVersion": "1.10", + "type": "MicrosoftMonitoringAgent", + "enableAutomaticUpgrade": false, + "settings": { + "workspaceId": "xx" + }, + "protectedSettings": { + "workspaceKey": "xx" + } + } + } + }, + "api-version": "2023-03-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "enableAutomaticUpgrade": false, + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "enableAutomaticUpgrade": false, + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "User" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutUpdateRuns.json new file mode 100644 index 000000000000..f3fc430d3d4a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutUpdateRuns.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3", + "api-version": "2023-03-01", + "updateRunsProperties": { + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3", + "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3", + "type": "Microsoft.AzureStackHCI/updates/updateRuns", + "location": "West US", + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutUpdateSummaries.json new file mode 100644 index 000000000000..afa60b7f6564 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutUpdateSummaries.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2023-03-01", + "updateLocationProperties": { + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "lastChecked": "2022-04-07T18:04:07Z", + "currentVersion": "4.2203.2.32", + "lastUpdated": "2022-04-06T14:08:18.254Z", + "state": "AppliedSuccessfully" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/updateSummaries", + "location": "West US", + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "packageVersions": [ + { + "packageType": "OEM", + "version": "2.2.2108.6", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Services", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Infrastructure", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + } + ], + "currentVersion": "4.2203.2.32", + "state": "AppliedSuccessfully" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutUpdates.json new file mode 100644 index 000000000000..5015aa605832 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/PutUpdates.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2023-03-01", + "updateProperties": { + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32", + "name": "Microsoft4.2203.2.32", + "type": "Microsoft.AzureStackHCI/updates", + "location": "West US", + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/UpdateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/UpdateCluster.json new file mode 100644 index 000000000000..52805fa5156a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/UpdateCluster.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-03-01", + "cluster": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "identity": { + "principalId": "87a834db-2e45-409e-911b-e16a44562ec3", + "tenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + }, + { + "name": "Node2", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + }, + { + "name": "Node3", + "id": 3, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/UploadCertificate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/UploadCertificate.json new file mode 100644 index 000000000000..7426be67923e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/examples/UploadCertificate.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2023-03-01", + "uploadCertificateRequest": { + "properties": { + "certificates": [ + "base64cert", + "base64cert" + ] + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/extensions.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/extensions.json new file mode 100644 index 000000000000..e301d1657ec4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/extensions.json @@ -0,0 +1,663 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-03-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions": { + "get": { + "operationId": "Extensions_ListByArcSetting", + "description": "List all Extensions under ArcSetting resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExtensionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Extensions under ArcSetting resource": { + "$ref": "./examples/ListExtensionsByArcSetting.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}": { + "get": { + "operationId": "Extensions_Get", + "description": "Get particular Arc Extension of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ArcSettings Extension": { + "$ref": "./examples/GetExtension.json" + } + } + }, + "put": { + "operationId": "Extensions_Create", + "description": "Create Extension for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "name": "extension", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Extension" + }, + "description": "Details of the Machine Extension to be created." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create Arc Extension": { + "$ref": "./examples/PutExtension.json" + } + } + }, + "patch": { + "operationId": "Extensions_Update", + "description": "Update Extension for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "name": "extension", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Extension" + }, + "description": "Details of the Machine Extension to be created." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "x-ms-examples": { + "Update Arc Extension": { + "$ref": "./examples/PatchExtension.json" + } + } + }, + "delete": { + "operationId": "Extensions_Delete", + "description": "Delete particular Arc Extension of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "OK" + }, + "204": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete Arc Extension": { + "$ref": "./examples/DeleteExtension.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}/upgrade": { + "post": { + "operationId": "Extensions_Upgrade", + "description": "Upgrade a particular Arc Extension of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "name": "extensionUpgradeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExtensionUpgradeParameters" + }, + "description": "Parameters supplied to the Upgrade Extensions operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Upgrade Machine Extensions": { + "$ref": "./examples/Extensions_Upgrade.json" + } + } + } + } + }, + "definitions": { + "Extension": { + "description": "Details of a particular extension in HCI Cluster.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Describes Machine Extension Properties.", + "$ref": "#/definitions/ExtensionProperties", + "x-ms-client-flatten": true + } + } + }, + "ExtensionProperties": { + "description": "Status of Arc Extension for a particular node in HCI Cluster.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Extension proxy resource.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Failed", + "Canceled", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "extensionParameters": { + "description": "Parameters specific to this extension type.", + "$ref": "#/definitions/ExtensionParameters", + "x-ms-client-flatten": true + }, + "aggregateState": { + "description": "Aggregate state of Arc Extensions across the nodes in this HCI cluster.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "UpgradeFailedRollbackSucceeded" + ], + "x-ms-enum": { + "name": "ExtensionAggregateState", + "modelAsString": true + }, + "readOnly": true + }, + "perNodeExtensionDetails": { + "description": "State of Arc Extension in each of the nodes.", + "type": "array", + "items": { + "$ref": "#/definitions/PerNodeExtensionState" + }, + "readOnly": true + }, + "managedBy": { + "description": "Indicates if the extension is managed by azure or the user.", + "type": "string", + "enum": [ + "Azure", + "User" + ], + "x-ms-enum": { + "name": "ExtensionManagedBy", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "PerNodeExtensionState": { + "description": "Status of Arc Extension for a particular node in HCI Cluster.", + "type": "object", + "properties": { + "name": { + "description": "Name of the node in HCI Cluster.", + "type": "string", + "readOnly": true + }, + "extension": { + "description": "Fully qualified resource ID for the particular Arc Extension on this node.", + "type": "string", + "readOnly": true + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler.", + "readOnly": true + }, + "state": { + "description": "State of Arc Extension in this node.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "NodeExtensionState", + "modelAsString": true + }, + "readOnly": true + }, + "instanceView": { + "$ref": "#/definitions/ExtensionInstanceView", + "description": "The extension instance view.", + "readOnly": true + } + } + }, + "ExtensionList": { + "description": "List of Extensions in HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of Extensions in HCI cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/Extension" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ExtensionParameters": { + "description": "Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute.", + "type": "object", + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler. Latest version would be used if not specified." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "Protected settings (may contain secrets).", + "x-ms-secret": true + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available." + } + } + }, + "ExtensionInstanceView": { + "type": "object", + "description": "Describes the Extension Instance View.", + "properties": { + "name": { + "type": "string", + "description": "The extension name." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"MicrosoftMonitoringAgent\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "status": { + "type": "object", + "description": "Instance view status.", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + } + } + } + }, + "ExtensionUpgradeParameters": { + "type": "object", + "description": "Describes the parameters for Extension upgrade.", + "properties": { + "targetVersion": { + "type": "string", + "description": "Extension Upgrade Target Version." + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ArcSettingNameParameter": { + "name": "arcSettingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proxy resource holding details of HCI ArcSetting information.", + "x-ms-parameter-location": "method" + }, + "ExtensionNameParameter": { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/offers.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/offers.json new file mode 100644 index 000000000000..100ba7a3e623 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/offers.json @@ -0,0 +1,302 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-03-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers": { + "get": { + "operationId": "Offers_ListByPublisher", + "description": "List Offers available for a publisher within the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Offer resources by publisher for the HCI Cluster": { + "$ref": "./examples/ListOffersByPublisher.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/offers": { + "get": { + "operationId": "Offers_ListByCluster", + "description": "List Offers available across publishers for the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Offer resources by HCI Cluster": { + "$ref": "./examples/ListOffersByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}": { + "get": { + "operationId": "Offers_Get", + "description": "Get Offer resource details within a publisher of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "#/parameters/OfferNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Offer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Offer": { + "$ref": "./examples/GetOffer.json" + } + } + } + } + }, + "definitions": { + "OfferList": { + "description": "List of Offer proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of Offer proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Offer" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Offer": { + "description": "Offer details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Offer properties.", + "$ref": "#/definitions/OfferProperties", + "x-ms-client-flatten": true + } + } + }, + "OfferProperties": { + "description": "Publisher properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State", + "type": "string", + "readOnly": true + }, + "publisherId": { + "type": "string", + "description": "Identifier of the Publisher for the offer" + }, + "content": { + "type": "string", + "description": "JSON serialized catalog content of the offer" + }, + "contentVersion": { + "type": "string", + "description": "The API version of the catalog service used to serve the catalog content" + }, + "skuMappings": { + "type": "array", + "description": "Array of SKU mappings", + "items": { + "$ref": "#/definitions/SkuMappings" + }, + "x-ms-identifiers": [] + } + } + }, + "SkuMappings": { + "description": "SKU Mapping details.", + "type": "object", + "properties": { + "catalogPlanId": { + "type": "string", + "description": "Identifier of the CatalogPlan for the sku" + }, + "marketplaceSkuId": { + "type": "string", + "description": "Identifier for the sku" + }, + "marketplaceSkuVersions": { + "type": "array", + "description": "Array of SKU versions available", + "items": { + "type": "string" + } + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "PublisherNameParameter": { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the publisher available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "OfferNameParameter": { + "name": "offerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the offer available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "ODataExpandParameter": { + "name": "$expand", + "in": "query", + "description": "Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/operations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/operations.json new file mode 100644 index 000000000000..70fd2919a600 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/operations.json @@ -0,0 +1,73 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-03-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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": { + "/providers/Microsoft.AzureStackHCI/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "Create cluster": { + "$ref": "./examples/ListOperations.json" + } + }, + "description": "List all available Microsoft.AzureStackHCI provider operations", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/publishers.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/publishers.json new file mode 100644 index 000000000000..1d67f9936f09 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/publishers.json @@ -0,0 +1,188 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-03-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/publishers": { + "get": { + "operationId": "Publishers_ListByCluster", + "description": "List Publishers available for the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PublisherList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Publisher resources by HCI Cluster": { + "$ref": "./examples/ListPublishersByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}": { + "get": { + "operationId": "Publishers_Get", + "description": "Get Publisher resource details of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Publisher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Publisher": { + "$ref": "./examples/GetPublisher.json" + } + } + } + } + }, + "definitions": { + "PublisherList": { + "description": "List of Publisher proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of Publisher proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Publisher" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Publisher": { + "description": "Publisher details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Publisher properties.", + "$ref": "#/definitions/PublisherProperties", + "x-ms-client-flatten": true + } + } + }, + "PublisherProperties": { + "description": "Publisher properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "PublisherNameParameter": { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the publisher available within HCI cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/skus.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/skus.json new file mode 100644 index 000000000000..4df4ce10c775 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/skus.json @@ -0,0 +1,275 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-03-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus": { + "get": { + "operationId": "Skus_ListByOffer", + "description": "List Skus available for a offer within the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "#/parameters/OfferNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List SKU resources by offer for the HCI Cluster": { + "$ref": "./examples/ListSkusByOffer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}": { + "get": { + "operationId": "Skus_Get", + "description": "Get SKU resource details within a offer of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "#/parameters/OfferNameParameter" + }, + { + "$ref": "#/parameters/SkuNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Sku" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Sku": { + "$ref": "./examples/GetSku.json" + } + } + } + } + }, + "definitions": { + "SkuList": { + "description": "List of SKU proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of SKU proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Sku" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Sku": { + "description": "Sku details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "SKU properties.", + "$ref": "#/definitions/SkuProperties", + "x-ms-client-flatten": true + } + } + }, + "SkuProperties": { + "description": "SKU properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State", + "type": "string", + "readOnly": true + }, + "publisherId": { + "type": "string", + "description": "Identifier of the Publisher for the offer" + }, + "offerId": { + "type": "string", + "description": "Identifier of the Offer for the sku" + }, + "content": { + "type": "string", + "description": "JSON serialized catalog content of the sku offer" + }, + "contentVersion": { + "type": "string", + "description": "The API version of the catalog service used to serve the catalog content" + }, + "skuMappings": { + "type": "array", + "description": "Array of SKU mappings", + "items": { + "$ref": "#/definitions/SkuMappings" + }, + "x-ms-identifiers": [] + } + } + }, + "SkuMappings": { + "description": "SKU Mapping details.", + "type": "object", + "properties": { + "catalogPlanId": { + "type": "string", + "description": "Identifier of the CatalogPlan for the sku" + }, + "marketplaceSkuId": { + "type": "string", + "description": "Identifier for the sku" + }, + "marketplaceSkuVersions": { + "type": "array", + "description": "Array of SKU versions available", + "items": { + "type": "string" + } + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "PublisherNameParameter": { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the publisher available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "OfferNameParameter": { + "name": "offerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the offer available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "SkuNameParameter": { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SKU available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "ODataExpandParameter": { + "name": "$expand", + "in": "query", + "description": "Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/updateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/updateRuns.json new file mode 100644 index 000000000000..4ce79bf0c387 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/updateRuns.json @@ -0,0 +1,408 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-03-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns": { + "get": { + "operationId": "UpdateRuns_List", + "description": "List all Update runs for a specified update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateRunList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Update runs under cluster resource": { + "$ref": "./examples/ListUpdateRuns.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns/{updateRunName}": { + "delete": { + "operationId": "UpdateRuns_Delete", + "description": "Delete specified Update Run", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateRunNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete an Update": { + "$ref": "./examples/DeleteUpdateRuns.json" + } + } + }, + "put": { + "operationId": "UpdateRuns_Put", + "description": "Put Update runs for a specified update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateRunNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateRunsProperties", + "in": "body", + "description": "Properties of the updateRuns object", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateRun" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update runs under cluster resource": { + "$ref": "./examples/PutUpdateRuns.json" + } + } + }, + "get": { + "operationId": "UpdateRuns_Get", + "description": "Get the Update run for a specified update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateRunNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update runs under cluster resource": { + "$ref": "./examples/GetUpdateRuns.json" + } + } + } + } + }, + "definitions": { + "UpdateRunList": { + "description": "List of Update runs", + "type": "object", + "properties": { + "value": { + "description": "List of Update runs", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateRun" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateRun": { + "description": "Details of an Update run", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "description": "Describes Update Run Properties.", + "$ref": "#/definitions/UpdateRunProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateRunProperties": { + "description": "Details of an Update run", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the UpdateRuns proxy resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "timeStarted": { + "description": "Timestamp of the update run was started.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedTime": { + "description": "Timestamp of the most recently completed step in the update run.", + "type": "string", + "format": "date-time" + }, + "duration": { + "description": "Duration of the update run.", + "type": "string" + }, + "state": { + "description": "State of the update run.", + "type": "string", + "enum": [ + "Unknown", + "Succeeded", + "InProgress", + "Failed" + ], + "x-ms-enum": { + "name": "updateRunPropertiesState", + "modelAsString": true + } + }, + "progress": { + "description": "Progress representation of the update run steps.", + "$ref": "#/definitions/Step", + "x-ms-client-flatten": true + } + } + }, + "Step": { + "description": "Progress representation of the update run steps.", + "type": "object", + "properties": { + "name": { + "description": "Name of the step.", + "type": "string" + }, + "description": { + "description": "More detailed description of the step.", + "type": "string" + }, + "errorMessage": { + "description": "Error message, specified if the step is in a failed state.", + "type": "string" + }, + "status": { + "description": "Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.", + "type": "string" + }, + "startTimeUtc": { + "description": "When the step started, or empty if it has not started executing.", + "type": "string", + "format": "date-time" + }, + "endTimeUtc": { + "description": "When the step reached a terminal state.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedTimeUtc": { + "description": "Completion time of this step or the last completed sub-step.", + "type": "string", + "format": "date-time" + }, + "steps": { + "description": "Recursive model for child steps of this step.", + "type": "array", + "items": { + "$ref": "#/definitions/Step" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "UpdateNameParameter": { + "name": "updateName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Update", + "x-ms-parameter-location": "method" + }, + "UpdateRunNameParameter": { + "name": "updateRunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Update Run", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/updateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/updateSummaries.json new file mode 100644 index 000000000000..779d35665708 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/updateSummaries.json @@ -0,0 +1,482 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-03-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/updateSummaries": { + "get": { + "operationId": "UpdateSummaries_List", + "description": "List all Update summaries under the HCI cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateSummariesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update summaries under cluster resource": { + "$ref": "./examples/ListUpdateSummaries.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries/default": { + "delete": { + "operationId": "UpdateSummaries_Delete", + "description": "Delete Update Summaries", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete an Update": { + "$ref": "./examples/DeleteUpdateSummaries.json" + } + } + }, + "put": { + "operationId": "UpdateSummaries_Put", + "description": "Put Update summaries under the HCI cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateLocationProperties", + "in": "body", + "description": "Properties of the UpdateSummaries resource", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateSummaries" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateSummaries" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put Update summaries under cluster resource": { + "$ref": "./examples/PutUpdateSummaries.json" + } + } + }, + "get": { + "operationId": "UpdateSummaries_Get", + "description": "Get all Update summaries under the HCI cluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateSummaries" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update summaries under cluster resource": { + "$ref": "./examples/GetUpdateSummaries.json" + } + } + } + } + }, + "definitions": { + "UpdateSummariesList": { + "description": "List of Update Summaries", + "type": "object", + "properties": { + "value": { + "description": "List of Update Summaries", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateSummaries" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateSummaries": { + "description": "Get the update summaries for the cluster", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "description": "Update summaries properties", + "type": "object", + "$ref": "#/definitions/UpdateSummariesProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateSummariesProperties": { + "description": "Properties of Update summaries", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the UpdateSummaries proxy resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "oemFamily": { + "description": "OEM family name.", + "type": "string" + }, + "hardwareModel": { + "description": "Name of the hardware model.", + "type": "string" + }, + "packageVersions": { + "description": "Current version of each updatable component.", + "type": "array", + "items": { + "$ref": "#/definitions/PackageVersionInfo" + }, + "x-ms-client-flatten": true, + "x-ms-identifiers": [ + "version" + ] + }, + "currentVersion": { + "description": "Current Solution Bundle version of the stamp.", + "type": "string" + }, + "lastUpdated": { + "description": "Last time an update installation completed successfully.", + "type": "string", + "format": "date-time" + }, + "lastChecked": { + "description": "Last time the update service successfully checked for updates", + "type": "string", + "format": "date-time" + }, + "healthState": { + "description": "Overall health state for update-specific health checks.", + "type": "object", + "$ref": "#/definitions/HealthState", + "x-ms-client-flatten": true + }, + "healthCheckResult": { + "description": "An array of pre-check result objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PrecheckResult" + }, + "x-ms-client-flatten": true, + "x-ms-identifiers": [ + "name" + ] + }, + "healthCheckDate": { + "description": "Last time the package-specific checks were run.", + "type": "string", + "format": "date-time" + }, + "state": { + "description": "Overall update state of the stamp.", + "type": "string", + "enum": [ + "Unknown", + "AppliedSuccessfully", + "UpdateAvailable", + "UpdateInProgress", + "UpdateFailed", + "NeedsAttention", + "PreparationInProgress", + "PreparationFailed" + ], + "x-ms-enum": { + "name": "updateSummariesPropertiesState", + "modelAsString": true + } + } + } + }, + "PackageVersionInfo": { + "description": "Current version of each updatable component.", + "type": "object", + "properties": { + "packageType": { + "description": "Package type", + "type": "string" + }, + "version": { + "description": "Package version", + "type": "string" + }, + "lastUpdated": { + "description": "Last time this component was updated.", + "type": "string", + "format": "date-time" + } + } + }, + "HealthState": { + "type": "string", + "enum": [ + "Unknown", + "Success", + "Failure", + "Warning", + "Error", + "InProgress" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true + } + }, + "PrecheckResult": { + "properties": { + "name": { + "description": "Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer.", + "type": "string" + }, + "tags": { + "description": "Key-value pairs that allow grouping/filtering individual tests.", + "type": "object", + "properties": { + "key": { + "description": "Key that allow grouping/filtering individual tests.", + "type": "string" + }, + "value": { + "description": "Value of the key that allow grouping/filtering individual tests.", + "type": "string" + } + } + }, + "title": { + "description": "User-facing name; one or more sentences indicating the direct issue.", + "type": "string" + }, + "status": { + "description": "The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "InProgress" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "severity": { + "description": "Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity.", + "type": "string", + "enum": [ + "Critical", + "Warning", + "Informational", + "Hidden" + ], + "x-ms-enum": { + "name": "severity", + "modelAsString": true + } + }, + "description": { + "description": "Detailed overview of the issue and what impact the issue has on the stamp.", + "type": "string" + }, + "remediation": { + "description": "Set of steps that can be taken to resolve the issue found.", + "type": "string" + }, + "targetResourceID": { + "description": "The unique identifier for the affected resource (such as a node or drive).", + "type": "string" + }, + "targetResourceName": { + "description": "The name of the affected resource.", + "type": "string" + }, + "timestamp": { + "description": "The Time in which the HealthCheck was called.", + "type": "string", + "format": "date-time" + }, + "additionalData": { + "description": "Property bag of key value pairs for additional information.", + "type": "string" + }, + "healthCheckSource": { + "description": "The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster).", + "type": "string" + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/updates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/updates.json new file mode 100644 index 000000000000..26eedfe592fe --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/stable/2023-03-01/updates.json @@ -0,0 +1,654 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-03-01", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "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.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/apply": { + "post": { + "operationId": "Updates_Post", + "description": "Apply Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List available updates": { + "$ref": "./examples/PostUpdates.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates": { + "get": { + "operationId": "Updates_List", + "description": "List all Updates", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List available updates": { + "$ref": "./examples/ListUpdates.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}": { + "delete": { + "operationId": "Updates_Delete", + "description": "Delete specified Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete an Update": { + "$ref": "./examples/DeleteUpdates.json" + } + } + }, + "put": { + "operationId": "Updates_Put", + "description": "Put specified Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateProperties", + "in": "body", + "description": "Properties of the Updates object", + "required": true, + "schema": { + "$ref": "#/definitions/Update" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Update" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put a specific update": { + "$ref": "./examples/PutUpdates.json" + } + } + }, + "get": { + "operationId": "Updates_Get", + "description": "Get specified Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Update" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a specific update": { + "$ref": "./examples/GetUpdates.json" + } + } + } + } + }, + "definitions": { + "UpdateList": { + "description": "List of Updates", + "type": "object", + "properties": { + "value": { + "description": "List of Updates", + "type": "array", + "items": { + "$ref": "#/definitions/Update" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdatePrerequisite": { + "description": "If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.", + "type": "object", + "properties": { + "updateType": { + "description": "Updatable component type.", + "type": "string" + }, + "version": { + "description": "Version of the prerequisite.", + "type": "string" + }, + "packageName": { + "description": "Friendly name of the prerequisite.", + "type": "string" + } + } + }, + "Update": { + "description": "Update details", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "description": "Update properties", + "type": "object", + "$ref": "#/definitions/UpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateProperties": { + "description": "Details of a singular Update in HCI Cluster", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Updates proxy resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "installedDate": { + "description": "Date that the update was installed.", + "type": "string", + "format": "date-time" + }, + "description": { + "description": "Description of the update.", + "type": "string" + }, + "state": { + "description": "State of the update as it relates to this stamp.", + "type": "string", + "enum": [ + "HasPrerequisite", + "Obsolete", + "Ready", + "NotApplicableBecauseAnotherUpdateIsInProgress", + "Preparing", + "Installing", + "Installed", + "PreparationFailed", + "InstallationFailed", + "Invalid", + "Recalled", + "Downloading", + "DownloadFailed", + "HealthChecking", + "HealthCheckFailed", + "ReadyToInstall", + "ScanInProgress", + "ScanFailed" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "prerequisites": { + "description": "If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.", + "type": "array", + "items": { + "$ref": "#/definitions/UpdatePrerequisite" + }, + "x-ms-identifiers": [ + "packageName" + ] + }, + "componentVersions": { + "description": "An array of component versions for a Solution Bundle update, and an empty array otherwise. ", + "type": "array", + "items": { + "$ref": "#/definitions/PackageVersionInfo" + }, + "x-ms-client-flatten": true, + "x-ms-identifiers": [ + "version" + ] + }, + "rebootRequired": { + "type": "object", + "$ref": "#/definitions/RebootRequirement", + "x-ms-client-flatten": true + }, + "healthState": { + "description": "Overall health state for update-specific health checks.", + "type": "object", + "$ref": "#/definitions/HealthState", + "x-ms-client-flatten": true + }, + "healthCheckResult": { + "description": "An array of PrecheckResult objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PrecheckResult" + }, + "x-ms-client-flatten": true + }, + "healthCheckDate": { + "description": "Last time the package-specific checks were run.", + "type": "string", + "format": "date-time" + }, + "packagePath": { + "description": "Path where the update package is available.", + "type": "string" + }, + "packageSizeInMb": { + "description": "Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.", + "type": "number" + }, + "displayName": { + "description": "Display name of the Update", + "type": "string" + }, + "version": { + "description": "Version of the update.", + "type": "string" + }, + "publisher": { + "description": "Publisher of the update package.", + "type": "string" + }, + "releaseLink": { + "description": "Link to release notes for the update.", + "type": "string" + }, + "availabilityType": { + "description": "Indicates the way the update content can be downloaded.", + "type": "string", + "enum": [ + "Local", + "Online", + "Notify" + ], + "x-ms-enum": { + "name": "availabilityType", + "modelAsString": true + } + }, + "packageType": { + "description": "Customer-visible type of the update.", + "type": "string" + }, + "additionalProperties": { + "description": "Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.", + "type": "string" + }, + "updateStateProperties": { + "description": "Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.", + "type": "object", + "$ref": "#/definitions/UpdateStateProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateStateProperties": { + "description": "Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.", + "type": "object", + "properties": { + "progressPercentage": { + "description": "Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.", + "type": "number" + }, + "notifyMessage": { + "description": "Brief message with instructions for updates of AvailabilityType Notify.", + "type": "string" + } + } + }, + "PackageVersionInfo": { + "description": "Current version of each updatable component.", + "type": "object", + "properties": { + "packageType": { + "description": "Package type", + "type": "string" + }, + "version": { + "description": "Package version", + "type": "string" + }, + "lastUpdated": { + "description": "Last time this component was updated.", + "type": "string", + "format": "date-time" + } + } + }, + "RebootRequirement": { + "type": "string", + "enum": [ + "Unknown", + "True", + "False" + ], + "x-ms-enum": { + "name": "RebootRequirement", + "modelAsString": true + } + }, + "HealthState": { + "type": "string", + "enum": [ + "Unknown", + "Success", + "Failure", + "Warning", + "Error", + "InProgress" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true + } + }, + "PrecheckResult": { + "properties": { + "name": { + "description": "Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer.", + "type": "string" + }, + "tags": { + "description": "Key-value pairs that allow grouping/filtering individual tests.", + "type": "object", + "properties": { + "key": { + "description": "Key that allow grouping/filtering individual tests.", + "type": "string" + }, + "value": { + "description": "Value of the key that allow grouping/filtering individual tests.", + "type": "string" + } + } + }, + "title": { + "description": "User-facing name; one or more sentences indicating the direct issue.", + "type": "string" + }, + "status": { + "description": "The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "InProgress" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "severity": { + "description": "Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity.", + "type": "string", + "enum": [ + "Critical", + "Warning", + "Informational", + "Hidden" + ], + "x-ms-enum": { + "name": "severity", + "modelAsString": true + } + }, + "description": { + "description": "Detailed overview of the issue and what impact the issue has on the stamp.", + "type": "string" + }, + "remediation": { + "description": "Set of steps that can be taken to resolve the issue found.", + "type": "string" + }, + "targetResourceID": { + "description": "The unique identifier for the affected resource (such as a node or drive).", + "type": "string" + }, + "targetResourceName": { + "description": "The name of the affected resource.", + "type": "string" + }, + "timestamp": { + "description": "The Time in which the HealthCheck was called.", + "type": "string", + "format": "date-time" + }, + "additionalData": { + "description": "Property bag of key value pairs for additional information.", + "type": "string" + }, + "healthCheckSource": { + "description": "The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster).", + "type": "string" + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "UpdateNameParameter": { + "name": "updateName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Update", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/readme.md b/specification/azurestackhci/resource-manager/readme.md index 3483a988ea22..34dbf76efaee 100644 --- a/specification/azurestackhci/resource-manager/readme.md +++ b/specification/azurestackhci/resource-manager/readme.md @@ -29,7 +29,7 @@ title: AzureStackHCIClient description: Azure Stack HCI management service openapi-type: arm openapi-subtype: rpaas -tag: package-2023-02 +tag: package-2023-03 ``` ## Suppression @@ -58,11 +58,28 @@ directive: ``` +### Tag: package-2023-03 + +These settings apply only when `--tag=package-2023-03` is specified on the command line. + +```yaml $(tag) == 'package-2023-03' +input-file: + - Microsoft.AzureStackHCI/stable/2023-03-01/arcSettings.json + - Microsoft.AzureStackHCI/stable/2023-03-01/clusters.json + - Microsoft.AzureStackHCI/stable/2023-03-01/extensions.json + - Microsoft.AzureStackHCI/stable/2023-03-01/offers.json + - Microsoft.AzureStackHCI/stable/2023-03-01/operations.json + - Microsoft.AzureStackHCI/stable/2023-03-01/publishers.json + - Microsoft.AzureStackHCI/stable/2023-03-01/skus.json + - Microsoft.AzureStackHCI/stable/2023-03-01/updateRuns.json + - Microsoft.AzureStackHCI/stable/2023-03-01/updateSummaries.json + - Microsoft.AzureStackHCI/stable/2023-03-01/updates.json +``` ### Tag: package-2023-02 These settings apply only when `--tag=package-2023-02` is specified on the command line. -```yaml $(tag) == 'package-2023-02' +``` yaml $(tag) == 'package-2023-02' input-file: - Microsoft.AzureStackHCI/stable/2023-02-01/arcSettings.json - Microsoft.AzureStackHCI/stable/2023-02-01/clusters.json @@ -75,6 +92,7 @@ input-file: - Microsoft.AzureStackHCI/stable/2023-02-01/updateSummaries.json - Microsoft.AzureStackHCI/stable/2023-02-01/updates.json ``` + ### Tag: package-2022-12 These settings apply only when `--tag=package-2022-12` is specified on the command line.