diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json new file mode 100644 index 000000000000..3a785f5369d9 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json @@ -0,0 +1,3867 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridComputeManagementClient", + "description": "The Hybrid Compute Management Client.", + "version": "2023-06-20-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/validateLicense": { + "post": { + "tags": [ + "licenses" + ], + "operationId": "Licenses_ValidateLicense", + "description": "The operation to validate a license.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/License" + }, + "description": "Parameters supplied to the license validation operation." + } + ], + "responses": { + "200": { + "description": "Updated Resource", + "schema": { + "$ref": "#/definitions/License" + } + }, + "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-examples": { + "Validate a License": { + "$ref": "./examples/license/License_ValidateLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}": { + "put": { + "tags": [ + "licenses" + ], + "operationId": "Licenses_CreateOrUpdate", + "description": "The operation to create or update a license.", + "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/licenseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/License" + }, + "description": "Parameters supplied to the Create license operation." + } + ], + "responses": { + "200": { + "description": "Updated Resource", + "schema": { + "$ref": "#/definitions/License" + } + }, + "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-examples": { + "Create or Update a License": { + "$ref": "./examples/license/License_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "licenses" + ], + "operationId": "Licenses_Update", + "description": "The operation to update a license.", + "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/licenseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LicenseUpdate" + }, + "description": "Parameters supplied to the Update license operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/License" + } + }, + "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-examples": { + "Update a License": { + "$ref": "./examples/license/License_Update.json" + } + } + }, + "get": { + "tags": [ + "licenses" + ], + "operationId": "Licenses_Get", + "description": "Retrieves information about the view of a license.", + "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/licenseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/License" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get License": { + "$ref": "./examples/license/License_Get.json" + } + } + }, + "delete": { + "tags": [ + "licenses" + ], + "operationId": "Licenses_Delete", + "description": "The operation to delete a license.", + "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/licenseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "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-examples": { + "Delete a License": { + "$ref": "./examples/license/License_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses": { + "get": { + "tags": [ + "licenses" + ], + "operationId": "licenses_ListByResourceGroup", + "description": "The operation to get all licenses of a non-Azure machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$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/LicensesListResult" + } + }, + "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": { + "GET all Machine Extensions": { + "$ref": "./examples/license/License_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/licenses": { + "get": { + "tags": [ + "licenses" + ], + "operationId": "licenses_ListBySubscription", + "description": "The operation to get all licenses of a non-Azure machine", + "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/LicensesListResult" + } + }, + "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 Licenses by Subscription": { + "$ref": "./examples/license/License_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}": { + "put": { + "tags": [ + "machines" + ], + "operationId": "Machines_CreateOrUpdate", + "description": "The operation to create or update a hybrid machine. Please note some properties can be set only during machine creation.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Machine" + }, + "description": "Parameters supplied to the Create hybrid machine operation." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update a Machine": { + "$ref": "./examples/machine/Machines_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "machines" + ], + "operationId": "Machines_Update", + "description": "The operation to update a hybrid machine.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineUpdate" + }, + "description": "Parameters supplied to the Update hybrid machine operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a Machine": { + "$ref": "./examples/machine/Machines_Update.json" + } + } + }, + "delete": { + "tags": [ + "machines" + ], + "operationId": "Machines_Delete", + "description": "The operation to delete a hybrid machine.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "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-examples": { + "Delete a Machine": { + "$ref": "./examples/machine/Machines_Delete.json" + } + } + }, + "get": { + "tags": [ + "machines" + ], + "operationId": "Machines_Get", + "description": "Retrieves information about the model view or the instance view of a hybrid machine.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Machine": { + "$ref": "./examples/machine/Machines_Get.json" + }, + "Get Machine with License Profile Instance View": { + "$ref": "./examples/machine/Machines_Get_LicenseProfileInstanceView.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles/{licenseProfileName}": { + "put": { + "tags": [ + "licenseProfiles" + ], + "operationId": "LicenseProfiles_CreateOrUpdate", + "description": "The operation to create or update a license profile.", + "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/machineNameParameter" + }, + { + "$ref": "#/parameters/licenseProfileNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LicenseProfile" + }, + "description": "Parameters supplied to the Create license profile operation." + } + ], + "responses": { + "200": { + "description": "Updated Resource", + "schema": { + "$ref": "#/definitions/LicenseProfile" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/LicenseProfile" + }, + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "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-examples": { + "Create or Update a License Profile": { + "$ref": "./examples/licenseProfile/LicenseProfile_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "licenseProfiles" + ], + "operationId": "LicenseProfiles_Update", + "description": "The operation to update a license profile.", + "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/machineNameParameter" + }, + { + "$ref": "#/parameters/licenseProfileNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LicenseProfileUpdate" + }, + "description": "Parameters supplied to the Update license profile operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LicenseProfile" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "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-examples": { + "Update a License Profile": { + "$ref": "./examples/licenseProfile/LicenseProfile_Update.json" + } + } + }, + "get": { + "tags": [ + "licenseProfiles" + ], + "operationId": "LicenseProfiles_Get", + "description": "Retrieves information about the view of a license profile.", + "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/machineNameParameter" + }, + { + "$ref": "#/parameters/licenseProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LicenseProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get License Profile": { + "$ref": "./examples/licenseProfile/LicenseProfile_Get.json" + } + } + }, + "delete": { + "tags": [ + "licenseProfiles" + ], + "operationId": "LicenseProfiles_Delete", + "description": "The operation to delete a license profile.", + "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/machineNameParameter" + }, + { + "$ref": "#/parameters/licenseProfileNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "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-examples": { + "Delete a License Profile": { + "$ref": "./examples/licenseProfile/LicenseProfile_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles": { + "get": { + "tags": [ + "licenseProfiles" + ], + "operationId": "licenseProfiles_List", + "description": "The operation to get all license profiles of a non-Azure machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the machine." + }, + { + "$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/LicenseProfilesListResult" + } + }, + "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 all License Profiles": { + "$ref": "./examples/licenseProfile/LicenseProfile_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/assessPatches": { + "post": { + "tags": [ + "machines" + ], + "operationId": "Machines_AssessPatches", + "x-ms-examples": { + "Assess patch state of a machine.": { + "$ref": "./examples/machine/Machine_AssessPatches.json" + } + }, + "description": "The operation to assess patches on a hybrid machine identity in Azure.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineAssessPatchesResult" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous 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-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/installPatches": { + "post": { + "tags": [ + "machines" + ], + "operationId": "Machines_InstallPatches", + "description": "The operation to install patches on a hybrid machine identity in Azure.", + "x-ms-examples": { + "Install patch state of a machine.": { + "$ref": "./examples/machine/Machine_InstallPatches.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the hybrid machine." + }, + { + "name": "installPatchesInput", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineInstallPatchesParameters" + }, + "description": "Input for InstallPatches as directly received by the API" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineInstallPatchesResult" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous 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-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines": { + "get": { + "tags": [ + "machines" + ], + "operationId": "Machines_ListByResourceGroup", + "description": "Lists all the hybrid machines in the specified resource group. Use the nextLink property in the response to get the next page of hybrid machines.", + "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" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Machines by resource group": { + "$ref": "./examples/machine/Machines_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/machines": { + "get": { + "tags": [ + "machines" + ], + "operationId": "Machines_ListBySubscription", + "description": "Lists all the hybrid machines in the specified subscription. Use the nextLink property in the response to get the next page of hybrid machines.", + "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/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Machines by resource group": { + "$ref": "./examples/machine/Machines_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}": { + "put": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_CreateOrUpdate", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the machine where the extension should be created or updated." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineExtension" + }, + "description": "Parameters supplied to the Create Machine Extension operation." + }, + { + "$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/MachineExtension" + } + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update a Machine Extension": { + "$ref": "./examples/extension/Extension_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_Update", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the machine where the extension should be created or updated." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineExtensionUpdate" + }, + "description": "Parameters supplied to the Create Machine Extension operation." + }, + { + "$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/MachineExtension" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "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": { + "Create or Update a Machine Extension": { + "$ref": "./examples/extension/Extension_Update.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the machine where the extension should be deleted." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "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-examples": { + "Delete a Machine Extension": { + "$ref": "./examples/extension/Extension_Delete.json" + } + } + }, + "get": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the machine containing the extension." + }, + { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension." + }, + { + "$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/MachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GET Machine Extension": { + "$ref": "./examples/extension/Extension_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions": { + "get": { + "tags": [ + "MachineExtensions" + ], + "operationId": "MachineExtensions_List", + "description": "The operation to get all extensions of a non-Azure machine", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the machine containing the extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$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/MachineExtensionsListResult" + } + }, + "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": { + "GET all Machine Extensions - List": { + "$ref": "./examples/extension/Extension_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/upgradeExtensions": { + "post": { + "tags": [ + "MachineExtensions Upgrade" + ], + "operationId": "UpgradeExtensions", + "description": "The operation to Upgrade Machine Extensions.", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + }, + { + "name": "extensionUpgradeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MachineExtensionUpgrade" + }, + "description": "Parameters supplied to the Upgrade Extensions operation." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "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": { + "Upgrade Machine Extensions": { + "$ref": "./examples/extension/Extensions_Upgrade.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions/{version}": { + "get": { + "tags": [ + "extensions" + ], + "operationId": "ExtensionMetadata_Get", + "description": "Gets an Extension Metadata based on location, publisher, extensionType and version", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the Extension being received." + }, + { + "name": "publisher", + "in": "path", + "required": true, + "type": "string", + "description": "The publisher of the Extension being received." + }, + { + "name": "extensionType", + "in": "path", + "required": true, + "type": "string", + "description": "The extensionType of the Extension being received." + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the Extension being received." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExtensionValue" + } + }, + "default": { + "description": "Error in retrieving an extension metadata", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GET an extensions metadata": { + "$ref": "./examples/extension/ExtensionMetadata_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions": { + "get": { + "tags": [ + "extensions" + ], + "operationId": "ExtensionMetadata_List", + "description": "Gets all Extension versions based on location, publisher, extensionType", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the Extension being received." + }, + { + "name": "publisher", + "in": "path", + "required": true, + "type": "string", + "description": "The publisher of the Extension being received." + }, + { + "name": "extensionType", + "in": "path", + "required": true, + "type": "string", + "description": "The extensionType of the Extension being received." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExtensionValueListResult" + } + }, + "default": { + "description": "Error in retrieving extension list", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "GET a list of extensions": { + "$ref": "./examples/extension/ExtensionMetadata_List.json" + } + } + } + }, + "/providers/Microsoft.HybridCompute/operations": { + "get": { + "tags": [ + "operations" + ], + "operationId": "Operations_List", + "description": "Gets a list of hybrid compute operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Hybrid Compute Provider Operations": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/networkProfile": { + "get": { + "tags": [ + "MachineNetworkProfile" + ], + "operationId": "NetworkProfile_Get", + "description": "The operation to get network information of hybrid machine", + "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" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GET Network Profile": { + "$ref": "./examples/NetworkProfile_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/hybridIdentityMetadata/{metadataName}": { + "get": { + "tags": [ + "HybridIdentityMetadata" + ], + "operationId": "HybridIdentityMetadata_Get", + "summary": "Gets HybridIdentityMetadata.", + "description": "Implements HybridIdentityMetadata GET method.", + "x-ms-examples": { + "GetHybridIdentityMetadata": { + "$ref": "./examples/HybridIdentityMetadata_Get.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + }, + { + "in": "path", + "name": "metadataName", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "description": "Name of the HybridIdentityMetadata." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HybridIdentityMetadata" + } + }, + "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.HybridCompute/machines/{machineName}/hybridIdentityMetadata": { + "get": { + "tags": [ + "HybridIdentityMetadata" + ], + "operationId": "HybridIdentityMetadata_ListByMachines", + "summary": "Implements GET HybridIdentityMetadata in a machine.", + "description": "Returns the list of HybridIdentityMetadata of the given machine.", + "x-ms-examples": { + "HybridIdentityMetadataListByVirtualMachines": { + "$ref": "./examples/HybridIdentityMetadata_ListByVirtualMachines.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]", + "minLength": 1, + "maxLength": 54, + "description": "The name of the hybrid machine." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/HybridIdentityMetadataList" + } + }, + "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" + } + } + }, + "/providers/Microsoft.HybridCompute/osType/{osType}/agentVersions": { + "get": { + "tags": [ + "AgentVersions" + ], + "operationId": "AgentVersion_List", + "description": "Gets all Agent Versions along with the download link currently present.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "osType", + "in": "path", + "required": true, + "type": "string", + "description": "Defines the os type." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentVersionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GET Agent Versions": { + "$ref": "./examples/AgentVersions_Get.json" + } + } + } + }, + "/providers/Microsoft.HybridCompute/osType/{osType}/agentVersions/{version}": { + "get": { + "tags": [ + "AgentVersions" + ], + "operationId": "AgentVersion_Get", + "description": "Gets an Agent Version along with the download link currently present.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "osType", + "in": "path", + "required": true, + "type": "string", + "description": "Defines the os type" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "Defines the agent version. To get latest, use latest or else a specific agent version." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GET Agent Versions": { + "$ref": "./examples/AgentVersion_GetLatest.json" + } + } + } + } + }, + "definitions": { + "ExtensionValueListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ExtensionValue" + }, + "description": "The list of extension metadata", + "x-ms-identifiers": [] + } + }, + "description": "The List Extension Metadata response." + }, + "ExtensionValue": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExtensionValueProperties", + "description": "The single extension based on search criteria" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "description": "Describes a Extension Metadata" + }, + "ExtensionValueProperties": { + "type": "object", + "properties": { + "version": { + "type": "string", + "readOnly": true, + "description": "The version of the Extension being received." + }, + "extensionType": { + "type": "string", + "readOnly": true, + "description": "The type of the Extension being received." + }, + "publisher": { + "type": "string", + "readOnly": true, + "description": "The publisher of the Extension being received." + } + }, + "description": "Describes Extension Metadata properties" + }, + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "description": "The list of compute operations", + "x-ms-identifiers": [] + } + }, + "description": "The List Compute Operation operation response." + }, + "OperationValue": { + "type": "object", + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "$ref": "#/definitions/OperationValueDisplay", + "description": "Display properties" + }, + "isDataAction": { + "type": "boolean", + "readOnly": true, + "description": "This property indicates if the operation is an action or a data action" + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "OperationValueDisplay": { + "type": "object", + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Hybrid Compute Operation Value Display." + }, + "PatchSettings": { + "type": "object", + "properties": { + "assessmentMode": { + "type": "string", + "description": "Specifies the assessment mode.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "AssessmentModeTypes", + "modelAsString": true + } + }, + "patchMode": { + "type": "string", + "description": "Specifies the patch mode.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform", + "AutomaticByOS", + "Manual" + ], + "x-ms-enum": { + "name": "PatchModeTypes", + "modelAsString": true + } + } + }, + "description": "Specifies the patch settings." + }, + "AgentConfiguration": { + "type": "object", + "readOnly": true, + "properties": { + "proxyUrl": { + "type": "string", + "readOnly": true, + "description": "Specifies the URL of the proxy to be used." + }, + "incomingConnectionsPorts": { + "type": "array", + "readOnly": true, + "description": "Specifies the list of ports that the agent will be able to listen on.", + "items": { + "type": "string" + } + }, + "extensionsAllowList": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ConfigurationExtension" + }, + "description": "Array of extensions that are allowed to be installed or updated.", + "x-ms-identifiers": [] + }, + "extensionsBlockList": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ConfigurationExtension" + }, + "description": "Array of extensions that are blocked (cannot be installed or updated)", + "x-ms-identifiers": [] + }, + "proxyBypass": { + "type": "array", + "readOnly": true, + "description": "List of service names which should not use the specified proxy server.", + "items": { + "type": "string" + } + }, + "extensionsEnabled": { + "type": "string", + "readOnly": true, + "description": "Specifies whether the extension service is enabled or disabled." + }, + "guestConfigurationEnabled": { + "type": "string", + "readOnly": true, + "description": "Specified whether the guest configuration service is enabled or disabled." + }, + "configMode": { + "type": "string", + "readOnly": true, + "description": "Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft.", + "enum": [ + "full", + "monitor" + ], + "x-ms-enum": { + "name": "agent configuration mode", + "modelAsString": true + } + } + }, + "description": "Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM." + }, + "ConfigurationExtension": { + "type": "object", + "properties": { + "publisher": { + "type": "string", + "readOnly": true, + "description": "Publisher of the extension." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Type of the extension." + } + }, + "description": "Describes properties that can identify extensions." + }, + "ServiceStatuses": { + "type": "object", + "properties": { + "extensionService": { + "$ref": "#/definitions/ServiceStatus", + "description": "The state of the extension service on the Arc-enabled machine." + }, + "guestConfigurationService": { + "$ref": "#/definitions/ServiceStatus", + "description": "The state of the guest configuration service on the Arc-enabled machine." + } + }, + "description": "Reports the state and behavior of dependent services." + }, + "ServiceStatus": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The current status of the service." + }, + "startupType": { + "type": "string", + "description": "The behavior of the service when the Arc-enabled machine starts up." + } + }, + "description": "Describes the status and behavior of a service." + }, + "CloudMetadata": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "readOnly": true, + "description": "Specifies the cloud provider (Azure/AWS/GCP...)." + } + }, + "description": "The metadata of the cloud environment (Azure/GCP/AWS/OCI...)." + }, + "AgentUpgrade": { + "type": "object", + "properties": { + "desiredVersion": { + "type": "string", + "description": "Specifies the version info w.r.t AgentUpgrade for the machine." + }, + "correlationId": { + "type": "string", + "description": "The correlation ID passed in from RSM per upgrade." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Specifies if RSM should try to upgrade this machine" + }, + "lastAttemptDesiredVersion": { + "type": "string", + "readOnly": true, + "description": "Specifies the version of the last attempt" + }, + "lastAttemptTimestamp": { + "type": "string", + "readOnly": true, + "description": "Timestamp of last upgrade attempt" + }, + "lastAttemptStatus": { + "type": "string", + "readOnly": true, + "enum": [ + "Success", + "Failed" + ], + "x-ms-enum": { + "name": "LastAttemptStatusEnum", + "modelAsString": true + }, + "description": "Specifies the status of Agent Upgrade." + }, + "lastAttemptMessage": { + "type": "string", + "readOnly": true, + "description": "Failure message of last upgrade attempt if any." + } + }, + "description": "The info w.r.t Agent Upgrade." + }, + "OSProfile": { + "type": "object", + "properties": { + "computerName": { + "type": "string", + "readOnly": true, + "description": "Specifies the host OS name of the hybrid machine." + }, + "windowsConfiguration": { + "type": "object", + "properties": { + "patchSettings": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PatchSettings" + } + }, + "description": "Specifies the windows configuration for update management." + }, + "linuxConfiguration": { + "type": "object", + "properties": { + "patchSettings": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PatchSettings" + } + }, + "description": "Specifies the linux configuration for update management." + } + }, + "description": "Specifies the operating system settings for the hybrid machine." + }, + "DetectedProperties": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Detected properties from the machine." + }, + "MachineProperties": { + "type": "object", + "properties": { + "locationData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/locationData" + }, + "agentConfiguration": { + "$ref": "#/definitions/AgentConfiguration", + "description": "Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM." + }, + "serviceStatuses": { + "$ref": "#/definitions/ServiceStatuses", + "description": "Statuses of dependent services that are reported back to ARM." + }, + "cloudMetadata": { + "$ref": "#/definitions/CloudMetadata", + "description": "The metadata of the cloud environment (Azure/GCP/AWS/OCI...)." + }, + "agentUpgrade": { + "$ref": "#/definitions/AgentUpgrade", + "description": "The info of the machine w.r.t Agent Upgrade" + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the hybrid machine." + }, + "licenseProfile": { + "$ref": "#/definitions/LicenseProfileMachineInstanceView", + "description": "Specifies the ESU related properties for a machine." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "The status of the hybrid machine agent.", + "enum": [ + "Connected", + "Disconnected", + "Error" + ], + "x-ms-enum": { + "name": "StatusTypes", + "modelAsString": true + } + }, + "lastStatusChange": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time of the last status change." + }, + "errorDetails": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail" + }, + "description": "Details about the error state.", + "x-ms-identifiers": [] + }, + "agentVersion": { + "readOnly": true, + "type": "string", + "description": "The hybrid machine agent full version." + }, + "vmId": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Specifies the hybrid machine unique ID." + }, + "displayName": { + "readOnly": true, + "type": "string", + "description": "Specifies the hybrid machine display name." + }, + "machineFqdn": { + "readOnly": true, + "type": "string", + "description": "Specifies the hybrid machine FQDN." + }, + "clientPublicKey": { + "type": "string", + "description": "Public Key that the client provides to be used during initial resource onboarding" + }, + "osName": { + "readOnly": true, + "type": "string", + "description": "The Operating System running on the hybrid machine." + }, + "osVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Operating System running on the hybrid machine." + }, + "osType": { + "type": "string", + "description": "The type of Operating System (windows/linux)." + }, + "vmUuid": { + "readOnly": true, + "type": "string", + "description": "Specifies the Arc Machine's unique SMBIOS ID" + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/MachineExtensionInstanceView" + }, + "description": "Machine Extensions information (deprecated field)", + "x-ms-identifiers": [] + }, + "osSku": { + "readOnly": true, + "type": "string", + "description": "Specifies the Operating System product SKU." + }, + "domainName": { + "readOnly": true, + "type": "string", + "description": "Specifies the Windows domain name." + }, + "adFqdn": { + "readOnly": true, + "type": "string", + "description": "Specifies the AD fully qualified display name." + }, + "dnsFqdn": { + "readOnly": true, + "type": "string", + "description": "Specifies the DNS fully qualified display name." + }, + "privateLinkScopeResourceId": { + "type": "string", + "description": "The resource id of the private link scope this machine is assigned to, if any." + }, + "parentClusterResourceId": { + "type": "string", + "description": "The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any." + }, + "mssqlDiscovered": { + "type": "string", + "description": "Specifies whether any MS SQL instance is discovered on the machine." + }, + "detectedProperties": { + "$ref": "#/definitions/DetectedProperties", + "description": "Detected properties from the machine." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Information about the network the machine is on." + } + }, + "description": "Describes the properties of a hybrid machine." + }, + "MachineUpdateProperties": { + "type": "object", + "properties": { + "locationData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/locationData" + }, + "osProfile": { + "$ref": "#/definitions/OSProfile" + }, + "cloudMetadata": { + "$ref": "#/definitions/CloudMetadata", + "description": "The metadata of the cloud environment (Azure/GCP/AWS/OCI...)." + }, + "agentUpgrade": { + "$ref": "#/definitions/AgentUpgrade", + "description": "The info of the machine w.r.t Agent Upgrade" + }, + "parentClusterResourceId": { + "type": "string", + "description": "The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any." + }, + "privateLinkScopeResourceId": { + "type": "string", + "description": "The resource id of the private link scope this machine is assigned to, if any." + } + }, + "description": "Describes the ARM updatable properties of a hybrid machine." + }, + "Machine": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MachineProperties", + "description": "Hybrid Compute Machine properties" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/MachineExtension" + }, + "description": "The list of extensions affiliated to the machine" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Identity" + }, + "kind": { + "$ref": "#/definitions/ArcKindEnum" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes a hybrid machine." + }, + "ArcKindEnum": { + "type": "string", + "description": "Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc.", + "enum": [ + "AVS", + "HCI", + "SCVMM", + "VMware", + "EPS", + "GCP", + "AWS" + ], + "x-ms-enum": { + "name": "ArcKindEnum ", + "modelAsString": true + } + }, + "MachineUpdate": { + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Identity" + }, + "kind": { + "$ref": "#/definitions/ArcKindEnum" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MachineUpdateProperties", + "description": "Hybrid Compute Machine properties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a hybrid machine Update." + }, + "MachineListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Machine" + }, + "description": "The list of hybrid machines." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of hybrid machines." + } + }, + "required": [ + "value" + ], + "description": "The List hybrid machine operation response." + }, + "ProvisioningState": { + "readOnly": true, + "type": "string", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Accepted", + "Canceled", + "Deleted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The provisioning state, which only appears in the response." + }, + "License": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LicenseProperties", + "description": "Hybrid Compute License properties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes a license in a hybrid machine." + }, + "LicenseProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state, which only appears in the response." + }, + "tenantId": { + "type": "string", + "description": "Describes the tenant id." + }, + "licenseType": { + "$ref": "#/definitions/LicenseType", + "description": "The type of the license resource." + }, + "licenseDetails": { + "$ref": "#/definitions/LicenseDetails", + "description": "Describes the properties of a License." + } + }, + "description": "Describes the properties of a License Profile." + }, + "LicenseUpdate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LicenseUpdateProperties", + "description": "License Update properties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a License Update." + }, + "LicenseUpdateProperties": { + "type": "object", + "properties": { + "licenseType": { + "$ref": "#/definitions/LicenseType", + "description": "The type of the license resource." + }, + "licenseDetails": { + "x-ms-client-flatten": true, + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/LicenseState" + }, + "target": { + "$ref": "#/definitions/LicenseTarget" + }, + "edition": { + "$ref": "#/definitions/LicenseEdition" + }, + "type": { + "$ref": "#/definitions/LicenseCoreType" + }, + "processors": { + "type": "integer", + "format": "int32", + "description": "Describes the number of processors." + } + } + } + }, + "description": "Describes the Update properties of a License Profile." + }, + "LicenseDetails": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/LicenseState" + }, + "target": { + "$ref": "#/definitions/LicenseTarget" + }, + "edition": { + "$ref": "#/definitions/LicenseEdition" + }, + "type": { + "$ref": "#/definitions/LicenseCoreType" + }, + "processors": { + "type": "integer", + "format": "int32", + "description": "Describes the number of processors." + }, + "assignedLicenses": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Describes the number of assigned licenses." + }, + "immutableId": { + "readOnly": true, + "type": "string", + "description": "Describes the immutable id." + } + }, + "description": "Describes the properties of a License." + }, + "LicenseType": { + "type": "string", + "enum": [ + "ESU" + ], + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + }, + "description": "The type of the license resource." + }, + "LicenseState": { + "type": "string", + "enum": [ + "Activated", + "Deactivated" + ], + "x-ms-enum": { + "name": "LicenseState", + "modelAsString": true + }, + "description": "Describes the state of the license." + }, + "LicenseEdition": { + "type": "string", + "enum": [ + "Standard", + "Datacenter" + ], + "x-ms-enum": { + "name": "LicenseEdition", + "modelAsString": true + }, + "description": "Describes the edition of the license. The values are either Standard or Datacenter." + }, + "LicenseTarget": { + "type": "string", + "enum": [ + "Windows Server 2012", + "Windows Server 2012 R2" + ], + "x-ms-enum": { + "name": "LicenseTarget", + "modelAsString": true + }, + "description": "Describes the license target server." + }, + "LicenseCoreType": { + "type": "string", + "enum": [ + "pCore", + "vCore" + ], + "x-ms-enum": { + "name": "LicenseCoreType", + "modelAsString": true + }, + "description": "Describes the license core type (pCore or vCore)." + }, + "LicensesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/License" + }, + "description": "The list of licenses." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of license profile." + } + }, + "required": [ + "value" + ], + "description": "The List license operation response." + }, + "LicenseProfile": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "properties": { + "esuProfile": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LicenseProfileArmEsuProperties", + "description": "Hybrid Compute ESU Profile properties" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state, which only appears in the response." + } + }, + "description": "Describe the properties of a license profile." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes a license profile in a hybrid machine." + }, + "LicenseProfileUpdate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "properties": { + "esuProfile": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EsuProfileUpdateProperties", + "description": "Hybrid Compute ESU Profile Update properties" + } + }, + "description": "Describe the Update properties of a license profile." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a License Profile Update." + }, + "LicenseProfilesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LicenseProfile" + }, + "description": "The list of license profiles." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Machines. Call ListNext() with this URI to fetch the next page of license profile." + } + }, + "required": [ + "value" + ], + "description": "The List hybrid machine license profile operation response." + }, + "EsuServerType": { + "type": "string", + "enum": [ + "Standard", + "Datacenter" + ], + "x-ms-enum": { + "name": "EsuServerType", + "modelAsString": true + }, + "description": "The server types for Esu." + }, + "EsuEligibility": { + "type": "string", + "enum": [ + "Eligible", + "Ineligible", + "Unknown" + ], + "x-ms-enum": { + "name": "EsuEligibility", + "modelAsString": true + }, + "description": "The ESU eligibility." + }, + "EsuKey": { + "type": "object", + "properties": { + "sku": { + "type": "string", + "description": "SKU number." + }, + "licenseStatus": { + "type": "string", + "description": "The current status of the license profile key." + } + }, + "description": "ESU key" + }, + "EsuKeyState": { + "type": "string", + "enum": [ + "Inactive", + "Active" + ], + "x-ms-enum": { + "name": "EsuKeyState", + "modelAsString": true + }, + "description": "The ESU key state." + }, + "LicenseProfileStorageModelEsuProperties": { + "type": "object", + "properties": { + "assignedLicenseImmutableId": { + "readOnly": true, + "type": "string", + "description": "The guid id of the license." + }, + "esuKeys": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/EsuKey" + }, + "description": "The list of ESU keys.", + "x-ms-identifiers": [] + } + }, + "description": "License profile storage model for ESU properties." + }, + "LicenseProfileArmEsuProperties": { + "type": "object", + "properties": { + "assignedLicense": { + "type": "string", + "description": "The resource id of the license." + } + }, + "allOf": [ + { + "$ref": "#/definitions/LicenseProfileArmEsuPropertiesWithoutAssignedLicense" + } + ], + "description": "Describes the properties of a License Profile ARM model." + }, + "LicenseProfileArmEsuPropertiesWithoutAssignedLicense": { + "type": "object", + "properties": { + "serverType": { + "readOnly": true, + "$ref": "#/definitions/EsuServerType", + "description": "The type of the Esu servers." + }, + "esuEligibility": { + "readOnly": true, + "$ref": "#/definitions/EsuEligibility", + "description": "Indicates the eligibility state of Esu." + }, + "esuKeyState": { + "readOnly": true, + "$ref": "#/definitions/EsuKeyState", + "description": "Indicates whether there is an ESU Key currently active for the machine." + } + }, + "allOf": [ + { + "$ref": "#/definitions/LicenseProfileStorageModelEsuProperties" + } + ], + "description": "Describes the properties of a License Profile ARM model." + }, + "EsuProfileUpdateProperties": { + "type": "object", + "properties": { + "assignedLicense": { + "type": "string", + "description": "The resource id of the license." + } + }, + "description": "Describes the Update properties of a License Profile." + }, + "LicenseProfileMachineInstanceView": { + "type": "object", + "properties": { + "esuProfile": { + "$ref": "#/definitions/LicenseProfileMachineInstanceViewEsuProperties" + } + }, + "description": "License Profile Instance View in Machine Properties." + }, + "LicenseProfileMachineInstanceViewEsuProperties": { + "type": "object", + "properties": { + "assignedLicense": { + "$ref": "#/definitions/License", + "description": "The assigned license resource." + }, + "licenseAssignmentState": { + "type": "string", + "enum": [ + "Assigned", + "NotAssigned" + ], + "description": "Describes the license assignment state (Assigned or NotAssigned).", + "x-ms-enum": { + "name": "licenseAssignmentState", + "modelAsString": true + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/LicenseProfileArmEsuPropertiesWithoutAssignedLicense" + } + ], + "description": "Properties for the Machine ESU profile." + }, + "ResourceUpdate": { + "type": "object", + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + } + }, + "MachineExtension": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MachineExtensionProperties", + "description": "Describes Machine Extension Properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "description": "Describes a Machine Extension." + }, + "MachineExtensionUpdate": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MachineExtensionUpdateProperties", + "description": "Describes Machine Extension Update Properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceUpdate" + } + ], + "description": "Describes a Machine Extension Update." + }, + "MachineExtensionProperties": { + "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." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available." + }, + "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", + "additionalProperties": {}, + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "additionalProperties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/MachineExtensionInstanceView", + "description": "The machine extension instance view." + } + }, + "description": "Describes the properties of a Machine Extension." + }, + "MachineExtensionUpdateProperties": { + "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." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available." + }, + "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", + "additionalProperties": {}, + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "additionalProperties": {}, + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + } + }, + "description": "Describes the properties of a Machine Extension." + }, + "MachineExtensionInstanceView": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The machine extension name." + }, + "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." + }, + "status": { + "type": "object", + "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." + } + }, + "description": "Instance view status." + } + }, + "description": "Describes the Machine Extension Instance View." + }, + "MachineExtensionsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MachineExtension" + }, + "description": "The list of extensions" + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of machine extensions. Call ListNext() with this to fetch the next page of extensions." + } + }, + "description": "Describes the Machine Extensions List Result." + }, + "TargetVersion": { + "type": "string", + "description": "Extension Upgrade Target Version." + }, + "ExtensionTargetProperties": { + "type": "object", + "properties": { + "targetVersion": { + "type": "object", + "$ref": "#/definitions/TargetVersion", + "description": "Properties for the specified Extension to Upgrade." + } + }, + "description": "Describes the Machine Extension Target Version Properties" + }, + "ExtensionTarget": { + "type": "object", + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/ExtensionTargetProperties" + }, + "description": "Describes the Machine Extension Target Properties" + }, + "MachineExtensionUpgrade": { + "type": "object", + "properties": { + "extensionTargets": { + "$ref": "#/definitions/ExtensionTarget", + "description": "Describes the Extension Target Properties." + } + }, + "description": "Describes the Machine Extension Upgrade Properties." + }, + "NetworkProfile": { + "type": "object", + "readOnly": true, + "properties": { + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "description": "The list of network interfaces.", + "x-ms-identifiers": [] + } + }, + "description": "Describes the network information on this machine." + }, + "NetworkInterface": { + "type": "object", + "readOnly": true, + "properties": { + "ipAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/IpAddress" + }, + "description": "The list of IP addresses in this interface.", + "x-ms-identifiers": [] + } + }, + "description": "Describes a network interface." + }, + "IpAddress": { + "type": "object", + "readOnly": true, + "properties": { + "address": { + "type": "string", + "description": "Represents the IP Address." + }, + "ipAddressVersion": { + "type": "string", + "description": "Represents the Ip Address Version." + }, + "subnet": { + "type": "object", + "$ref": "#/definitions/Subnet", + "description": "The subnet to which this IP address belongs." + } + }, + "description": "Describes properties of the IP address." + }, + "Subnet": { + "type": "object", + "readOnly": true, + "properties": { + "addressPrefix": { + "type": "string", + "description": "Represents address prefix." + } + }, + "description": "Describes the subnet." + }, + "HybridIdentityMetadataList": { + "description": "List of HybridIdentityMetadata.", + "type": "object", + "properties": { + "nextLink": { + "description": "Url to follow for getting next page of HybridIdentityMetadata.", + "type": "string" + }, + "value": { + "description": "Array of HybridIdentityMetadata", + "type": "array", + "items": { + "$ref": "#/definitions/HybridIdentityMetadata" + } + } + }, + "required": [ + "value" + ] + }, + "HybridIdentityMetadata": { + "description": "Defines the HybridIdentityMetadata.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource", + "description": "The resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags." + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Resource properties.", + "$ref": "#/definitions/HybridIdentityMetadataProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "The system data." + } + }, + "x-ms-azure-resource": true + }, + "HybridIdentityMetadataProperties": { + "description": "Defines the resource properties.", + "type": "object", + "properties": { + "vmId": { + "description": "The unique identifier for the resource.", + "type": "string" + }, + "publicKey": { + "description": "The Public Key.", + "type": "string" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Identity", + "readOnly": true + } + } + }, + "AgentVersionsList": { + "type": "object", + "readOnly": true, + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentVersion" + }, + "description": "The list of available Agent Versions.", + "x-ms-identifiers": [ + "agentVersion" + ] + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next 10 available Agent Versions." + } + }, + "description": "Describes AgentVersions List." + }, + "AgentVersion": { + "type": "object", + "readOnly": true, + "properties": { + "agentVersion": { + "type": "string", + "description": "Represents the agent version." + }, + "downloadLink": { + "type": "string", + "description": "Represents the download link of specific agent version." + }, + "osType": { + "type": "string", + "description": "Defines the os type." + } + }, + "description": "Describes properties of Agent Version." + }, + "MachineAssessPatchesResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"", + "enum": [ + "Unknown", + "InProgress", + "Failed", + "Succeeded", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "PatchOperationStatus", + "modelAsString": true + } + }, + "assessmentActivityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result." + }, + "rebootPending": { + "type": "boolean", + "readOnly": true, + "description": "The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred." + }, + "availablePatchCountByClassification": { + "$ref": "#/definitions/AvailablePatchCountByClassification", + "description": "Summarization of patches available for installation on the machine by classification." + }, + "startDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "lastModifiedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation finished." + }, + "startedBy": { + "type": "string", + "readOnly": true, + "enum": [ + "User", + "Platform" + ], + "x-ms-enum": { + "name": "PatchOperationStartedBy", + "modelAsString": true + }, + "description": "Indicates if operation was triggered by user or by platform." + }, + "patchServiceUsed": { + "type": "string", + "readOnly": true, + "enum": [ + "Unknown", + "WU", + "WU_WSUS", + "YUM", + "APT", + "Zypper" + ], + "x-ms-enum": { + "name": "PatchServiceUsed", + "modelAsString": true + }, + "description": "Specifies the patch service used for the operation." + }, + "osType": { + "type": "string", + "readOnly": true, + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true + }, + "description": "The operating system type of the machine." + }, + "errorDetails": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail", + "readOnly": true, + "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." + } + }, + "description": "Describes the properties of an AssessPatches result." + }, + "AvailablePatchCountByClassification": { + "type": "object", + "properties": { + "security": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of security patches available for installation." + }, + "critical": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of critical patches available for installation." + }, + "definition": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of definition patches available for installation." + }, + "updateRollup": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of update Rollup patches available for installation." + }, + "featurePack": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of feature pack patches available for installation." + }, + "servicePack": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of service pack patches available for installation." + }, + "tools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of tools patches available for installation." + }, + "updates": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of updates category patches available for installation." + }, + "other": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Number of other patches available for installation." + } + }, + "description": "Summarization of patches available for installation on the machine by classification." + }, + "MachineInstallPatchesParameters": { + "type": "object", + "properties": { + "maximumDuration": { + "type": "string", + "description": "Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours)" + }, + "rebootSetting": { + "type": "string", + "description": "Defines when it is acceptable to reboot a VM during a software update operation.", + "enum": [ + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "VMGuestPatchRebootSetting", + "modelAsString": true + } + }, + "windowsParameters": { + "$ref": "#/definitions/WindowsParameters", + "description": "Input for InstallPatches on a Windows VM, as directly received by the API" + }, + "linuxParameters": { + "$ref": "#/definitions/LinuxParameters", + "description": "Input for InstallPatches on a Linux VM, as directly received by the API" + } + }, + "required": [ + "maximumDuration", + "rebootSetting" + ], + "description": "Input for InstallPatches as directly received by the API" + }, + "WindowsParameters": { + "type": "object", + "properties": { + "classificationsToInclude": { + "type": "array", + "description": "The update classifications to select when installing patches for Windows.", + "items": { + "type": "string", + "enum": [ + "Critical", + "Security", + "UpdateRollUp", + "FeaturePack", + "ServicePack", + "Definition", + "Tools", + "Updates" + ], + "x-ms-enum": { + "name": "VMGuestPatchClassification_Windows", + "modelAsString": true + } + } + }, + "kbNumbersToInclude": { + "type": "array", + "description": "Kbs to include in the patch operation", + "items": { + "type": "string" + } + }, + "kbNumbersToExclude": { + "type": "array", + "description": "Kbs to exclude in the patch operation", + "items": { + "type": "string" + } + }, + "excludeKbsRequiringReboot": { + "type": "boolean", + "description": "Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true." + }, + "maxPatchPublishDate": { + "type": "string", + "format": "date-time", + "description": "This is used to install patches that were published on or before this given max published date." + } + }, + "description": "Input for InstallPatches on a Windows VM, as directly received by the API" + }, + "LinuxParameters": { + "type": "object", + "properties": { + "classificationsToInclude": { + "type": "array", + "description": "The update classifications to select when installing patches for Linux.", + "items": { + "type": "string", + "enum": [ + "Critical", + "Security", + "Other" + ], + "x-ms-enum": { + "name": "VMGuestPatchClassification_Linux", + "modelAsString": true + } + } + }, + "packageNameMasksToInclude": { + "type": "array", + "description": "packages to include in the patch operation. Format: packageName_packageVersion", + "items": { + "type": "string" + } + }, + "packageNameMasksToExclude": { + "type": "array", + "description": "packages to exclude in the patch operation. Format: packageName_packageVersion", + "items": { + "type": "string" + } + } + }, + "description": "Input for InstallPatches on a Linux VM, as directly received by the API" + }, + "MachineInstallPatchesResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Failed\", \"Succeeded\", \"Unknown\" or \"CompletedWithWarnings.\"", + "enum": [ + "Unknown", + "InProgress", + "Failed", + "Succeeded", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "PatchOperationStatus", + "modelAsString": true + } + }, + "installationActivityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result." + }, + "rebootStatus": { + "type": "string", + "readOnly": true, + "description": "The reboot state of the VM following completion of the operation.", + "enum": [ + "Unknown", + "NotNeeded", + "Required", + "Started", + "Failed", + "Completed" + ], + "x-ms-enum": { + "name": "VMGuestPatchRebootStatus", + "modelAsString": true + } + }, + "maintenanceWindowExceeded": { + "type": "boolean", + "readOnly": true, + "description": "Whether the operation ran out of time before it completed all its intended actions." + }, + "excludedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that were not installed due to the user blocking their installation." + }, + "notSelectedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that were detected as available for install, but did not meet the operation's criteria." + }, + "pendingPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true." + }, + "installedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches successfully installed." + }, + "failedPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of patches that could not be installed due to some issue. See errors for details." + }, + "startDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "lastModifiedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation finished." + }, + "startedBy": { + "type": "string", + "readOnly": true, + "enum": [ + "User", + "Platform" + ], + "x-ms-enum": { + "name": "PatchOperationStartedBy", + "modelAsString": true + }, + "description": "Indicates if operation was triggered by user or by platform." + }, + "patchServiceUsed": { + "type": "string", + "readOnly": true, + "enum": [ + "Unknown", + "WU", + "WU_WSUS", + "YUM", + "APT", + "Zypper" + ], + "x-ms-enum": { + "name": "PatchServiceUsed", + "modelAsString": true + }, + "description": "Specifies the patch service used for the operation." + }, + "osType": { + "type": "string", + "readOnly": true, + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true + }, + "description": "The operating system type of the machine." + }, + "errorDetails": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail", + "readOnly": true, + "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." + } + }, + "description": "The result summary of an installation operation." + } + }, + "parameters": { + "machineNameParameter": { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]+", + "description": "The name of the hybrid machine.", + "x-ms-parameter-location": "method" + }, + "licenseProfileNameParameter": { + "name": "licenseProfileName", + "in": "path", + "description": "The name of the license profile.", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]+", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method", + "x-ms-enum": { + "name": "LicenseProfileName", + "modelAsString": false + } + }, + "licenseNameParameter": { + "name": "licenseName", + "in": "path", + "required": true, + "type": "string", + "pattern": "[a-zA-Z0-9-_\\.]+", + "description": "The name of the license.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/AgentVersion_GetLatest.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/AgentVersion_GetLatest.json new file mode 100644 index 000000000000..246c3853a3bb --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/AgentVersion_GetLatest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "osType": "myOsType", + "version": "1.27", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "agentVersion": "1.27", + "downloadLink": "https://download.microsoft.com/download/8/4/5/845d5e04-bb09-4ed2-9ca8-bb51184cddc9/AzureConnectedMachineAgent.msi", + "osType": "myOsType" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/AgentVersions_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/AgentVersions_Get.json new file mode 100644 index 000000000000..9c0b5ef532e1 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/AgentVersions_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "osType": "myOsType", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "agentVersion": "1.26", + "downloadLink": "https://download.microsoft.com/download/8/4/5/845d5e04-bb09-4ed2-9ca8-bb51184cddc9/AzureConnectedMachineAgent.msi", + "osType": "myOsType" + }, + { + "agentVersion": "1.27", + "downloadLink": "https://download.microsoft.com/download/8/4/5/845d5e04-bb09-4ed2-9ca8-bb51184cddc9/AzureConnectedMachineAgent.msi", + "osType": "myOsType" + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/HybridIdentityMetadata_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/HybridIdentityMetadata_Get.json new file mode 100644 index 000000000000..aa04200c9e58 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/HybridIdentityMetadata_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-06-20-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "testrg", + "machineName": "ContosoVm", + "metadataName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/ContosoVm/hybridIdentityMetadata/default", + "name": "testItem", + "type": "Microsoft.HybridCompute/machines/hybridIdentityMetadata", + "properties": { + "vmId": "f8b82dff-38ef-4220-99ef-d3a3f86ddc6c", + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2", + "identity": { + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d", + "type": "SystemAssigned" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/HybridIdentityMetadata_ListByVirtualMachines.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/HybridIdentityMetadata_ListByVirtualMachines.json new file mode 100644 index 000000000000..d906ec7b19a1 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/HybridIdentityMetadata_ListByVirtualMachines.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-06-20-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "testrg", + "machineName": "ContosoVm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/ContosoVm/hybridIdentityMetadata/default", + "name": "testItem", + "type": "Microsoft.HybridCompute/machines/hybridIdentityMetadata", + "properties": { + "vmId": "f8b82dff-38ef-4220-99ef-d3a3f86ddc6c", + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2", + "identity": { + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d", + "type": "SystemAssigned" + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/NetworkProfile_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/NetworkProfile_Get.json new file mode 100644 index 000000000000..498c27b3adc1 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/NetworkProfile_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "networkInterfaces": [ + { + "ipAddresses": [ + { + "address": "192.168.12.345", + "ipAddressVersion": "IPv4", + "subnet": { + "addressPrefix": "192.168.12.0/24" + } + } + ] + }, + { + "ipAddresses": [ + { + "address": "1001:0:34aa:5000:1234:aaaa:bbbb:cccc", + "ipAddressVersion": "IPv6", + "subnet": { + "addressPrefix": "1001:0:34aa:5000::/64" + } + } + ] + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/Operations_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/Operations_List.json new file mode 100644 index 000000000000..984e068fb926 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/Operations_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "origin": "user,system", + "name": "Microsoft.HybridCompute/operations/read", + "display": { + "operation": "Read all Operations", + "resource": "Microsoft.HybridCompute Resource Provider", + "description": "Read all Operations for Azure Arc for Servers", + "provider": "Microsoft HybridCompute" + }, + "isDataAction": true + }, + { + "origin": "user,system", + "name": "Microsoft.HybridCompute/register/action", + "display": { + "operation": "Register Subscription for Azure Arc for Servers", + "resource": "Microsoft.HybridCompute Resource Provider", + "description": "Registers the subscription for the Microsoft.HybridCompute Resource Provider", + "provider": "Microsoft HybridCompute" + }, + "isDataAction": true + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/ExtensionMetadata_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/ExtensionMetadata_Get.json new file mode 100644 index 000000000000..495bb9128f21 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/ExtensionMetadata_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "location": "EastUS", + "publisher": "microsoft.azure.monitor", + "extensionType": "azuremonitorlinuxagent", + "version": "1.9.1", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.HybridCompute/locations/eastus/publishers/microsoft.azure.monitor/extensionTypes/azuremonitorlinuxagent/versions/1.9.1", + "properties": { + "version": "1.9.1", + "extensionType": "azuremonitorlinuxagent", + "publisher": "microsoft.azure.monitor" + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/ExtensionMetadata_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/ExtensionMetadata_List.json new file mode 100644 index 000000000000..61859b6f36e2 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/ExtensionMetadata_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "location": "EastUS", + "publisher": "microsoft.azure.monitor", + "extensionType": "azuremonitorlinuxagent", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "1.9.1", + "extensionType": "azuremonitorlinuxagent", + "publisher": "microsoft.azure.monitor" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.HybridCompute/locations/eastus/publishers/microsoft.azure.monitor/extensionTypes/azuremonitorlinuxagent/versions/1.9.1" + }, + { + "properties": { + "version": "1.9.2", + "extensionType": "azuremonitorlinuxagent", + "publisher": "microsoft.azure.monitor" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Providers/Microsoft.HybridCompute/locations/eastus/publishers/microsoft.azure.monitor/extensionTypes/azuremonitorlinuxagent/versions/1.9.2" + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_CreateOrUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_CreateOrUpdate.json new file mode 100644 index 000000000000..a241baf544ca --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_CreateOrUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "CustomScriptExtension", + "api-version": "2023-06-20-preview", + "extensionParameters": { + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "typeHandlerVersion": "1.10", + "type": "CustomScriptExtension", + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.HybridCompute/machines/extensions", + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + }, + "protectedSettings": {}, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2020-08-08T20:42:10.999Z" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_Delete.json new file mode 100644 index 000000000000..ca1d79628113 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "MMA", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + }, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_Get.json new file mode 100644 index 000000000000..51df909cfb51 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "CustomScriptExtension", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.HybridCompute/machines/extensions", + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + }, + "protectedSettings": {}, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_List.json new file mode 100644 index 000000000000..abe91df97c4b --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_List.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "location": "eastus2euap", + "type": "Microsoft.HybridCompute/machines/extensions", + "properties": { + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + }, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "formattedMessage: Finished executing command, StdOut: , StdErr: ", + "time": "2020-08-13T17:18:57.405Z" + } + } + } + }, + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/winosupdateextension", + "name": "winosupdateextension", + "location": "eastus2euap", + "type": "Microsoft.HybridCompute/machines/extensions", + "properties": { + "publisher": "microsoft.softwareupdatemanagement.test", + "type": "windowsosupdateextension", + "typeHandlerVersion": "1.0.0.0", + "autoUpgradeMinorVersion": false, + "settings": {}, + "provisioningState": "Creating", + "instanceView": { + "name": "winosupdateextension", + "type": "windowsosupdateextension", + "typeHandlerVersion": "1.0.0.0", + "status": {} + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_Update.json new file mode 100644 index 000000000000..a3fbda27f297 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extension_Update.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "extensionName": "CustomScriptExtension", + "api-version": "2023-06-20-preview", + "extensionParameters": { + "properties": { + "publisher": "Microsoft.Compute", + "typeHandlerVersion": "1.10", + "enableAutomaticUpgrade": true, + "type": "CustomScriptExtension", + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -lt 100 }\"" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/Extensions/CustomScriptExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.HybridCompute/machines/extensions", + "location": "eastus2euap", + "properties": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "enableAutomaticUpgrade": true, + "autoUpgradeMinorVersion": false, + "settings": { + "commandToExecute": "powershell.exe -c \"Get-Process | Where-Object { $_.CPU -gt 10000 }\"" + }, + "protectedSettings": {}, + "provisioningState": "Succeeded", + "instanceView": { + "name": "CustomScriptExtension", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "success", + "level": "Information", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2020-01-08T20:42:10.999Z" + } + } + } + } + }, + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extensions_Upgrade.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extensions_Upgrade.json new file mode 100644 index 000000000000..464e2a085505 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/extension/Extensions_Upgrade.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2023-06-20-preview", + "extensionUpgradeParameters": { + "extensionTargets": { + "Microsoft.Compute.CustomScriptExtension": { + "targetVersion": "1.10" + }, + "Microsoft.Azure.Monitoring": { + "targetVersion": "2.0" + } + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_CreateOrUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_CreateOrUpdate.json new file mode 100644 index 000000000000..165ecb827f5d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_CreateOrUpdate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "licenseName": "{licenseName}", + "api-version": "2023-06-20-preview", + "parameters": { + "location": "eastus2euap", + "properties": { + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "tags": null, + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 2, + "immutableId": "" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_Delete.json new file mode 100644 index 000000000000..f825ad2b78e0 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "licenseName": "{licenseName}", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_Get.json new file mode 100644 index 000000000000..6ae810a6986c --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "licenseName": "{licenseName}", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "tags": null, + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 8, + "immutableId": "" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_ListByResourceGroup.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_ListByResourceGroup.json new file mode 100644 index 000000000000..d2cd25480961 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_ListByResourceGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "licenseName": "{licenseName}", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "tags": null, + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 8, + "immutableId": "" + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_ListBySubscription.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_ListBySubscription.json new file mode 100644 index 000000000000..77bc45bdd38f --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_ListBySubscription.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "licenseName": "{licenseName}", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "tags": null, + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 8, + "immutableId": "" + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_Update.json new file mode 100644 index 000000000000..cacc94b63148 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "licenseName": "{licenseName}", + "api-version": "2023-06-20-preview", + "parameters": { + "properties": { + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 8, + "immutableId": "" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_ValidateLicense.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_ValidateLicense.json new file mode 100644 index 000000000000..e4547c384aa0 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/license/License_ValidateLicense.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "licenseName": "{licenseName}", + "api-version": "2023-06-20-preview", + "parameters": { + "location": "eastus2euap", + "properties": { + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/Licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "tags": null, + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 2, + "immutableId": "" + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_CreateOrUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_CreateOrUpdate.json new file mode 100644 index 000000000000..e47f2728d7ac --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_CreateOrUpdate.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "licenseProfileName": "default", + "api-version": "2023-06-20-preview", + "parameters": { + "location": "eastus2euap", + "properties": { + "esuProfile": { + "assignedLicense": "{LicenseResourceId}" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/licenseProfiles/default", + "name": "default", + "type": "Microsoft.HybridCompute/machines/licenseProfiles", + "location": "eastus2euap", + "tags": null, + "properties": { + "esuProfile": { + "assignedLicense": "{LicenseResourceId}", + "assignedLicenseImmutableId": "{Guid}", + "esuEligibility": "Eligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": "licenseStatus1" + }, + { + "sku": "skuNumber2", + "licenseStatus": "licenseStatus2" + } + ] + } + } + } + }, + "201": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + }, + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/licenseProfiles/default", + "name": "default", + "type": "Microsoft.HybridCompute/machines/licenseProfiles", + "location": "eastus2euap", + "properties": { + "esuProfile": { + "assignedLicense": "{LicenseResourceId}", + "esuEligibility": "Eligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": "licenseStatus1" + }, + { + "sku": "skuNumber2", + "licenseStatus": "licenseStatus2" + } + ] + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_Delete.json new file mode 100644 index 000000000000..5993531e67c5 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "licenseProfileName": "default", + "api-version": "2023-06-20-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + }, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_Get.json new file mode 100644 index 000000000000..c3fe6c01d497 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "licenseProfileName": "default", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/licenseProfiles/default", + "name": "default", + "type": "Microsoft.HybridCompute/machines/licenseProfiles", + "location": "eastus2euap", + "tags": null, + "properties": { + "esuProfile": { + "assignedLicense": "{LicenseResourceId}", + "esuEligibility": "Eligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": "licenseStatus1" + }, + { + "sku": "skuNumber2", + "licenseStatus": "licenseStatus2" + } + ] + } + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_List.json new file mode 100644 index 000000000000..dd955a79a219 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "licenseProfileName": "default", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/licenseProfiles/default", + "name": "default", + "type": "Microsoft.HybridCompute/machines/licenseProfiles", + "location": "eastus2euap", + "tags": null, + "properties": { + "esuProfile": { + "assignedLicense": "{LicenseResourceId}", + "esuEligibility": "Eligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": "licenseStatus1" + }, + { + "sku": "skuNumber2", + "licenseStatus": "licenseStatus2" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_Update.json new file mode 100644 index 000000000000..5a770698801c --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/licenseProfile/LicenseProfile_Update.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "licenseProfileName": "default", + "api-version": "2023-06-20-preview", + "parameters": { + "properties": { + "esuProfile": { + "assignedLicense": "{LicenseResourceId}" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Machines/myMachine/licenseProfiles/default", + "name": "default", + "type": "Microsoft.HybridCompute/machines/licenseProfiles", + "location": "eastus2euap", + "properties": { + "esuProfile": { + "assignedLicense": "{LicenseResourceId}", + "esuEligibility": "Eligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": "licenseStatus1" + }, + { + "sku": "skuNumber2", + "licenseStatus": "licenseStatus2" + } + ] + } + } + } + }, + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machine_AssessPatches.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machine_AssessPatches.json new file mode 100644 index 000000000000..212250fcae4b --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machine_AssessPatches.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroupName", + "name": "myMachineName", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "assessmentActivityId": "68f8b292-dfc2-4646-9781-33cc88631968", + "rebootPending": true, + "startDateTime": "2021-08-22T02:15:20.9340000Z", + "lastModifiedDateTime": "2021-08-22T02:16:06.9740000Z", + "availablePatchCountByClassification": { + "security": 0, + "updateRollup": 1, + "featurePack": 0, + "servicePack": 0, + "definition": 0, + "critical": 0, + "updates": 1, + "tools": 0 + }, + "startedBy": "User", + "osType": "Windows", + "errorDetails": null + } + }, + "202": { + "headers": { + "Location": "eastus2euap" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machine_InstallPatches.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machine_InstallPatches.json new file mode 100644 index 000000000000..8f27ee0bcd7f --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machine_InstallPatches.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroupName", + "name": "myMachineName", + "api-version": "2023-06-20-preview", + "installPatchesInput": { + "maximumDuration": "PT4H", + "rebootSetting": "IfRequired", + "windowsParameters": { + "classificationsToInclude": [ + "Critical", + "Security" + ], + "maxPatchPublishDate": "2021-08-19T02:36:43.0539904+00:00" + } + } + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "installationActivityId": "68f8b292-dfc2-4646-9781-33cc88631968", + "rebootStatus": "Completed", + "maintenanceWindowExceeded": false, + "excludedPatchCount": 0, + "notSelectedPatchCount": 0, + "pendingPatchCount": 2, + "installedPatchCount": 3, + "failedPatchCount": 0, + "startDateTime": "2021-08-22T02:15:06.9740000Z", + "lastModifiedDateTime": "2021-08-22T02:16:06.9740000Z", + "startedBy": "User", + "osType": "Windows", + "errorDetails": null + } + }, + "202": { + "headers": { + "Location": "eastus2euap" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_CreateOrUpdate.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_CreateOrUpdate.json new file mode 100644 index 000000000000..558a5f9ab402 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_CreateOrUpdate.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2023-06-20-preview", + "parameters": { + "location": "eastus2euap", + "properties": { + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": "licenseStatus1" + }, + { + "sku": "skuNumber2", + "licenseStatus": "licenseStatus2" + } + ] + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond", + "city": "redmond", + "district": null, + "countryOrRegion": "usa" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_Delete.json new file mode 100644 index 000000000000..30ce93eaf749 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_Get.json new file mode 100644 index 000000000000..175b92b90539 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_Get.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": "licenseStatus1" + }, + { + "sku": "skuNumber2", + "licenseStatus": "licenseStatus2" + } + ] + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond", + "city": "redmond", + "district": null, + "countryOrRegion": "usa" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "agentConfiguration": { + "proxyUrl": "https://test.test", + "incomingConnectionsPorts": [ + "22", + "23" + ], + "extensionsAllowList": null, + "extensionsBlockList": null, + "proxyBypass": [ + "proxy1", + "proxy2" + ], + "extensionsEnabled": "true", + "guestConfigurationEnabled": "true", + "configMode": "full" + }, + "serviceStatuses": { + "extensionService": { + "status": "Running", + "startupType": "Automatic" + }, + "guestConfigurationService": { + "status": "Running", + "startupType": "Automatic" + } + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "networkProfile": { + "networkInterfaces": [ + { + "ipAddresses": [ + { + "address": "192.168.12.345", + "ipAddressVersion": "IPv4", + "subnet": { + "addressPrefix": "192.168.12.0/24" + } + } + ] + }, + { + "ipAddresses": [ + { + "address": "1001:0:34aa:5000:1234:aaaa:bbbb:cccc", + "ipAddressVersion": "IPv6", + "subnet": { + "addressPrefix": "1001:0:34aa:5000::/64" + } + } + ] + } + ] + } + }, + "resources": [] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_Get_LicenseProfileInstanceView.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_Get_LicenseProfileInstanceView.json new file mode 100644 index 000000000000..817a93062f71 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_Get_LicenseProfileInstanceView.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "$expand": "instanceView", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "esuProfile": { + "assignedLicense": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/Licenses/{licenseName}", + "name": "{licenseName}", + "type": "Microsoft.HybridCompute/licenses", + "location": "eastus2euap", + "tags": null, + "properties": { + "tenantId": "{tenandId}", + "licenseType": "ESU", + "licenseDetails": { + "state": "Activated", + "target": "Windows Server 2012", + "edition": "Datacenter", + "type": "pCore", + "processors": 6, + "assignedLicenses": 8, + "immutableId": "" + } + } + }, + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": "licenseStatus1" + }, + { + "sku": "skuNumber2", + "licenseStatus": "licenseStatus2" + } + ] + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond", + "city": "redmond", + "district": null, + "countryOrRegion": "usa" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "agentConfiguration": { + "proxyUrl": "https://test.test", + "incomingConnectionsPorts": [ + "22", + "23" + ], + "extensionsAllowList": null, + "extensionsBlockList": null, + "proxyBypass": [ + "proxy1", + "proxy2" + ], + "extensionsEnabled": "true", + "guestConfigurationEnabled": "true", + "configMode": "full" + }, + "serviceStatuses": { + "extensionService": { + "status": "Running", + "startupType": "Automatic" + }, + "guestConfigurationService": { + "status": "Running", + "startupType": "Automatic" + } + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName", + "networkProfile": { + "networkInterfaces": [ + { + "ipAddresses": [ + { + "address": "192.168.12.345", + "ipAddressVersion": "IPv4", + "subnet": { + "addressPrefix": "192.168.12.0/24" + } + } + ] + }, + { + "ipAddresses": [ + { + "address": "1001:0:34aa:5000:1234:aaaa:bbbb:cccc", + "ipAddressVersion": "IPv6", + "subnet": { + "addressPrefix": "1001:0:34aa:5000::/64" + } + } + ] + } + ] + } + }, + "resources": [] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_ListByResourceGroup.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_ListByResourceGroup.json new file mode 100644 index 000000000000..01e7ec416ba0 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_ListByResourceGroup.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "f7a068cc-b0b8-46e8-a203-22f301a62a8f", + "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": "licenseStatus1" + }, + { + "sku": "skuNumber2", + "licenseStatus": "licenseStatus2" + } + ] + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": null, + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "agentConfiguration": { + "proxyUrl": "https://test.test", + "incomingConnectionsPorts": [ + "22", + "23" + ], + "extensionsAllowList": null, + "extensionsBlockList": null, + "proxyBypass": [ + "proxy1", + "proxy2" + ], + "extensionsEnabled": "true", + "guestConfigurationEnabled": "true", + "configMode": "full" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + }, + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine2", + "name": "myMachine2", + "location": "westus2", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "e7a068cc-b0b8-46e8-a203-22f301a62a8f", + "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": "licenseStatus1" + }, + { + "sku": "skuNumber2", + "licenseStatus": "licenseStatus2" + } + ] + } + }, + "vmId": "a4a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "true", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Surfacebook" + }, + "agentConfiguration": { + "proxyUrl": "https://test.test", + "incomingConnectionsPorts": [ + "22", + "23" + ], + "extensionsAllowList": null, + "extensionsBlockList": null, + "proxyBypass": [ + "proxy1", + "proxy2" + ], + "extensionsEnabled": "true", + "guestConfigurationEnabled": "true", + "configMode": "full" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_ListBySubscription.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_ListBySubscription.json new file mode 100644 index 000000000000..f52e4afdc9ff --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_ListBySubscription.json @@ -0,0 +1,191 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": "licenseStatus1" + }, + { + "sku": "skuNumber2", + "licenseStatus": "licenseStatus2" + } + ] + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": null, + "mssqlDiscovered": "false", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Virtual Machine" + }, + "agentConfiguration": { + "proxyUrl": "https://test.test", + "incomingConnectionsPorts": [ + "22", + "23" + ], + "extensionsAllowList": null, + "extensionsBlockList": null, + "proxyBypass": [ + "proxy1", + "proxy2" + ], + "extensionsEnabled": "true", + "guestConfigurationEnabled": "true", + "configMode": "full" + }, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + }, + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup2/providers/Microsoft.HybridCompute/machines/myMachine2", + "name": "myMachine2", + "location": "westus2", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "e7a068cc-b0b8-46e8-a203-22f301a62a8f", + "tenantId": "c4098cc-91b8-46c2-a205-d82ab1a62a8f" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": null, + "patchMode": null + } + } + }, + "licenseProfile": { + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": "licenseStatus1" + }, + { + "sku": "skuNumber2", + "licenseStatus": "licenseStatus2" + } + ] + } + }, + "vmId": "a4a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "mssqlDiscovered": "true", + "detectedProperties": { + "cloudprovider": "N/A", + "manufacturer": "Microsoft Corporation", + "model": "Surfacebook" + }, + "agentConfiguration": { + "proxyUrl": "https://test.test", + "incomingConnectionsPorts": [ + "22", + "23" + ], + "extensionsAllowList": null, + "extensionsBlockList": null, + "proxyBypass": [ + "proxy1", + "proxy2" + ], + "extensionsEnabled": "true", + "guestConfigurationEnabled": "true", + "configMode": "full" + } + } + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_Update.json new file mode 100644 index 000000000000..5a8043201bd9 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/machine/Machines_Update.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "machineName": "myMachine", + "api-version": "2023-06-20-preview", + "location": "eastus2euap", + "kind": null, + "parameters": { + "properties": { + "locationData": { + "name": "Redmond" + }, + "osProfile": { + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": "ImageDefault", + "patchMode": "Manual" + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": "ImageDefault", + "patchMode": "Manual" + } + } + }, + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/machines/myMachine", + "name": "myMachine", + "location": "eastus2euap", + "tags": null, + "identity": { + "type": "SystemAssigned", + "principalId": "string", + "tenantId": "string" + }, + "type": "Microsoft.HybridCompute/machines", + "kind": null, + "properties": { + "provisioningState": "Succeeded", + "agentVersion": null, + "status": null, + "lastStatusChange": null, + "errorDetails": null, + "displayName": null, + "machineFqdn": null, + "vmUuid": null, + "osSku": null, + "domainName": null, + "adFqdn": null, + "dnsFqdn": null, + "osVersion": null, + "osType": null, + "osProfile": { + "computerName": null, + "windowsConfiguration": { + "patchSettings": { + "assessmentMode": "ImageDefault", + "patchMode": "Manual" + } + }, + "linuxConfiguration": { + "patchSettings": { + "assessmentMode": "ImageDefault", + "patchMode": "Manual" + } + } + }, + "licenseProfile": { + "esuProfile": { + "licenseAssignmentState": "Assigned", + "esuEligibility": "Ineligible", + "serverType": "Standard", + "esuKeyState": "Inactive", + "esuKeys": [ + { + "sku": "skuNumber1", + "licenseStatus": "licenseStatus1" + }, + { + "sku": "skuNumber2", + "licenseStatus": "licenseStatus2" + } + ] + } + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "locationData": { + "name": "Redmond" + }, + "clientPublicKey": "string", + "parentClusterResourceId": "{AzureStackHCIResourceId}", + "detectedProperties": null, + "privateLinkScopeResourceId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkScopeName" + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Delete.json new file mode 100644 index 000000000000..838ac2275b40 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + }, + "204": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Get.json new file mode 100644 index 000000000000..4e4387f0d823 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + }, + "groupIds": [ + "hybridcompute" + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateEndpoint/PrivateEndpointConnection_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateEndpoint/PrivateEndpointConnection_List.json new file mode 100644 index 000000000000..d768ea5fa6ca --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateEndpoint/PrivateEndpointConnection_List.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + }, + "groupIds": [ + "hybridcompute" + ] + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name-2", + "name": "private-endpoint-connection-name-2", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name-2" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my connection.", + "actionsRequired": "None" + }, + "groupIds": [ + "hybridcompute" + ] + } + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Update.json new file mode 100644 index 000000000000..d661f60ff84d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateEndpoint/PrivateEndpointConnection_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "privateEndpointConnectionName": "private-endpoint-connection-name", + "api-version": "2023-06-20-preview", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + }, + "groupIds": [ + "hybridcompute" + ] + } + } + }, + "202": {} + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_Get.json new file mode 100644 index 000000000000..b90af661b12b --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "api-version": "2023-06-20-preview", + "groupName": "hybridcompute" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateLinkResources/hybridcompute", + "name": "hybridcompute", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateLinkResources", + "properties": { + "groupId": "hybridcompute", + "requiredMembers": [ + "HybridCompute.Server", + "HybridCompute.K8sConfiguration", + "GuestConfig.DP" + ], + "requiredZoneNames": [ + "privatelink.his.arc.azure.com", + "privatelink.kubernetesconfiguration.azure.com", + "privatelink.Guestconfiguration.azure.com" + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_ListGet.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_ListGet.json new file mode 100644 index 000000000000..3270ca8eecc1 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_ListGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myResourceGroup", + "scopeName": "myPrivateLinkScope", + "api-version": "2023-06-20-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateLinkResources/hybridcompute", + "name": "hybridcompute", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateLinkResources", + "properties": { + "groupId": "hybridcompute", + "requiredMembers": [ + "HybridCompute.ServerDP", + "HybridCompute.K8sConfigurationDP", + "HybridCompute.GuestConfigDP" + ], + "requiredZoneNames": [ + "privatelink.his.arc.azure.com", + "privatelink.kubernetesconfiguration.azure.com", + "privatelink.Guestconfiguration.azure.com" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_Create.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_Create.json new file mode 100644 index 000000000000..f311be083db7 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_Create.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2023-06-20-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "parameters": { + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_Delete.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_Delete.json new file mode 100644 index 000000000000..aada5caa206d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-06-20-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "{callbackUrl}", + "Retry-After": 200, + "Azure-AsyncOperation": "{callbackUri}" + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_Get.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_Get.json new file mode 100644 index 000000000000..fddef3aa053f --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-06-20-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidation.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidation.json new file mode 100644 index 000000000000..53e1aff90f35 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidation.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-06-20-preview", + "location": "wus2", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "publicNetworkAccess": "Disabled", + "connectionDetails": [ + { + "id": "id", + "privateIpAddress": "ip", + "linkIdentifier": "linkId", + "groupId": "groupId", + "memberName": "memberName" + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidationForMachine.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidationForMachine.json new file mode 100644 index 000000000000..eecdf7f9af0f --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_GetValidationForMachine.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-06-20-preview", + "location": "wus2", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "machineName": "machineName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "publicNetworkAccess": "Disabled", + "connectionDetails": [ + { + "id": "id", + "privateIpAddress": "ip", + "linkIdentifier": "linkId", + "groupId": "groupId", + "memberName": "memberName" + } + ] + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_List.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_List.json new file mode 100644 index 000000000000..2dc194117a2d --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-06-20-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled" + } + }, + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-other-privatelinkscope", + "name": "my-other-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_ListByResourceGroup.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_ListByResourceGroup.json new file mode 100644 index 000000000000..de7905edc959 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_ListByResourceGroup.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2023-06-20-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "f5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + }, + { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-other-privatelinkscope", + "name": "my-other-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": {}, + "properties": { + "privateLinkScopeId": "a5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_Update.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_Update.json new file mode 100644 index 000000000000..98294662e7ed --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_Update.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2023-06-20-preview", + "subscriptionId": "86dc51d3-92ed-4d7e-947a-775ea79b4919", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "parameters": { + "location": "westus", + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridCompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4919/resourceGroups/my-resource-group/providers/microsoft.hybridCompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_UpdateTagsOnly.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_UpdateTagsOnly.json new file mode 100644 index 000000000000..8c8a1996568e --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/examples/privateLinkScope/PrivateLinkScopes_UpdateTagsOnly.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-06-20-preview", + "subscriptionId": "subid", + "resourceGroupName": "my-resource-group", + "scopeName": "my-privatelinkscope", + "PrivateLinkScopeTags": { + "tags": { + "Tag1": "Value1", + "Tag2": "Value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/microsoft.hybridcompute/privateLinkScopes/my-privatelinkscope", + "name": "my-privatelinkscope", + "type": "Microsoft.HybridCompute/privateLinkScopes", + "location": "westus", + "tags": { + "Tag1": "Value1", + "Tag2": "Value2" + }, + "properties": { + "privateLinkScopeId": "e5dc51d3-92ed-4d7e-947a-775ea79b4919", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/myPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name", + "name": "private-endpoint-connection-name", + "type": "Microsoft.HybridCompute/privateLinkScopes/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/privateLinkScopes.json b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/privateLinkScopes.json new file mode 100644 index 000000000000..e3b9dfa4ee75 --- /dev/null +++ b/specification/hybridcompute/resource-manager/Microsoft.HybridCompute/preview/2023-06-20-preview/privateLinkScopes.json @@ -0,0 +1,1130 @@ +{ + "swagger": "2.0", + "info": { + "title": "HybridComputeManagementClient", + "x-ms-code-generation-settings": { + "name": "HybridComputeManagementClient" + }, + "description": "Azure Arc( Servers and K8s Clusters) API reference for Private Link's Scopes management.", + "version": "2023-06-20-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/privateLinkScopes": { + "get": { + "description": "Gets a list of all Azure Arc PrivateLinkScopes within a subscription.", + "operationId": "PrivateLinkScopes_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more Azure Arc PrivateLinkScope definitions.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScopeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopesList.json": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes": { + "get": { + "description": "Gets a list of Azure Arc PrivateLinkScopes within a resource group.", + "operationId": "PrivateLinkScopes_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list containing 0 or more Azure Arc PrivateLinkScope definitions.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScopeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeListByResourceGroup": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}": { + "delete": { + "description": "Deletes a Azure Arc PrivateLinkScope.", + "operationId": "PrivateLinkScopes_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successful request when deleting an Azure Arc PrivateLinkScope." + }, + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "The specified PrivateLinkScope does not exist." + }, + "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-examples": { + "PrivateLinkScopesDelete": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_Delete.json" + } + } + }, + "get": { + "description": "Returns a Azure Arc PrivateLinkScope.", + "operationId": "PrivateLinkScopes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Azure Arc PrivateLinkScope definition.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_Get.json" + } + } + }, + "put": { + "description": "Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.", + "operationId": "PrivateLinkScopes_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "parameters", + "description": "Properties that need to be specified to create or update a Azure Arc for Servers and Clusters PrivateLinkScope.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + } + ], + "responses": { + "200": { + "description": "Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope is returned.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "201": { + "description": "Successful request when creating or updating a Azure Arc PrivateLinkScope. The updated PrivateLinkScope was created and is returned.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeCreate": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_Create.json" + }, + "PrivateLinkScopeUpdate": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_Update.json" + } + } + }, + "patch": { + "description": "Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.", + "operationId": "PrivateLinkScopes_UpdateTags", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "PrivateLinkScopeTags", + "description": "Updated tag information to set into the PrivateLinkScope instance.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsResource" + } + } + ], + "responses": { + "200": { + "description": "Updating the Azure Arc PrivateLinkScope's tags was successful. PrivateLinkScope tags are updated and returned with the rest of the PrivateLinkScope's object properties.", + "schema": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeUpdateTagsOnly": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_UpdateTagsOnly.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkResources_ListByPrivateLinkScope", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_ListGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", + "operationId": "PrivateLinkResources_Get", + "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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "$ref": "#/parameters/GroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private link resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Get", + "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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/privateEndpoint/PrivateEndpointConnection_Get.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Approve or reject a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Successfully approved or rejected private endpoint connection.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "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-examples": { + "Approve or reject a private endpoint connection with a given name.": { + "$ref": "./examples/privateEndpoint/PrivateEndpointConnection_Update.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnections_Delete", + "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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successfully deleted private endpoint connection." + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer", + "format": "int32" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + } + }, + "204": { + "description": "Private endpoint connection does not exist." + }, + "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-examples": { + "Deletes a private endpoint connection with a given name.": { + "$ref": "./examples/privateEndpoint/PrivateEndpointConnection_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets all private endpoint connections on a private link scope.", + "operationId": "PrivateEndpointConnections_ListByPrivateLinkScope", + "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" + }, + { + "$ref": "#/parameters/PrivateLinkScopeName" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "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": { + "Gets list of private endpoint connections on a private link scope.": { + "$ref": "./examples/privateEndpoint/PrivateEndpointConnection_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/privateLinkScopes/{privateLinkScopeId}": { + "get": { + "description": "Returns a Azure Arc PrivateLinkScope's validation details.", + "operationId": "PrivateLinkScopes_GetValidationDetails", + "parameters": [ + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PrivateLinkScopeId" + } + ], + "responses": { + "200": { + "description": "Azure Arc PrivateLinkScope validation details definition.", + "schema": { + "$ref": "#/definitions/PrivateLinkScopeValidationDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_GetValidation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/privateLinkScopes/current": { + "get": { + "description": "Returns a Azure Arc PrivateLinkScope's validation details for a given machine.", + "operationId": "PrivateLinkScopes_GetValidationDetailsForMachine", + "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/MachineNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure Arc PrivateLinkScope validation details definition.", + "schema": { + "$ref": "#/definitions/PrivateLinkScopeValidationDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkScopeGet": { + "$ref": "./examples/privateLinkScope/PrivateLinkScopes_GetValidationForMachine.json" + } + } + } + } + }, + "definitions": { + "PrivateLinkScopesResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "description": "Azure resource name", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true, + "description": "An azure resource object" + }, + "TagsResource": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance." + }, + "HybridComputePrivateLinkScope": { + "type": "object", + "properties": { + "properties": { + "description": "Properties that define a Azure Arc PrivateLinkScope resource.", + "$ref": "#/definitions/HybridComputePrivateLinkScopeProperties" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PrivateLinkScopesResource" + } + ], + "description": "An Azure Arc PrivateLinkScope definition." + }, + "PrivateLinkScopeValidationDetails": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "publicNetworkAccess": { + "description": "Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "connectionDetails": { + "type": "array", + "description": "List of Private Endpoint Connection details.", + "items": { + "$ref": "#/definitions/ConnectionDetail" + } + } + } + }, + "ConnectionDetail": { + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection private ip address" + }, + "linkIdentifier": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection link identifier" + }, + "groupId": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection group id" + }, + "memberName": { + "type": "string", + "readOnly": true, + "description": "The private endpoint connection member name" + } + } + }, + "HybridComputePrivateLinkScopeProperties": { + "type": "object", + "description": "Properties that define a Azure Arc PrivateLinkScope resource.", + "properties": { + "publicNetworkAccess": { + "description": "Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.", + "$ref": "#/definitions/PublicNetworkAccessType" + }, + "provisioningState": { + "type": "string", + "description": "Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed.", + "readOnly": true + }, + "privateLinkScopeId": { + "readOnly": true, + "description": "The Guid id of the private link scope.", + "type": "string" + }, + "privateEndpointConnections": { + "readOnly": true, + "description": "The collection of associated Private Endpoint Connections.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionDataModel" + } + } + } + }, + "HybridComputePrivateLinkScopeListResult": { + "type": "object", + "description": "Describes the list of Azure Arc PrivateLinkScope resources.", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "array", + "description": "List of Azure Arc PrivateLinkScope definitions.", + "items": { + "$ref": "#/definitions/HybridComputePrivateLinkScope" + } + }, + "nextLink": { + "type": "string", + "description": "The URI to get the next set of Azure Arc PrivateLinkScope definitions if too many PrivateLinkScopes where returned in the result set." + } + } + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateLinkResource": { + "type": "object", + "description": "A private link resource", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateLinkResourceProperties": { + "type": "object", + "description": "Properties of a private link resource.", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "description": "Required DNS zone names of the the private link resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PrivateEndpointConnectionDataModel": { + "type": "object", + "description": "The Data Model for a Private Endpoint Connection associated with a Private Link Scope", + "properties": { + "id": { + "description": "The ARM Resource Id of the Private Endpoint.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Name of the Private Endpoint.", + "type": "string", + "readOnly": true + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The Private Endpoint Connection properties." + } + } + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpointProperty", + "description": "Private endpoint which the connection belongs to." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStateProperty", + "description": "Connection state of the private endpoint connection." + }, + "provisioningState": { + "description": "State of the private endpoint connection.", + "type": "string", + "readOnly": true + }, + "groupIds": { + "description": "List of group IDs.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PrivateEndpointProperty": { + "type": "object", + "description": "Private endpoint which the connection belongs to.", + "properties": { + "id": { + "description": "Resource id of the private endpoint.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionStateProperty": { + "type": "object", + "description": "State of the private endpoint connection.", + "required": [ + "status", + "description" + ], + "properties": { + "status": { + "description": "The private link service connection status.", + "type": "string" + }, + "description": { + "description": "The private link service connection description.", + "type": "string" + }, + "actionsRequired": { + "description": "The actions required for private link service connection.", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "A private endpoint connection", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData" + } + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections.", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "PublicNetworkAccessType": { + "type": "string", + "description": "The network access policy to determine if Azure Arc agents can use public Azure Arc service endpoints. Defaults to disabled (access to Azure Arc services only via private link).", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccessType", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints." + }, + { + "value": "Disabled", + "description": "Does not allow Azure Arc agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link." + } + ] + } + } + }, + "parameters": { + "PrivateLinkScopeName": { + "name": "scopeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Arc PrivateLinkScope resource.", + "x-ms-parameter-location": "method" + }, + "PrivateLinkScopeId": { + "name": "privateLinkScopeId", + "in": "path", + "required": true, + "type": "string", + "description": "The id (Guid) of the Azure Arc PrivateLinkScope resource.", + "x-ms-parameter-location": "method" + }, + "GroupNameParameter": { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The location of the target resource.", + "minLength": 1 + }, + "MachineNameParameter": { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the target machine to get the private link scope validation details for.", + "minLength": 1, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hybridcompute/resource-manager/readme.md b/specification/hybridcompute/resource-manager/readme.md index fe5fb3b60814..71538476d132 100644 --- a/specification/hybridcompute/resource-manager/readme.md +++ b/specification/hybridcompute/resource-manager/readme.md @@ -26,7 +26,9 @@ These are the global settings for the HybridCompute API. ``` yaml openapi-type: arm -tag: package-preview-2023-03 + +tag: package-preview-2023-06 + directive: - where: - $.definitions.Machine.properties @@ -34,6 +36,16 @@ directive: - BodyTopLevelProperties ``` +### Tag: package-preview-2023-06 + +These settings apply only when `--tag=package-preview-2023-06` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-06' +input-file: + - Microsoft.HybridCompute/preview/2023-06-20-preview/HybridCompute.json + - Microsoft.HybridCompute/preview/2023-06-20-preview/privateLinkScopes.json +``` + ### Tag: package-preview-2023-03 These settings apply only when `--tag=package-preview-2023-03` is specified on the command line.