diff --git a/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/appliances.json b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/appliances.json new file mode 100644 index 000000000000..fa359cd78aeb --- /dev/null +++ b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/appliances.json @@ -0,0 +1,1209 @@ +{ + "swagger": "2.0", + "info": { + "version": "2025-03-01-preview", + "title": "appliances", + "description": "The appliances Rest API spec." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ResourceConnector/operations": { + "get": { + "tags": [ + "appliances" + ], + "operationId": "Appliances_ListOperations", + "description": "Lists all available Appliances operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Operation details.", + "schema": { + "$ref": "#/definitions/applianceOperationsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Appliances operations": { + "$ref": "./examples/AppliancesListOperations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ResourceConnector/appliances": { + "get": { + "tags": [ + "appliances" + ], + "operationId": "Appliances_ListBySubscription", + "summary": "Gets a list of Appliances in a subscription.", + "description": "Gets a list of Appliances in the specified subscription. The operation returns properties of each Appliance", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/applianceListResult" + } + }, + "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" + }, + "x-ms-examples": { + "List Appliances by subscription": { + "$ref": "./examples/AppliancesListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ResourceConnector/telemetryconfig": { + "get": { + "tags": [ + "appliances" + ], + "operationId": "Appliances_GetTelemetryConfig", + "summary": "Gets the telemetry config.", + "description": "Gets the telemetry config.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/applianceGetTelemetryConfigResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetTelemetryConfig Appliance": { + "$ref": "./examples/TelemetryConfig.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances": { + "get": { + "tags": [ + "appliances" + ], + "operationId": "Appliances_ListByResourceGroup", + "summary": "Gets a list of Appliances in the specified subscription and resource group.", + "description": "Gets a list of Appliances in the specified subscription and resource group. The operation returns properties of each Appliance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/applianceListResult" + } + }, + "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" + }, + "x-ms-examples": { + "List Appliances by resource group": { + "$ref": "./examples/AppliancesListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}": { + "get": { + "tags": [ + "appliances" + ], + "operationId": "Appliances_Get", + "summary": "Gets an Appliance.", + "description": "Gets the details of an Appliance with a specified resource group and name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/appliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Appliance": { + "$ref": "./examples/AppliancesGet.json" + } + } + }, + "put": { + "tags": [ + "appliances" + ], + "operationId": "Appliances_CreateOrUpdate", + "summary": "Creates or updates an Appliance.", + "description": "Creates or updates an Appliance in the specified Subscription and Resource Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/appliance" + }, + "description": "Parameters supplied to create or update an Appliance." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/appliance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/appliance" + } + }, + "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/Update Appliance": { + "$ref": "./examples/AppliancesCreate_Update.json" + }, + "Start proxy update operation": { + "$ref": "./examples/AppliancesUpdateProxy.json" + } + } + }, + "delete": { + "tags": [ + "appliances" + ], + "operationId": "Appliances_Delete", + "summary": "Deletes an Appliance.", + "description": "Deletes an Appliance with the specified Resource Name, Resource Group, and Subscription Id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "NoContent. The response indicates the appliance resource is already deleted." + }, + "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 Appliance": { + "$ref": "./examples/AppliancesDelete.json" + } + } + }, + "patch": { + "tags": [ + "appliances" + ], + "operationId": "Appliances_Update", + "summary": "Updates an Appliance.", + "description": "Updates an Appliance with the specified Resource Name in the specified Resource Group and Subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/patchableAppliance" + }, + "description": "The updatable fields of an existing Appliance." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/appliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Appliance": { + "$ref": "./examples/AppliancesPatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "appliances" + ], + "operationId": "Appliances_ListClusterUserCredential", + "summary": "Returns the cluster user credential.", + "description": "Returns the cluster user credentials for the dedicated appliance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/applianceListCredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListClusterUserCredentialAppliance": { + "$ref": "./examples/AppliancesListClusterUserCredential.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}/listkeys": { + "post": { + "tags": [ + "appliances" + ], + "operationId": "Appliances_ListKeys", + "summary": "Gets the management config.", + "description": "Returns the cluster customer credentials for the dedicated appliance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "artifactType", + "in": "query", + "type": "string", + "description": "This sets the type of artifact being returned, when empty no artifact endpoint is returned." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/applianceListKeysResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListKeys Appliance": { + "$ref": "./examples/AppliancesListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceConnector/appliances/{resourceName}/upgradeGraphs/{upgradeGraph}": { + "get": { + "tags": [ + "appliances" + ], + "operationId": "Appliances_GetUpgradeGraph", + "summary": "Gets an Appliance upgrade graph.", + "description": "Gets the upgrade graph of an Appliance with a specified resource group and name and specific release train.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "upgradeGraph", + "in": "path", + "required": true, + "type": "string", + "description": "Upgrade graph version, ex - stable" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpgradeGraph" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Appliance Upgrade Graph": { + "$ref": "./examples/UpgradeGraph.json" + } + } + } + } + }, + "parameters": { + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "Appliances name." + } + }, + "definitions": { + "ArtifactProfile": { + "description": "Appliance ArtifactProfile definition.", + "type": "object", + "properties": { + "endpoint": { + "description": "Endpoint is the URL to upload artifacts to.", + "type": "string", + "readOnly": true + } + } + }, + "ArtifactType": { + "description": "Appliance ArtifactType definition.", + "type": "string", + "enum": [ + "LogsArtifactType" + ], + "x-ms-enum": { + "name": "ArtifactType", + "modelAsString": true + } + }, + "DnsConfiguration": { + "description": "Contains DNS information about the Appliance", + "type": "object", + "properties": { + "version": { + "description": "Version of the DNS configuration.", + "type": "string" + } + } + }, + "Event": { + "description": "Event contains information about customer driven, platform driven, or unplanned events that occurred on the Appliance", + "type": "object", + "properties": { + "code": { + "description": "Code is used to break down the event further to identify why it occurred.", + "type": "string", + "readOnly": true + }, + "message": { + "description": " Message is intended to be actionable and should be used to inform the user of the event.", + "type": "string", + "readOnly": true + }, + "severity": { + "description": " Severity is the classification of the event to relay the importance of the event.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status is used to represent the outcome of the event.", + "type": "string", + "readOnly": true + }, + "timestamp": { + "description": "Timestamp is the time the event occurred", + "type": "integer", + "readOnly": true, + "format": "int64" + }, + "type": { + "description": "The type of event is used to classify how the event was initiated ", + "type": "string", + "readOnly": true + } + } + }, + "GatewayConfiguration": { + "description": "Contains Arc Gateway information about the Appliance", + "type": "object", + "properties": { + "version": { + "description": "Version of the Arc Gateway configuration.", + "type": "string" + } + } + }, + "HybridConnectionConfig": { + "description": "Contains the REP (rendezvous endpoint) and “Listener” access token from notification service (NS).", + "type": "object", + "properties": { + "expirationTime": { + "description": "Timestamp when this token will be expired.", + "type": "integer", + "readOnly": true, + "format": "int64" + }, + "hybridConnectionName": { + "description": "Name of the connection", + "type": "string", + "readOnly": true + }, + "relay": { + "description": "Name of the notification service.", + "type": "string", + "readOnly": true + }, + "token": { + "description": "Listener access token", + "type": "string", + "readOnly": true + } + } + }, + "Identity": { + "description": "Identity for the resource.", + "type": "object", + "properties": { + "principalId": { + "description": "The principal ID of resource identity.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant ID of resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The identity type.", + "type": "string", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": true + } + } + } + }, + "NetworkProfile": { + "description": "Contains network information about the Appliance", + "type": "object", + "properties": { + "dnsConfiguration": { + "$ref": "#/definitions/DnsConfiguration" + }, + "gatewayConfiguration": { + "$ref": "#/definitions/GatewayConfiguration" + }, + "proxyConfiguration": { + "$ref": "#/definitions/ProxyConfiguration" + } + } + }, + "ProxyConfiguration": { + "description": "Contains proxy information about the Appliance", + "type": "object", + "properties": { + "version": { + "description": "Version of the proxy configuration.", + "type": "string" + } + } + }, + "SSHKey": { + "description": "Appliance SSHKey definition.", + "type": "object", + "properties": { + "certificate": { + "description": "Certificate associated with the public key if the key is signed.", + "type": "string", + "readOnly": true + }, + "creationTimeStamp": { + "description": "Certificate creation timestamp (Unix).", + "type": "integer", + "readOnly": true, + "format": "int64" + }, + "expirationTimeStamp": { + "description": "Certificate expiration timestamp (Unix).", + "type": "integer", + "readOnly": true, + "format": "int64" + }, + "privateKey": { + "description": "Private Key.", + "type": "string", + "readOnly": true + }, + "publicKey": { + "description": "Public Key.", + "type": "string", + "readOnly": true + } + } + }, + "SSHKeyType": { + "description": "Appliance SSHKeyType definition.", + "type": "string", + "enum": [ + "SSHCustomerUser", + "ManagementCAKey", + "LogsKey", + "UserManagementKey", + "ScopedAccessKey" + ], + "x-ms-enum": { + "name": "SSHKeyType", + "modelAsString": true + } + }, + "SupportedVersion": { + "description": "The SupportedVersion object for appliance.", + "type": "object", + "properties": { + "metadata": { + "$ref": "#/definitions/SupportedVersionMetadata", + "description": "This is the metadata of the supported newer version.", + "type": "object", + "readOnly": true + }, + "version": { + "description": "The newer version available for upgrade.", + "type": "string", + "readOnly": true + } + } + }, + "SupportedVersionCatalogVersion": { + "description": "The SupportedVersionCatalogVersion object for appliance.", + "type": "object", + "properties": { + "data": { + "$ref": "#/definitions/SupportedVersionCatalogVersionData", + "description": "The newer supported version catalog version data.", + "type": "object", + "readOnly": true + }, + "name": { + "description": "The catalog version name for the version available for upgrade.", + "type": "string", + "readOnly": true + }, + "namespace": { + "description": "The catalog version namespace for the version available for upgrade.", + "type": "string", + "readOnly": true + } + } + }, + "SupportedVersionCatalogVersionData": { + "description": "The SupportedVersionCatalogVersionData object for appliance.", + "type": "object", + "properties": { + "audience": { + "description": "The image audience name for the version available for upgrade.", + "type": "string", + "readOnly": true + }, + "catalog": { + "description": "The image catalog name for the version available for upgrade.", + "type": "string", + "readOnly": true + }, + "offer": { + "description": "The image offer name for the version available for upgrade.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The image version for the version available for upgrade.", + "type": "string", + "readOnly": true + } + } + }, + "SupportedVersionMetadata": { + "description": "The SupportedVersionMetadata object for appliance.", + "type": "object", + "properties": { + "catalogVersion": { + "$ref": "#/definitions/SupportedVersionCatalogVersion", + "description": "The newer supported version catalog version.", + "type": "object", + "readOnly": true + } + } + }, + "UpgradeGraph": { + "description": "The Upgrade Graph for appliance.", + "type": "object", + "properties": { + "id": { + "description": "The appliance resource path", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The release train name.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/UpgradeGraphProperties", + "description": "The properties of supported version", + "type": "object" + } + } + }, + "UpgradeGraphProperties": { + "description": "The Upgrade Graph Properties for appliance.", + "type": "object", + "properties": { + "applianceVersion": { + "description": "The current appliance version", + "type": "string", + "readOnly": true + }, + "supportedVersions": { + "description": "This contains the current version and supported upgrade versions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SupportedVersion" + }, + "x-ms-identifiers": [] + } + } + }, + "appliance": { + "description": "Appliances definition.", + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/Identity", + "description": "Identity for the resource." + }, + "properties": { + "$ref": "#/definitions/applianceProperties", + "description": "The set of properties specific to an Appliance", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "applianceCredentialKubeconfig": { + "description": "Cluster User Credential appliance.", + "type": "object", + "properties": { + "name": { + "description": "Name which contains the role of the kubeconfig.", + "type": "string", + "readOnly": true, + "enum": [ + "clusterUser", + "clusterCustomerUser" + ], + "x-ms-enum": { + "name": "AccessProfileType", + "modelAsString": true + } + }, + "value": { + "description": "Contains the kubeconfig value.", + "type": "string", + "readOnly": true + } + } + }, + "applianceGetTelemetryConfigResult": { + "description": "The Get Telemetry Config Result appliance.", + "type": "object", + "properties": { + "telemetryInstrumentationKey": { + "description": "Telemetry instrumentation key.", + "type": "string", + "readOnly": true + } + } + }, + "applianceListCredentialResults": { + "description": "The List Cluster User Credential appliance.", + "type": "object", + "properties": { + "hybridConnectionConfig": { + "$ref": "#/definitions/HybridConnectionConfig", + "description": "Contains the REP (rendezvous endpoint) and “Listener” access token from notification service (NS).", + "readOnly": true + }, + "kubeconfigs": { + "description": "The list of appliance kubeconfigs.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/applianceCredentialKubeconfig" + }, + "x-ms-identifiers": [] + } + } + }, + "applianceListKeysResults": { + "description": "The List Cluster Keys Results appliance.", + "type": "object", + "properties": { + "artifactProfiles": { + "description": "Map of artifacts that contains a list of ArtifactProfile used to upload artifacts such as logs.", + "type": "object", + "readOnly": true, + "additionalProperties": { + "$ref": "#/definitions/ArtifactProfile" + } + }, + "kubeconfigs": { + "description": "The list of appliance kubeconfigs.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/applianceCredentialKubeconfig" + }, + "x-ms-identifiers": [] + }, + "sshKeys": { + "description": "Map of Customer User Public, Private SSH Keys and Certificate when available.", + "type": "object", + "readOnly": true, + "additionalProperties": { + "$ref": "#/definitions/SSHKey" + } + } + } + }, + "applianceListResult": { + "description": "The List Appliances operation response.", + "type": "object", + "properties": { + "nextLink": { + "description": "The URL to use for getting the next set of results.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The list of Appliances.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/appliance" + } + } + } + }, + "applianceOperation": { + "description": "Appliances operation.", + "type": "object", + "properties": { + "display": { + "$ref": "#/definitions/applianceOperationValueDisplay", + "description": "Describes the properties of an Appliances Operation Value Display.", + "x-ms-client-flatten": true + }, + "isDataAction": { + "description": "Is this Operation a data plane operation", + "type": "boolean", + "readOnly": true + }, + "name": { + "description": "The name of the compute operation.", + "type": "string", + "readOnly": true + }, + "origin": { + "description": "The origin of the compute operation.", + "type": "string", + "readOnly": true + } + } + }, + "applianceOperationValueDisplay": { + "description": "Describes the properties of an Appliances Operation Value Display.", + "type": "object", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The display name of the compute operation.", + "type": "string", + "readOnly": true + }, + "provider": { + "description": "The resource provider for the operation.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The display name of the resource the operation applies to.", + "type": "string", + "readOnly": true + } + } + }, + "applianceOperationsList": { + "description": "Lists of Appliances operations.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "Next page of operations.", + "type": "string" + }, + "value": { + "description": "Array of applianceOperation", + "type": "array", + "items": { + "$ref": "#/definitions/applianceOperation" + }, + "x-ms-identifiers": [] + } + } + }, + "applianceProperties": { + "description": "Properties for an appliance.", + "type": "object", + "properties": { + "distro": { + "description": "Represents a supported Fabric/Infra. (AKSEdge etc...).", + "type": "string", + "enum": [ + "AKSEdge" + ], + "x-ms-enum": { + "name": "distro", + "modelAsString": true + }, + "default": "AKSEdge" + }, + "events": { + "description": "A list of events that occurred on the Appliance to relay information to the user.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [] + }, + "infrastructureConfig": { + "description": "Contains infrastructure information about the Appliance", + "type": "object", + "properties": { + "provider": { + "description": "Information about the connected appliance.", + "type": "string", + "enum": [ + "VMWare", + "HCI", + "SCVMM" + ], + "x-ms-enum": { + "name": "provider", + "modelAsString": true + } + } + } + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile" + }, + "provisioningState": { + "description": "The current deployment or provisioning state, which only appears in the response.", + "type": "string", + "readOnly": true + }, + "publicKey": { + "description": "Certificates pair used to download MSI certificate from HIS. Can only be set once.", + "type": "string" + }, + "status": { + "description": "Appliance’s health and state of connection to on-prem. This list of values is not exhaustive.", + "type": "string", + "readOnly": true, + "enum": [ + "WaitingForHeartbeat", + "Validating", + "Connecting", + "Connected", + "Running", + "PreparingForUpgrade", + "ETCDSnapshotFailed", + "UpgradePrerequisitesCompleted", + "ValidatingSFSConnectivity", + "ValidatingImageDownload", + "ValidatingImageUpload", + "ValidatingETCDHealth", + "PreUpgrade", + "UpgradingKVAIO", + "WaitingForKVAIO", + "ImagePending", + "ImageProvisioning", + "ImageProvisioned", + "ImageDownloading", + "ImageDownloaded", + "ImageDeprovisioning", + "ImageUnknown", + "UpdatingCloudOperator", + "WaitingForCloudOperator", + "UpdatingCAPI", + "UpdatingCluster", + "PostUpgrade", + "UpgradeComplete", + "UpgradeClusterExtensionFailedToDelete", + "UpgradeFailed", + "NetworkProxyUpdatePreparing", + "NetworkProxyUpdating", + "NetworkProxyUpdateComplete", + "NetworkProxyUpdateFailed", + "NetworkDNSUpdatePreparing", + "NetworkDNSUpdating", + "NetworkDNSUpdateComplete", + "NetworkDNSUpdateFailed", + "ArcGatewayUpdatePreparing", + "ArcGatewayUpdating", + "ArcGatewayUpdateComplete", + "ArcGatewayUpdateFailed", + "Offline", + "None" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "version": { + "description": "Version of the Appliance", + "type": "string" + } + } + }, + "patchableAppliance": { + "description": "The Appliances patchable resource definition.", + "type": "object", + "x-ms-azure-resource": true, + "x-ms-client-flatten": true, + "properties": { + "tags": { + "description": "Resource tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } +} diff --git a/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesCreate_Update.json b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesCreate_Update.json new file mode 100644 index 000000000000..426d46a4e8d2 --- /dev/null +++ b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesCreate_Update.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2025-03-01-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "testresourcegroup", + "resourceName": "appliance01", + "identity": { + "type": "SystemAssigned" + }, + "parameters": { + "location": "West US", + "properties": { + "distro": "AKSEdge", + "infrastructureConfig": { + "provider": "VMWare" + } + } + } + }, + "description": "HTTP 201 is returned for a successful create operation. HTTP 200 is returned for a successful update operation.", + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ResourceConnector/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/default?api-version=2025-03-01-preview" + }, + "body": { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testrg/providers/Microsoft.ResourceConnector/appliances/appliance01", + "name": "appliance01", + "type": "Microsoft.ResourceConnector/appliances", + "location": "West US", + "properties": { + "distro": "AKSEdge", + "provisioningState": "Creating", + "status": "WaitingForHeartbeat", + "infrastructureConfig": { + "provider": "VMWare" + }, + "networkProfile": { + "proxyConfiguration": { + "version": "1744221145" + }, + "dnsConfiguration": { + "version": "1744221145" + }, + "gatewayConfiguration": { + "version": "1744221145" + } + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "111111-1111-1111-1111-111111111111" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2025-04-09T17:52:25.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2025-04-09T17:52:25.0928001Z" + } + } + }, + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ResourceConnector/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/default?api-version=2025-03-01-preview" + }, + "body": { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testrg/providers/Microsoft.ResourceConnector/appliances/appliance01", + "name": "appliance01", + "type": "Microsoft.ResourceConnector/appliances", + "location": "West US", + "properties": { + "distro": "AKSEdge", + "version": "1.0.1", + "provisioningState": "Updating", + "status": "Running", + "publicKey": "xxxxxxxx", + "infrastructureConfig": { + "provider": "VMWare" + }, + "networkProfile": { + "proxyConfiguration": { + "version": "1744221145" + }, + "dnsConfiguration": { + "version": "1744221145" + }, + "gatewayConfiguration": { + "version": "1744221145" + } + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "111111-1111-1111-1111-111111111111" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2025-04-09T17:52:25.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2025-04-09T17:52:25.0928001Z" + } + } + } + } +} diff --git a/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesDelete.json b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesDelete.json new file mode 100644 index 000000000000..2973a87aff95 --- /dev/null +++ b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "testresourcegroup", + "resourceName": "appliance01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ResourceConnector/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2025-03-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ResourceConnector/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/default?api-version=2025-03-01-preview" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ResourceConnector/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/default?api-version=2025-03-01-preview" + } + } + } +} diff --git a/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesGet.json b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesGet.json new file mode 100644 index 000000000000..2c74a75f0130 --- /dev/null +++ b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesGet.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2025-03-01-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "testresourcegroup", + "resourceName": "appliance01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ResourceConnector/appliances/appliance01", + "name": "appliance01", + "type": "Microsoft.ResourceConnector/appliances", + "location": "West US", + "properties": { + "distro": "AKSEdge", + "version": "1.0.1", + "provisioningState": "Succeeded", + "status": "Running", + "publicKey": "xxxxxxxx", + "infrastructureConfig": { + "provider": "VMWare" + }, + "networkProfile": { + "proxyConfiguration": { + "version": "1744221145" + }, + "dnsConfiguration": { + "version": "1744221145" + }, + "gatewayConfiguration": { + "version": "1744221145" + } + }, + "events": [ + { + "type": "PlatformInitiatedCloudManagedUpgrade", + "code": "InvalidLogin", + "status": "Failed", + "message": "Cloud managed upgrade failed with error: InvalidLogin", + "severity": "Error", + "timestamp": 1744221145 + }, + { + "type": "Unplanned", + "code": "VCenterNotReachable", + "status": "Failed", + "message": "VCenter is not reachable from the resource bridge. Please check the network connectivity.", + "severity": "Error", + "timestamp": 1644221145 + } + ] + }, + "identity": { + "type": "SystemAssigned", + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "111111-1111-1111-1111-111111111111" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2025-04-09T17:52:25.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2025-04-09T17:52:25.0928001Z" + } + } + } + } +} diff --git a/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListByResourceGroup.json b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListByResourceGroup.json new file mode 100644 index 000000000000..f4f24ff0c3e8 --- /dev/null +++ b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListByResourceGroup.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2025-03-01-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "testresourcegroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ResourceConnector/appliances/appliance01", + "name": "appliance01", + "type": "Microsoft.ResourceConnector/appliances", + "location": "West US", + "properties": { + "distro": "AKSEdge", + "version": "1.0.1", + "provisioningState": "Succeeded", + "status": "Running", + "publicKey": "xxxxxxxx", + "infrastructureConfig": { + "provider": "VMWare" + }, + "networkProfile": { + "proxyConfiguration": { + "version": "1744221145" + }, + "dnsConfiguration": { + "version": "1744221145" + }, + "gatewayConfiguration": { + "version": "1744221145" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2025-04-09T17:52:25.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2025-04-09T17:52:25.0928001Z" + } + }, + { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ResourceConnector/appliances/appliance02", + "name": "appliance02", + "type": "Microsoft.ResourceConnector/appliances", + "location": "West US", + "properties": { + "distro": "AKSEdge", + "version": "1.0.1", + "provisioningState": "Succeeded", + "status": "Running", + "publicKey": "xxxxxxxx", + "infrastructureConfig": { + "provider": "VMWare" + }, + "networkProfile": { + "proxyConfiguration": { + "version": "1744221145" + }, + "dnsConfiguration": { + "version": "1744221145" + }, + "gatewayConfiguration": { + "version": "1744221145" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2025-04-09T17:52:25.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2025-04-09T17:52:25.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListBySubscription.json b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListBySubscription.json new file mode 100644 index 000000000000..7c4b84a2d427 --- /dev/null +++ b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListBySubscription.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2025-03-01-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ResourceConnector/appliances/appliance01", + "name": "appliance01", + "type": "Microsoft.ResourceConnector/appliances", + "location": "West US", + "properties": { + "distro": "AKSEdge", + "version": "1.0.1", + "provisioningState": "Succeeded", + "status": "Running", + "publicKey": "xxxxxxxx", + "infrastructureConfig": { + "provider": "VMWare" + }, + "networkProfile": { + "proxyConfiguration": { + "version": "1744221145" + }, + "dnsConfiguration": { + "version": "1744221145" + }, + "gatewayConfiguration": { + "version": "1744221145" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2025-04-09T17:52:25.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2025-04-09T17:52:25.0928001Z" + } + }, + { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ResourceConnector/appliances/appliance02", + "name": "appliance02", + "type": "Microsoft.ResourceConnector/appliances", + "location": "West US", + "properties": { + "distro": "AKSEdge", + "version": "1.0.1", + "provisioningState": "Succeeded", + "status": "Running", + "publicKey": "xxxxxxxx", + "infrastructureConfig": { + "provider": "VMWare" + }, + "networkProfile": { + "proxyConfiguration": { + "version": "1744221145" + }, + "dnsConfiguration": { + "version": "1744221145" + }, + "gatewayConfiguration": { + "version": "1744221145" + } + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2025-04-09T17:52:25.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2025-04-09T17:52:25.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListClusterUserCredential.json b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListClusterUserCredential.json new file mode 100644 index 000000000000..6786ff67bc11 --- /dev/null +++ b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListClusterUserCredential.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-03-01-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "testresourcegroup", + "resourceName": "appliance01" + }, + "responses": { + "200": { + "body": { + "hybridConnectionConfig": { + "expirationTime": 123456789, + "hybridConnectionName": "provider/type/bc36ffcf318d5bedfc05ba8b0628dba", + "token": "mockSecretOtherprovider/type/bc36ffcf318d5bedfc05ba91c157ReceiverToken", + "relay": "relayName" + }, + "kubeconfigs": [ + { + "name": "kubeconfigName1", + "value": "xxxxxxxxxxxxx" + } + ] + } + } + } +} diff --git a/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListKeys.json b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListKeys.json new file mode 100644 index 000000000000..8eb7fa9065a1 --- /dev/null +++ b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListKeys.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2025-03-01-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "testresourcegroup", + "resourceName": "appliance01" + }, + "responses": { + "200": { + "body": { + "artifactProfiles": { + "LogsArtifactType": { + "endpoint": "https://.blob.core.windows.net/?" + } + }, + "kubeconfigs": [ + { + "name": "kubeconfigName1", + "value": "xxxxxxxxxxxxx" + } + ], + "sshKeys": { + "SSHCustomerUser": { + "privateKey": "xxxxxxxx", + "publicKey": "xxxxxxxx" + }, + "ManagementCAKey": { + "publicKey": "" + }, + "LogsKey": { + "privateKey": "", + "creationTimeStamp": 1660946559, + "expirationTimeStamp": 1724119358, + "certificate": "" + }, + "UserManagementKey": { + "privateKey": "", + "creationTimeStamp": 1660946559, + "expirationTimeStamp": 1724119358, + "certificate": "" + }, + "ScopedAccessKey": { + "privateKey": "", + "creationTimeStamp": 1660946559, + "expirationTimeStamp": 1724119358, + "certificate": "" + } + } + } + } + } +} diff --git a/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListOperations.json b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListOperations.json new file mode 100644 index 000000000000..1ad8bf6acbf4 --- /dev/null +++ b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesListOperations.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2025-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ResourceConnector/operations/read", + "display": { + "description": "Gets list of Available Operations for Appliances", + "operation": "List Available Operations for Appliances", + "provider": "Microsoft ResourceConnector", + "resource": "Operations" + }, + "origin": "user,system", + "isDataAction": false + }, + { + "name": "Microsoft.ResourceConnector/register/action", + "display": { + "description": "Registers the subscription for Appliance resource provider and enables the creation of Appliance.", + "operation": "Registers the Appliance Resource Provider", + "provider": "Microsoft ResourceConnector", + "resource": "Appliances Resource Provider" + }, + "origin": "user,system", + "isDataAction": false + }, + { + "name": "Microsoft.ResourceConnector/appliances/read", + "display": { + "description": "Gets an Appliance resource", + "operation": "Get Appliance", + "provider": "Microsoft ResourceConnector", + "resource": "Appliances" + }, + "origin": "user,system", + "isDataAction": false + }, + { + "name": "Microsoft.ResourceConnector/appliances/write", + "display": { + "description": "Creates or Updates Appliance resource", + "operation": "Create or Update Appliance", + "provider": "Microsoft ResourceConnector", + "resource": "Appliances" + }, + "origin": "user,system", + "isDataAction": false + }, + { + "name": "Microsoft.ResourceConnector/appliances/delete", + "display": { + "description": "Deletes Appliance resource", + "operation": "Delete Appliance", + "provider": "Microsoft ResourceConnector", + "resource": "Appliances" + }, + "origin": "user,system", + "isDataAction": false + }, + { + "name": "Microsoft.ResourceConnector/appliances/listClusterUserCredential", + "display": { + "description": "Get an appliance cluster user credential", + "operation": "List User Cluster Credential", + "provider": "Microsoft ResourceConnector", + "resource": "Appliances" + }, + "origin": "user,system", + "isDataAction": false + }, + { + "name": "Microsoft.ResourceConnector/locations/operationsstatus/read", + "display": { + "description": "Get result of Appliance operation", + "operation": "Get status of Appliance operation", + "provider": "Microsoft ResourceConnector", + "resource": "Appliance Operation Status" + }, + "origin": "user,system", + "isDataAction": false + }, + { + "name": "Microsoft.ResourceConnector/locations/operationresults/read", + "display": { + "description": "Get result of Appliance operation", + "operation": "Get the status of Appliance operation", + "provider": "Microsoft ResourceConnector", + "resource": "Appliance Operation Result" + }, + "origin": "user,system", + "isDataAction": false + } + ] + } + } + } +} diff --git a/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesPatch.json b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesPatch.json new file mode 100644 index 000000000000..180ea6596394 --- /dev/null +++ b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesPatch.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2025-03-01-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "testresourcegroup", + "resourceName": "appliance01", + "parameters": { + "tags": { + "key": "value" + } + }, + "identity": { + "type": "SystemAssigned" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ResourceConnector/appliances/appliance01", + "name": "appliance01", + "type": "Microsoft.ResourceConnector/appliances", + "location": "West US", + "tags": { + "key": "value" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "Running", + "distro": "AKSEdge", + "version": "1.0.1", + "publicKey": "xxxxxxxx", + "infrastructureConfig": { + "provider": "VMWare" + }, + "networkProfile": { + "proxyConfiguration": { + "version": "1744221145" + }, + "dnsConfiguration": { + "version": "1744221145" + }, + "gatewayConfiguration": { + "version": "1744221145" + } + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "111111-1111-1111-1111-111111111111" + } + } + } + } +} diff --git a/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesUpdateProxy.json b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesUpdateProxy.json new file mode 100644 index 000000000000..4e74c0db7c8f --- /dev/null +++ b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/AppliancesUpdateProxy.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2025-03-01-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "testresourcegroup", + "resourceName": "appliance01", + "identity": { + "type": "SystemAssigned" + }, + "parameters": { + "location": "West US", + "properties": { + "distro": "AKSEdge", + "publicKey": "xxxxxxxx", + "infrastructureConfig": { + "provider": "VMWare" + }, + "networkProfile": { + "proxyConfiguration": { + "version": "latest" + } + } + } + } + }, + "description": "HTTP 200 is returned when the proxy update request is accepted. Check the async operation link for the operation status. HTTP 201 is not returned because this operation requires the resource to already exist.", + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ResourceConnector/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/default?api-version=2025-03-01-preview" + }, + "body": { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testrg/providers/Microsoft.ResourceConnector/appliances/appliance01", + "name": "appliance01", + "type": "Microsoft.ResourceConnector/appliances", + "location": "West US", + "properties": { + "distro": "AKSEdge", + "version": "1.0.1", + "provisioningState": "Updating", + "status": "NetworkProxyUpdatePreparing", + "publicKey": "xxxxxxxx", + "infrastructureConfig": { + "provider": "VMWare" + }, + "networkProfile": { + "proxyConfiguration": { + "version": "1750464301" + }, + "dnsConfiguration": { + "version": "1744221145" + }, + "gatewayConfiguration": { + "version": "1744221145" + } + } + }, + "identity": { + "type": "SystemAssigned", + "principalId": "11111111-1111-1111-1111-111111111111", + "tenantId": "111111-1111-1111-1111-111111111111" + }, + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2025-04-09T17:52:25.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2025-06-21T00:05:15.0000000Z" + } + } + } + } +} diff --git a/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/TelemetryConfig.json b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/TelemetryConfig.json new file mode 100644 index 000000000000..4b6da62c3770 --- /dev/null +++ b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/TelemetryConfig.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555" + }, + "responses": { + "200": { + "body": { + "telemetryInstrumentationKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + } + } +} diff --git a/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/UpgradeGraph.json b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/UpgradeGraph.json new file mode 100644 index 000000000000..214446d9161f --- /dev/null +++ b/specification/resourceconnector/resource-manager/Microsoft.ResourceConnector/preview/2025-03-01-preview/examples/UpgradeGraph.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2025-03-01-preview", + "subscriptionId": "11111111-2222-3333-4444-555555555555", + "resourceGroupName": "testresourcegroup", + "resourceName": "appliance01", + "upgradeGraph": "stable" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/testresourcegroup/providers/Microsoft.ResourceConnector/appliances/appliance01", + "name": "stable", + "properties": { + "applianceVersion": "1.0.0", + "supportedVersions": [ + { + "version": "1.0.1", + "metadata": { + "catalogVersion": { + "name": "cloudop-product-information", + "namespace": "cloudop-system", + "data": { + "offer": "arcappliance", + "version": "0.1.5.11115", + "catalog": "arc-appliance-stable-catalogs-ext", + "audience": "stable" + } + } + } + } + ] + } + } + } + } +} diff --git a/specification/resourceconnector/resource-manager/readme.md b/specification/resourceconnector/resource-manager/readme.md index 5b384ef97aa0..797c970114cb 100644 --- a/specification/resourceconnector/resource-manager/readme.md +++ b/specification/resourceconnector/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the appliance. ```yaml name: appliances openapi-type: arm -tag: package-2022-10-27 +tag: package-2025-03-01-preview ``` ### Tag: package-2021-10-31-preview @@ -57,6 +57,15 @@ input-file: - Microsoft.ResourceConnector/stable/2022-10-27/appliances.json ``` +### Tag: package-2025-03-01-preview + +These settings apply only when `--tag=package-2025-03-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2025-03-01-preview' +input-file: + - Microsoft.ResourceConnector/preview/2025-03-01-preview/appliances.json +``` + --- # Code Generation diff --git a/specification/resourceconnector/resource-manager/readme.ruby.md b/specification/resourceconnector/resource-manager/readme.ruby.md index 6353bb0012e8..d7adf9269937 100644 --- a/specification/resourceconnector/resource-manager/readme.ruby.md +++ b/specification/resourceconnector/resource-manager/readme.ruby.md @@ -36,4 +36,14 @@ Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2025-03-01-preview' && $(ruby) +namespace: Azure::ExtendedLocation::Mgmt::2025-03-01-preview +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_resource_connector/lib ``` \ No newline at end of file