{ "swagger": "2.0", "info": { "title": "HybridComputeManagementClient", "version": "2026-09-01", "description": "Azure Arc API reference for managing connected machines, machine extensions, run commands, gateways, licenses, license profiles, private link scopes, and related HybridCompute resources.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "operations" }, { "name": "licenses" }, { "name": "machines" }, { "name": "MachineExtensions Upgrade" }, { "name": "MachineExtensions Setup" }, { "name": "MachineNetworkProfile" }, { "name": "licenseProfiles" }, { "name": "MachineExtensions" }, { "name": "extensions" }, { "name": "MachineRunCommands" }, { "name": "VmApplications" }, { "name": "gateways" }, { "name": "Settings" }, { "name": "PrivateLinkResources" }, { "name": "PrivateEndpointConnections" }, { "name": "NetworkSecurityPerimeterConfiguration" } ], "paths": { "/providers/Microsoft.HybridCompute/locations/{location}/publishers": { "get": { "operationId": "ExtensionPublisher_List", "tags": [ "extensions" ], "description": "Gets all Extension publishers based on the location", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExtensionPublisherListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GET a list of extension publishers": { "$ref": "./examples/extension/ExtensionPublisher_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes": { "get": { "operationId": "ExtensionType_List", "tags": [ "extensions" ], "description": "Gets all Extension types based on location and publisher", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" }, { "name": "publisher", "in": "path", "description": "The publisher of the Extension being received.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ExtensionTypeListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GET a list of extension types": { "$ref": "./examples/extension/ExtensionType_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions": { "get": { "operationId": "ExtensionMetadataV2_List", "tags": [ "extensions" ], "description": "Gets all Extension versions based on location, publisher, extensionType", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "location", "in": "path", "description": "The location of the Extension being received.", "required": true, "type": "string", "minLength": 1 }, { "name": "publisher", "in": "path", "description": "The publisher of the Extension being received.", "required": true, "type": "string" }, { "name": "extensionType", "in": "path", "description": "The extensionType of the Extension being received.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExtensionValueListResultV2" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GET a list of extension metadata": { "$ref": "./examples/extension/ExtensionMetadataV2_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions/{version}": { "get": { "operationId": "ExtensionMetadataV2_Get", "tags": [ "extensions" ], "description": "Gets an Extension Metadata based on location, publisher, extensionType and version", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "name": "location", "in": "path", "description": "The location of the Extension being received.", "required": true, "type": "string", "minLength": 1 }, { "name": "publisher", "in": "path", "description": "The publisher of the Extension being received.", "required": true, "type": "string" }, { "name": "extensionType", "in": "path", "description": "The extensionType of the Extension being received.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The version of the Extension being received.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExtensionValueV2" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GET an extension metadata": { "$ref": "./examples/extension/ExtensionMetadataV2_Get.json" } } } }, "/providers/Microsoft.HybridCompute/operations": { "get": { "operationId": "Operations_List", "tags": [ "operations" ], "description": "Gets a list of hybrid compute operations.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List Hybrid Compute Provider Operations": { "$ref": "./examples/Operations_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/gateways": { "get": { "operationId": "Gateways_ListBySubscription", "tags": [ "gateways" ], "description": "The operation to get all gateways of a non-Azure machine", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/GatewaysListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List Gateways by Subscription": { "$ref": "./examples/gateway/Gateway_ListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/licenses": { "get": { "operationId": "Licenses_ListBySubscription", "tags": [ "licenses" ], "description": "The operation to get all licenses of a non-Azure machine", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/LicensesListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List Licenses by Subscription": { "$ref": "./examples/license/License_ListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/privateLinkScopes/{privateLinkScopeId}": { "get": { "operationId": "PrivateLinkScopes_GetValidationDetails", "description": "Returns a Azure Arc PrivateLinkScope's validation details.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "privateLinkScopeId", "in": "path", "description": "The id (Guid) of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkScopeValidationDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateLinkScopeGet": { "$ref": "./examples/privateLinkScope/PrivateLinkScopes_GetValidation.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions": { "get": { "operationId": "ExtensionMetadata_List", "tags": [ "extensions" ], "description": "Gets all Extension versions based on location, publisher, extensionType", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "location", "in": "path", "description": "The location of the Extension being received.", "required": true, "type": "string" }, { "name": "publisher", "in": "path", "description": "The publisher of the Extension being received.", "required": true, "type": "string" }, { "name": "extensionType", "in": "path", "description": "The extensionType of the Extension being received.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExtensionValueListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GET a list of extensions": { "$ref": "./examples/extension/ExtensionMetadata_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/locations/{location}/publishers/{publisher}/extensionTypes/{extensionType}/versions/{version}": { "get": { "operationId": "ExtensionMetadata_Get", "tags": [ "extensions" ], "description": "Gets an Extension Metadata based on location, publisher, extensionType and version", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "location", "in": "path", "description": "The location of the Extension being received.", "required": true, "type": "string" }, { "name": "publisher", "in": "path", "description": "The publisher of the Extension being received.", "required": true, "type": "string" }, { "name": "extensionType", "in": "path", "description": "The extensionType of the Extension being received.", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The version of the Extension being received.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExtensionValue" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GET an extensions metadata": { "$ref": "./examples/extension/ExtensionMetadata_Get.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/machines": { "get": { "operationId": "Machines_ListBySubscription", "tags": [ "machines" ], "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/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MachineListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/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}/providers/Microsoft.HybridCompute/privateLinkScopes": { "get": { "operationId": "PrivateLinkScopes_List", "description": "Gets a list of all Azure Arc PrivateLinkScopes within a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HybridComputePrivateLinkScopeListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateLinkScopesList.json": { "$ref": "./examples/privateLinkScope/PrivateLinkScopes_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.HybridCompute/validateLicense": { "post": { "operationId": "Licenses_ValidateLicense", "tags": [ "licenses" ], "description": "The operation to validate a license.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "name": "parameters", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/License" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/License" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Validate a License": { "$ref": "./examples/license/License_ValidateLicense.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/License" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{baseProvider}/{baseResourceType}/{baseResourceName}/providers/Microsoft.HybridCompute/settings/{settingsResourceName}": { "get": { "operationId": "Settings_Get", "tags": [ "Settings" ], "description": "Returns the base Settings for the target resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "baseProvider", "in": "path", "description": "The name of the base Resource Provider.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "baseResourceType", "in": "path", "description": "The name of the base Resource Type.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "baseResourceName", "in": "path", "description": "The name of the base resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "settingsResourceName", "in": "path", "description": "The name of the settings resource.", "required": true, "type": "string", "pattern": "default" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Settings" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NetworkConfigurationsGet": { "$ref": "./examples/settings/SettingsGet.json" } } }, "put": { "operationId": "Settings_Update", "tags": [ "Settings" ], "description": "Updates the base Settings of the target resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "baseProvider", "in": "path", "description": "The name of the base Resource Provider.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "baseResourceType", "in": "path", "description": "The name of the base Resource Type.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "baseResourceName", "in": "path", "description": "The name of the base resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "settingsResourceName", "in": "path", "description": "The name of the settings resource.", "required": true, "type": "string", "pattern": "default" }, { "name": "parameters", "in": "body", "description": "Settings details", "required": true, "schema": { "$ref": "#/definitions/Settings" } } ], "responses": { "200": { "description": "Resource 'Settings' update operation succeeded", "schema": { "$ref": "#/definitions/Settings" } }, "201": { "description": "Resource 'Settings' create operation succeeded", "schema": { "$ref": "#/definitions/Settings" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SettingsUpdate": { "$ref": "./examples/settings/SettingsUpdate.json" } } }, "patch": { "operationId": "Settings_Patch", "tags": [ "Settings" ], "description": "Update the base Settings of the target resource.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "baseProvider", "in": "path", "description": "The name of the base Resource Provider.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "baseResourceType", "in": "path", "description": "The name of the base Resource Type.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "baseResourceName", "in": "path", "description": "The name of the base resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "settingsResourceName", "in": "path", "description": "The name of the settings resource.", "required": true, "type": "string", "pattern": "default" }, { "name": "parameters", "in": "body", "description": "Settings details", "required": true, "schema": { "$ref": "#/definitions/Settings" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Settings" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "NetworkConfigurationsPatch": { "$ref": "./examples/settings/SettingsPatch.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways": { "get": { "operationId": "Gateways_ListByResourceGroup", "tags": [ "gateways" ], "description": "The operation to get all gateways of a non-Azure machine", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/GatewaysListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List Gateways by Resource Group": { "$ref": "./examples/gateway/Gateway_ListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/gateways/{gatewayName}": { "get": { "operationId": "Gateways_Get", "tags": [ "gateways" ], "description": "Retrieves information about the view of a gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the Gateway.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Gateway" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get Gateway": { "$ref": "./examples/gateway/Gateway_Get.json" } } }, "put": { "operationId": "Gateways_CreateOrUpdate", "tags": [ "gateways" ], "description": "The operation to create or update a gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the Gateway.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Create gateway operation.", "required": true, "schema": { "$ref": "#/definitions/Gateway" } } ], "responses": { "200": { "description": "Resource 'Gateway' update operation succeeded", "schema": { "$ref": "#/definitions/Gateway" } }, "201": { "description": "Resource 'Gateway' create operation succeeded", "schema": { "$ref": "#/definitions/Gateway" }, "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update a Gateway": { "$ref": "./examples/gateway/Gateway_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/Gateway" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Gateways_Update", "tags": [ "gateways" ], "description": "The operation to update a gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the Gateway.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Update gateway operation.", "required": true, "schema": { "$ref": "#/definitions/GatewayUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Gateway" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a Gateway": { "$ref": "./examples/gateway/Gateway_Update.json" } } }, "delete": { "operationId": "Gateways_Delete", "tags": [ "gateways" ], "description": "The operation to delete a gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "gatewayName", "in": "path", "description": "The name of the Gateway.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a Gateway": { "$ref": "./examples/gateway/Gateway_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses": { "get": { "operationId": "Licenses_ListByResourceGroup", "tags": [ "licenses" ], "description": "The operation to get all licenses of a non-Azure machine", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/LicensesListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GET all Machine Extensions": { "$ref": "./examples/license/License_ListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/licenses/{licenseName}": { "get": { "operationId": "Licenses_Get", "tags": [ "licenses" ], "description": "Retrieves information about the view of a license.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "licenseName", "in": "path", "description": "The name of the license.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/License" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get License": { "$ref": "./examples/license/License_Get.json" } } }, "put": { "operationId": "Licenses_CreateOrUpdate", "tags": [ "licenses" ], "description": "The operation to create or update a license.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "licenseName", "in": "path", "description": "The name of the license.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Create license operation.", "required": true, "schema": { "$ref": "#/definitions/License" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/License" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update a License": { "$ref": "./examples/license/License_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/License" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Licenses_Update", "tags": [ "licenses" ], "description": "The operation to update a license.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "licenseName", "in": "path", "description": "The name of the license.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Update license operation.", "required": true, "schema": { "$ref": "#/definitions/LicenseUpdate" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/License" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a License": { "$ref": "./examples/license/License_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/License" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Licenses_Delete", "tags": [ "licenses" ], "description": "The operation to delete a license.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "licenseName", "in": "path", "description": "The name of the license.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" } ], "responses": { "200": { "description": "The request has succeeded.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a License": { "$ref": "./examples/license/License_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines": { "get": { "operationId": "Machines_ListByResourceGroup", "tags": [ "machines" ], "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/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "$expand", "in": "query", "description": "Expands referenced resources.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MachineListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/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}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}": { "get": { "operationId": "Machines_Get", "tags": [ "machines" ], "description": "Retrieves information about the model view or the instance view of a hybrid machine.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "$expand", "in": "query", "description": "The expand expression to apply on the operation.", "required": false, "type": "string", "enum": [ "instanceView" ], "x-ms-enum": { "name": "InstanceViewTypes", "modelAsString": true, "values": [ { "name": "instanceView", "value": "instanceView", "description": "instanceView" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Machine" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/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" } } }, "put": { "operationId": "Machines_CreateOrUpdate", "tags": [ "machines" ], "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/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "$expand", "in": "query", "description": "Expands referenced resources.", "required": false, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Create hybrid machine operation.", "required": true, "schema": { "$ref": "#/definitions/Machine" } } ], "responses": { "200": { "description": "Resource 'Machine' update operation succeeded", "schema": { "$ref": "#/definitions/Machine" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update a Machine": { "$ref": "./examples/machine/Machines_CreateOrUpdate.json" } } }, "patch": { "operationId": "Machines_Update", "tags": [ "machines" ], "description": "The operation to update a hybrid machine.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Update hybrid machine operation.", "required": true, "schema": { "$ref": "#/definitions/MachineUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Machine" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a Machine": { "$ref": "./examples/machine/Machines_Update.json" } } }, "delete": { "operationId": "Machines_Delete", "tags": [ "machines" ], "description": "The operation to delete a hybrid machine.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a Machine": { "$ref": "./examples/machine/Machines_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/addExtensions": { "post": { "operationId": "SetupExtensions", "tags": [ "MachineExtensions Setup" ], "description": "The operation to Setup Machine Extensions.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "extensions", "in": "body", "description": "Parameters supplied to the Setup Extensions operation.", "required": true, "schema": { "$ref": "#/definitions/SetupExtensionRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SetupExtensionRequest" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Setup Machine Extensions": { "$ref": "./examples/extension/Extension_Add.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/SetupExtensionRequest" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/applications": { "get": { "operationId": "VmApplications_List", "tags": [ "VmApplications" ], "description": "Lists the VM applications installed on a hybrid machine.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "$top", "in": "query", "description": "The maximum number of results to return.", "required": false, "type": "integer", "format": "int32", "default": 100 }, { "name": "$skipToken", "in": "query", "description": "The continuation token for the next page of results.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/VmApplicationsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List VM applications": { "$ref": "./examples/application/VMApplications_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/applications/{applicationName}": { "get": { "operationId": "VmApplications_Get", "tags": [ "VmApplications" ], "description": "Gets a VM application.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "applicationName", "in": "path", "description": "The name of the VM application. When creating the resource, this name must match the application name in the selected gallery reference.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9](?:[A-Za-z0-9_.-]{0,78}[A-Za-z0-9_-])?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VmApplication" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a VM application": { "$ref": "./examples/application/VMApplications_Get.json" } } }, "put": { "operationId": "VmApplications_CreateOrUpdate", "tags": [ "VmApplications" ], "description": "Creates or updates a VM application.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "applicationName", "in": "path", "description": "The name of the VM application. When creating the resource, this name must match the application name in the selected gallery reference.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9](?:[A-Za-z0-9_.-]{0,78}[A-Za-z0-9_-])?$" }, { "name": "resource", "in": "body", "description": "The VM application resource.", "required": true, "schema": { "$ref": "#/definitions/VmApplication" } } ], "responses": { "200": { "description": "Resource 'VmApplication' update operation succeeded", "schema": { "$ref": "#/definitions/VmApplication" } }, "201": { "description": "Resource 'VmApplication' create operation succeeded", "schema": { "$ref": "#/definitions/VmApplication" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a VM application": { "$ref": "./examples/application/VMApplications_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/VmApplication" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "VmApplications_Update", "tags": [ "VmApplications" ], "description": "Updates a VM application.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "applicationName", "in": "path", "description": "The name of the VM application. When creating the resource, this name must match the application name in the selected gallery reference.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9](?:[A-Za-z0-9_.-]{0,78}[A-Za-z0-9_-])?$" }, { "name": "properties", "in": "body", "description": "The VM application update properties.", "required": true, "schema": { "$ref": "#/definitions/VmApplicationUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VmApplication" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a VM application": { "$ref": "./examples/application/VMApplications_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/VmApplication" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "VmApplications_Delete", "tags": [ "VmApplications" ], "description": "Deletes a VM application.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "applicationName", "in": "path", "description": "The name of the VM application. When creating the resource, this name must match the application name in the selected gallery reference.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9](?:[A-Za-z0-9_.-]{0,78}[A-Za-z0-9_-])?$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a VM application": { "$ref": "./examples/application/VMApplications_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/applications/{applicationName}/instanceView": { "get": { "operationId": "VmApplications_GetInstanceView", "tags": [ "VmApplications" ], "description": "Gets the instance view of a VM application.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "applicationName", "in": "path", "description": "The name of the VM application. When creating the resource, this name must match the application name in the selected gallery reference.", "required": true, "type": "string", "pattern": "^[A-Za-z0-9](?:[A-Za-z0-9_.-]{0,78}[A-Za-z0-9_-])?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VmApplication" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get the instance view of a VM application": { "$ref": "./examples/application/VMApplications_GetInstanceView.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/assessPatches": { "post": { "operationId": "Machines_AssessPatches", "tags": [ "machines" ], "description": "The operation to assess patches on a hybrid machine identity in Azure.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MachineAssessPatchesResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Assess patch state of a machine.": { "$ref": "./examples/machine/Machine_AssessPatches.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MachineAssessPatchesResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions": { "get": { "operationId": "MachineExtensions_List", "tags": [ "MachineExtensions" ], "description": "The operation to get all extensions of a non-Azure machine", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "$expand", "in": "query", "description": "The expand expression to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/MachineExtensionsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GET all Machine Extensions - List": { "$ref": "./examples/extension/Extension_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/extensions/{extensionName}": { "get": { "operationId": "MachineExtensions_Get", "tags": [ "MachineExtensions" ], "description": "The operation to get the extension.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "extensionName", "in": "path", "description": "The name of the machine extension.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MachineExtension" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GET Machine Extension": { "$ref": "./examples/extension/Extension_Get.json" } } }, "put": { "operationId": "MachineExtensions_CreateOrUpdate", "tags": [ "MachineExtensions" ], "description": "The operation to create or update the extension.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "extensionName", "in": "path", "description": "The name of the machine extension.", "required": true, "type": "string" }, { "name": "extensionParameters", "in": "body", "description": "Parameters supplied to the Create Machine Extension operation.", "required": true, "schema": { "$ref": "#/definitions/MachineExtension" } } ], "responses": { "200": { "description": "Resource 'MachineExtension' update operation succeeded", "schema": { "$ref": "#/definitions/MachineExtension" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update a Machine Extension": { "$ref": "./examples/extension/Extension_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MachineExtension" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "MachineExtensions_Update", "tags": [ "MachineExtensions" ], "description": "The operation to create or update the extension.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "extensionName", "in": "path", "description": "The name of the machine extension.", "required": true, "type": "string" }, { "name": "extensionParameters", "in": "body", "description": "Parameters supplied to the Create Machine Extension operation.", "required": true, "schema": { "$ref": "#/definitions/MachineExtensionUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MachineExtension" } }, "202": { "description": "Resource update request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update a Machine Extension": { "$ref": "./examples/extension/Extension_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MachineExtension" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "MachineExtensions_Delete", "tags": [ "MachineExtensions" ], "description": "The operation to delete the extension.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "extensionName", "in": "path", "description": "The name of the machine extension.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a Machine Extension": { "$ref": "./examples/extension/Extension_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{name}/installPatches": { "post": { "operationId": "Machines_InstallPatches", "tags": [ "machines" ], "description": "The operation to install patches on a hybrid machine identity in Azure.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string" }, { "name": "installPatchesInput", "in": "body", "description": "Input for InstallPatches as directly received by the API", "required": true, "schema": { "$ref": "#/definitions/MachineInstallPatchesParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MachineInstallPatchesResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Install patch state of a machine.": { "$ref": "./examples/machine/Machine_InstallPatches.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/MachineInstallPatchesResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles": { "get": { "operationId": "LicenseProfiles_List", "tags": [ "licenseProfiles" ], "description": "The operation to get all license profiles of a non-Azure machine", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/LicenseProfilesListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all License Profiles": { "$ref": "./examples/licenseProfile/LicenseProfile_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/licenseProfiles/{licenseProfileName}": { "get": { "operationId": "LicenseProfiles_Get", "tags": [ "licenseProfiles" ], "description": "Retrieves information about the view of a license profile.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "licenseProfileName", "in": "path", "description": "The name of the license profile.", "required": true, "type": "string", "enum": [ "default" ], "x-ms-enum": { "name": "LicenseProfileName", "modelAsString": false, "values": [ { "name": "default", "value": "default", "description": "Default" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LicenseProfile" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get License Profile": { "$ref": "./examples/licenseProfile/LicenseProfile_Get.json" } } }, "put": { "operationId": "LicenseProfiles_CreateOrUpdate", "tags": [ "licenseProfiles" ], "description": "The operation to create or update a license profile.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "licenseProfileName", "in": "path", "description": "The name of the license profile.", "required": true, "type": "string", "enum": [ "default" ], "x-ms-enum": { "name": "LicenseProfileName", "modelAsString": false, "values": [ { "name": "default", "value": "default", "description": "Default" } ] } }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Create or Update license profile operation.", "required": true, "schema": { "$ref": "#/definitions/LicenseProfile" } } ], "responses": { "200": { "description": "Resource 'LicenseProfile' update operation succeeded", "schema": { "$ref": "#/definitions/LicenseProfile" } }, "201": { "description": "Resource 'LicenseProfile' create operation succeeded", "schema": { "$ref": "#/definitions/LicenseProfile" }, "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update a License Profile": { "$ref": "./examples/licenseProfile/LicenseProfile_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/LicenseProfile" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "LicenseProfiles_Update", "tags": [ "licenseProfiles" ], "description": "The operation to update a license profile.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "licenseProfileName", "in": "path", "description": "The name of the license profile.", "required": true, "type": "string", "enum": [ "default" ], "x-ms-enum": { "name": "LicenseProfileName", "modelAsString": false, "values": [ { "name": "default", "value": "default", "description": "Default" } ] } }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the Update license profile operation.", "required": true, "schema": { "$ref": "#/definitions/LicenseProfileUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/LicenseProfile" } }, "202": { "description": "Resource update request accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a License Profile": { "$ref": "./examples/licenseProfile/LicenseProfile_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/LicenseProfile" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "LicenseProfiles_Delete", "tags": [ "licenseProfiles" ], "description": "The operation to delete a license profile.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "licenseProfileName", "in": "path", "description": "The name of the license profile.", "required": true, "type": "string", "enum": [ "default" ], "x-ms-enum": { "name": "LicenseProfileName", "modelAsString": false, "values": [ { "name": "default", "value": "default", "description": "Default" } ] } } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a License Profile": { "$ref": "./examples/licenseProfile/LicenseProfile_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/networkProfile": { "get": { "operationId": "NetworkProfile_Get", "tags": [ "MachineNetworkProfile" ], "description": "The operation to get network information of hybrid machine", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkProfile" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GET Network Profile": { "$ref": "./examples/NetworkProfile_Get.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/privateLinkScopes/current": { "get": { "operationId": "PrivateLinkScopes_GetValidationDetailsForMachine", "description": "Returns a Azure Arc PrivateLinkScope's validation details for a given machine.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkScopeValidationDetails" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateLinkScopeGet": { "$ref": "./examples/privateLinkScope/PrivateLinkScopes_GetValidationForMachine.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands": { "get": { "operationId": "MachineRunCommands_List", "tags": [ "MachineRunCommands" ], "description": "The operation to get all the run commands of a non-Azure machine.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "$expand", "in": "query", "description": "The expand expression to apply on the operation.", "required": false, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/MachineRunCommandsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "GET all Machine Run Commands": { "$ref": "./examples/runCommand/RunCommands_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/runCommands/{runCommandName}": { "get": { "operationId": "MachineRunCommands_Get", "tags": [ "MachineRunCommands" ], "description": "The operation to get a run command.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "runCommandName", "in": "path", "description": "The name of the run command.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/MachineRunCommand" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a Run Command": { "$ref": "./examples/runCommand/RunCommands_Get.json" } } }, "put": { "operationId": "MachineRunCommands_CreateOrUpdate", "tags": [ "MachineRunCommands" ], "description": "The operation to create or update a run command.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "runCommandName", "in": "path", "description": "The name of the run command.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "runCommandProperties", "in": "body", "description": "Parameters supplied to the Create Run Command.", "required": true, "schema": { "$ref": "#/definitions/MachineRunCommand" } } ], "responses": { "200": { "description": "Resource 'MachineRunCommand' update operation succeeded", "schema": { "$ref": "#/definitions/MachineRunCommand" } }, "201": { "description": "Resource 'MachineRunCommand' create operation succeeded", "schema": { "$ref": "#/definitions/MachineRunCommand" }, "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update a Run Command": { "$ref": "./examples/runCommand/RunCommands_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/MachineRunCommand" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "MachineRunCommands_Delete", "tags": [ "MachineRunCommands" ], "description": "The operation to delete a run command.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "runCommandName", "in": "path", "description": "The name of the run command.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a Machine Run Command": { "$ref": "./examples/runCommand/RunCommands_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/upgradeExtensions": { "post": { "operationId": "UpgradeExtensions", "tags": [ "MachineExtensions Upgrade" ], "description": "The operation to Upgrade Machine Extensions.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "machineName", "in": "path", "description": "The name of the hybrid machine.", "required": true, "type": "string", "minLength": 1, "maxLength": 54, "pattern": "^[a-zA-Z0-9-_\\.]{1,54}$" }, { "name": "extensionUpgradeParameters", "in": "body", "description": "Parameters supplied to the Upgrade Extensions operation.", "required": true, "schema": { "$ref": "#/definitions/MachineExtensionUpgrade" } } ], "responses": { "200": { "description": "The request has succeeded." }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Upgrade Machine Extensions": { "$ref": "./examples/extension/Extensions_Upgrade.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes": { "get": { "operationId": "PrivateLinkScopes_ListByResourceGroup", "description": "Gets a list of Azure Arc PrivateLinkScopes within a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HybridComputePrivateLinkScopeListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/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}": { "get": { "operationId": "PrivateLinkScopes_Get", "description": "Returns a Azure Arc PrivateLinkScope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "scopeName", "in": "path", "description": "The name of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HybridComputePrivateLinkScope" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateLinkScopeGet": { "$ref": "./examples/privateLinkScope/PrivateLinkScopes_Get.json" } } }, "put": { "operationId": "PrivateLinkScopes_CreateOrUpdate", "description": "Creates (or updates) a Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "scopeName", "in": "path", "description": "The name of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "parameters", "in": "body", "description": "Properties that need to be specified to create or update a Azure Arc for Servers and Clusters PrivateLinkScope.", "required": true, "schema": { "$ref": "#/definitions/HybridComputePrivateLinkScope" } } ], "responses": { "200": { "description": "Resource 'HybridComputePrivateLinkScope' update operation succeeded", "schema": { "$ref": "#/definitions/HybridComputePrivateLinkScope" } }, "201": { "description": "Resource 'HybridComputePrivateLinkScope' create operation succeeded", "schema": { "$ref": "#/definitions/HybridComputePrivateLinkScope" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateLinkScopeCreate": { "$ref": "./examples/privateLinkScope/PrivateLinkScopes_Create.json" }, "PrivateLinkScopeUpdate": { "$ref": "./examples/privateLinkScope/PrivateLinkScopes_Update.json" } } }, "patch": { "operationId": "PrivateLinkScopes_UpdateTags", "description": "Updates an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "scopeName", "in": "path", "description": "The name of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "PrivateLinkScopeTags", "in": "body", "description": "Updated tag information to set into the PrivateLinkScope instance.", "required": true, "schema": { "$ref": "#/definitions/TagsResource" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/HybridComputePrivateLinkScope" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateLinkScopeUpdateTagsOnly": { "$ref": "./examples/privateLinkScope/PrivateLinkScopes_UpdateTagsOnly.json" } } }, "delete": { "operationId": "PrivateLinkScopes_Delete", "description": "Deletes a Azure Arc PrivateLinkScope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "scopeName", "in": "path", "description": "The name of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "PrivateLinkScopesDelete": { "$ref": "./examples/privateLinkScope/PrivateLinkScopes_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/networkSecurityPerimeterConfigurations": { "get": { "operationId": "NetworkSecurityPerimeterConfigurations_ListByPrivateLinkScope", "tags": [ "NetworkSecurityPerimeterConfiguration" ], "description": "Lists the network security perimeter configurations for a private link scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "scopeName", "in": "path", "description": "The name of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets the list of network security perimeter configurations of the private link scope.": { "$ref": "./examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/networkSecurityPerimeterConfigurations/{perimeterName}": { "get": { "operationId": "NetworkSecurityPerimeterConfigurations_GetByPrivateLinkScope", "tags": [ "NetworkSecurityPerimeterConfiguration" ], "description": "Gets the network security perimeter configuration for a private link scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "scopeName", "in": "path", "description": "The name of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "perimeterName", "in": "path", "description": "The name, in the format {perimeterGuid}.{associationName}, of the Network Security Perimeter resource.", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[.]{1}.+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets the network security perimeter configuration of the private link scope.": { "$ref": "./examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/networkSecurityPerimeterConfigurations/{perimeterName}/reconcile": { "post": { "operationId": "NetworkSecurityPerimeterConfigurations_ReconcileForPrivateLinkScope", "tags": [ "NetworkSecurityPerimeterConfiguration" ], "description": "Forces the network security perimeter configuration to refresh for a private link scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "scopeName", "in": "path", "description": "The name of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "perimeterName", "in": "path", "description": "The name, in the format {perimeterGuid}.{associationName}, of the Network Security Perimeter resource.", "required": true, "type": "string", "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[.]{1}.+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationReconcileResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Reconciles the network security perimeter configuration of the private link scope.": { "$ref": "./examples/networkSecurityPerimeterConfiguration/NetworkSecurityPerimeterConfigurationReconcile.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/NetworkSecurityPerimeterConfigurationReconcileResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections": { "get": { "operationId": "PrivateEndpointConnections_ListByPrivateLinkScope", "tags": [ "PrivateEndpointConnections" ], "description": "Gets all private endpoint connections on a private link scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "scopeName", "in": "path", "description": "The name of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets list of private endpoint connections on a private link scope.": { "$ref": "./examples/privateEndpoint/PrivateEndpointConnection_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "operationId": "PrivateEndpointConnections_Get", "tags": [ "PrivateEndpointConnections" ], "description": "Gets a private endpoint connection.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "scopeName", "in": "path", "description": "The name of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets private endpoint connection.": { "$ref": "./examples/privateEndpoint/PrivateEndpointConnection_Get.json" } } }, "put": { "operationId": "PrivateEndpointConnections_CreateOrUpdate", "tags": [ "PrivateEndpointConnections" ], "description": "Approve or reject a private endpoint connection with a given name.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "scopeName", "in": "path", "description": "The name of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } } ], "responses": { "200": { "description": "Resource 'PrivateEndpointConnection' update operation succeeded", "schema": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Approve or reject a private endpoint connection with a given name.": { "$ref": "./examples/privateEndpoint/PrivateEndpointConnection_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/PrivateEndpointConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "PrivateEndpointConnections_Delete", "tags": [ "PrivateEndpointConnections" ], "description": "Deletes a private endpoint connection with a given name.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "scopeName", "in": "path", "description": "The name of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "privateEndpointConnectionName", "in": "path", "description": "The name of the private endpoint connection.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Azure-AsyncOperation": { "type": "string", "format": "uri", "description": "A link to the status monitor" }, "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Deletes a private endpoint connection with a given name.": { "$ref": "./examples/privateEndpoint/PrivateEndpointConnection_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources": { "get": { "operationId": "PrivateLinkResources_ListByPrivateLinkScope", "tags": [ "PrivateLinkResources" ], "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "scopeName", "in": "path", "description": "The name of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets private endpoint connection.": { "$ref": "./examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_ListGet.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/privateLinkScopes/{scopeName}/privateLinkResources/{groupName}": { "get": { "operationId": "PrivateLinkResources_Get", "tags": [ "PrivateLinkResources" ], "description": "Gets the private link resources that need to be created for a Azure Monitor PrivateLinkScope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "scopeName", "in": "path", "description": "The name of the Azure Arc PrivateLinkScope resource.", "required": true, "type": "string", "pattern": "[a-zA-Z0-9-_\\.]+" }, { "name": "groupName", "in": "path", "description": "The name of the private link resource.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/PrivateLinkResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Gets private endpoint connection.": { "$ref": "./examples/privateLinkScope/PrivateLinkScopePrivateLinkResource_Get.json" } } } } }, "definitions": { "AccessMode": { "type": "string", "description": "Property that impacts a resource's logging behavior and its connectivity with other resources and public networks.", "enum": [ "enforced", "audit", "learning" ], "x-ms-enum": { "name": "AccessMode", "modelAsString": true, "values": [ { "name": "enforced", "value": "enforced", "description": "Indicates that resource access is controlled by the NSP definition." }, { "name": "audit", "value": "audit", "description": "Dry run mode, where traffic is evaluated against NSP Rules, logged but not enforced." }, { "name": "learning", "value": "learning", "description": "Enables traffic evaluation to fall back to resource-specific firewall configurations." } ] } }, "AccessRule": { "type": "object", "description": "Access rule.", "properties": { "name": { "type": "string", "description": "Name of the access rule.", "readOnly": true }, "properties": { "$ref": "#/definitions/AccessRuleProperties", "description": "Access rule properties", "readOnly": true, "x-ms-client-flatten": true } } }, "AccessRuleDirection": { "type": "string", "description": "Indicates direction of an access rule.", "enum": [ "Inbound", "Outbound" ], "x-ms-enum": { "name": "AccessRuleDirection", "modelAsString": true, "values": [ { "name": "Inbound", "value": "Inbound", "description": "Traffic originates outside of network." }, { "name": "Outbound", "value": "Outbound", "description": "Traffic originates inside the network" } ] } }, "AccessRuleProperties": { "type": "object", "description": "Properties of an access rule.", "properties": { "direction": { "$ref": "#/definitions/AccessRuleDirection", "description": "Direction of the access rule.", "readOnly": true }, "addressPrefixes": { "type": "array", "description": "Address prefixes that are allowed access.", "items": { "type": "string" }, "readOnly": true } } }, "AgentConfiguration": { "type": "object", "description": "Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM.", "properties": { "proxyUrl": { "type": "string", "description": "Specifies the URL of the proxy to be used.", "readOnly": true }, "incomingConnectionsPorts": { "type": "array", "description": "Specifies the list of ports that the agent will be able to listen on.", "items": { "type": "string" }, "readOnly": true }, "extensionsAllowList": { "type": "array", "description": "Array of extensions that are allowed to be installed or updated.", "items": { "$ref": "#/definitions/ConfigurationExtension" }, "readOnly": true, "x-ms-identifiers": [] }, "extensionsBlockList": { "type": "array", "description": "Array of extensions that are blocked (cannot be installed or updated)", "items": { "$ref": "#/definitions/ConfigurationExtension" }, "readOnly": true, "x-ms-identifiers": [] }, "proxyBypass": { "type": "array", "description": "List of service names which should not use the specified proxy server.", "items": { "type": "string" }, "readOnly": true }, "extensionsEnabled": { "type": "string", "description": "Specifies whether the extension service is enabled or disabled.", "readOnly": true }, "guestConfigurationEnabled": { "type": "string", "description": "Specified whether the guest configuration service is enabled or disabled.", "readOnly": true }, "configMode": { "$ref": "#/definitions/AgentConfigurationMode", "description": "Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft.", "readOnly": true } } }, "AgentConfigurationMode": { "type": "string", "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": "AgentConfigurationMode", "modelAsString": true, "values": [ { "name": "full", "value": "full", "description": "full" }, { "name": "monitor", "value": "monitor", "description": "monitor" } ] } }, "AgentUpgrade": { "type": "object", "description": "The info w.r.t Agent Upgrade.", "properties": { "desiredVersion": { "type": "string", "description": "Specifies the version info w.r.t AgentUpgrade for the machine." }, "correlationId": { "type": "string", "format": "uuid", "description": "The correlation ID associated with an agent upgrade operation." }, "enableAutomaticUpgrade": { "type": "boolean", "description": "Specifies if the machine's agent should be upgraded" }, "lastAttemptDesiredVersion": { "type": "string", "description": "Specifies the version of the last attempt", "readOnly": true }, "lastAttemptTimestamp": { "type": "string", "format": "date-time", "description": "Timestamp of last upgrade attempt", "readOnly": true }, "lastAttemptStatus": { "$ref": "#/definitions/LastAttemptStatusEnum", "description": "Specifies the status of Agent Upgrade.", "readOnly": true }, "lastAttemptMessage": { "type": "string", "description": "Failure message of last upgrade attempt if any.", "readOnly": true } } }, "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, "values": [ { "name": "AVS", "value": "AVS", "description": "AVS" }, { "name": "HCI", "value": "HCI", "description": "HCI" }, { "name": "SCVMM", "value": "SCVMM", "description": "SCVMM" }, { "name": "VMware", "value": "VMware", "description": "VMware" }, { "name": "EPS", "value": "EPS", "description": "EPS" }, { "name": "GCP", "value": "GCP", "description": "GCP" }, { "name": "AWS", "value": "AWS", "description": "AWS" } ] } }, "AssessmentModeTypes": { "type": "string", "description": "Specifies the assessment mode.", "enum": [ "ImageDefault", "AutomaticByPlatform" ], "x-ms-enum": { "name": "AssessmentModeTypes", "modelAsString": true, "values": [ { "name": "ImageDefault", "value": "ImageDefault", "description": "ImageDefault" }, { "name": "AutomaticByPlatform", "value": "AutomaticByPlatform", "description": "AutomaticByPlatform" } ] } }, "AvailablePatchCountByClassification": { "type": "object", "description": "Summarization of patches available for installation on the machine by classification.", "properties": { "security": { "type": "integer", "format": "int32", "description": "Number of security patches available for installation.", "readOnly": true }, "critical": { "type": "integer", "format": "int32", "description": "Number of critical patches available for installation.", "readOnly": true }, "definition": { "type": "integer", "format": "int32", "description": "Number of definition patches available for installation.", "readOnly": true }, "updateRollup": { "type": "integer", "format": "int32", "description": "Number of update Rollup patches available for installation.", "readOnly": true }, "featurePack": { "type": "integer", "format": "int32", "description": "Number of feature pack patches available for installation.", "readOnly": true }, "servicePack": { "type": "integer", "format": "int32", "description": "Number of service pack patches available for installation.", "readOnly": true }, "tools": { "type": "integer", "format": "int32", "description": "Number of tools patches available for installation.", "readOnly": true }, "updates": { "type": "integer", "format": "int32", "description": "Number of updates category patches available for installation.", "readOnly": true }, "other": { "type": "integer", "format": "int32", "description": "Number of other patches available for installation.", "readOnly": true } } }, "CloudMetadata": { "type": "object", "description": "The metadata of the cloud environment (Azure/GCP/AWS/OCI...).", "properties": { "provider": { "type": "string", "description": "Specifies the cloud provider (Azure/AWS/GCP...).", "readOnly": true } } }, "ConfigurationExtension": { "type": "object", "description": "Describes properties that can identify extensions.", "properties": { "publisher": { "type": "string", "description": "Publisher of the extension.", "readOnly": true }, "type": { "type": "string", "description": "Type of the extension.", "readOnly": true } } }, "ConnectionDetail": { "type": "object", "properties": { "id": { "type": "string", "description": "Azure resource Id", "readOnly": true }, "privateIpAddress": { "type": "string", "description": "The private endpoint connection private ip address", "readOnly": true }, "linkIdentifier": { "type": "string", "description": "The private endpoint connection link identifier", "readOnly": true }, "groupId": { "type": "string", "description": "The private endpoint connection group id", "readOnly": true }, "memberName": { "type": "string", "description": "The private endpoint connection member name", "readOnly": true } } }, "Disk": { "type": "object", "description": "Describes a disk on the machine", "properties": { "path": { "type": "string", "description": "The path of the disk." }, "diskType": { "type": "string", "description": "The type of the disk." }, "generatedId": { "type": "string", "description": "The generated ID of the disk." }, "id": { "type": "string", "description": "The ID of the disk." }, "name": { "type": "string", "description": "The name of the disk." }, "maxSizeInBytes": { "type": "integer", "format": "int64", "description": "The size of the disk, in bytes" }, "usedSpaceInBytes": { "type": "integer", "format": "int64", "description": "The amount of space used on the disk, in bytes" } } }, "EsuEligibility": { "type": "string", "description": "The ESU eligibility.", "enum": [ "Eligible", "Ineligible", "Unknown" ], "x-ms-enum": { "name": "EsuEligibility", "modelAsString": true, "values": [ { "name": "Eligible", "value": "Eligible", "description": "Eligible" }, { "name": "Ineligible", "value": "Ineligible", "description": "Ineligible" }, { "name": "Unknown", "value": "Unknown", "description": "Unknown" } ] } }, "EsuKey": { "type": "object", "description": "ESU key", "properties": { "sku": { "type": "string", "description": "SKU number." }, "licenseStatus": { "type": "integer", "format": "int32", "description": "The current status of the license profile key. Represented by the same integer value that is presented on the machine itself when querying the license key status." } } }, "EsuKeyState": { "type": "string", "description": "The ESU key state.", "enum": [ "Inactive", "Active" ], "x-ms-enum": { "name": "EsuKeyState", "modelAsString": true, "values": [ { "name": "Inactive", "value": "Inactive", "description": "Inactive" }, { "name": "Active", "value": "Active", "description": "Active" } ] } }, "EsuProfileUpdateProperties": { "type": "object", "description": "Describes the Update properties of a ESU License Profile.", "properties": { "assignedLicense": { "type": "string", "description": "The resource id of the license." } } }, "EsuServerType": { "type": "string", "description": "The server types for Esu.", "enum": [ "Standard", "Datacenter" ], "x-ms-enum": { "name": "EsuServerType", "modelAsString": true, "values": [ { "name": "Standard", "value": "Standard", "description": "Standard" }, { "name": "Datacenter", "value": "Datacenter", "description": "Datacenter" } ] } }, "ExecutionState": { "type": "string", "description": "Script execution status.", "enum": [ "Unknown", "Pending", "Running", "Failed", "Succeeded", "TimedOut", "Canceled" ], "x-ms-enum": { "name": "ExecutionState", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown", "description": "Unknown" }, { "name": "Pending", "value": "Pending", "description": "Pending" }, { "name": "Running", "value": "Running", "description": "Running" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "TimedOut", "value": "TimedOut", "description": "TimedOut" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" } ] } }, "ExtensionPublisher": { "type": "object", "description": "Describes an Extension Publisher.", "properties": { "id": { "type": "string", "description": "The ID of the extension publisher." }, "name": { "type": "string", "description": "The name of the extension publisher." } } }, "ExtensionPublisherListResult": { "type": "object", "description": "The List of Extension Publishers.", "properties": { "value": { "type": "array", "description": "The ExtensionPublisher items on this page", "items": { "$ref": "#/definitions/ExtensionPublisher" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExtensionTargetProperties": { "type": "object", "description": "Describes the Machine Extension Target Version Properties", "properties": { "targetVersion": { "type": "string", "description": "Properties for the specified Extension to Upgrade." } } }, "ExtensionType": { "type": "object", "description": "Describes an Extension Type.", "properties": { "id": { "type": "string", "description": "The ID of the extension type." }, "name": { "type": "string", "description": "The name of the extension type." } } }, "ExtensionTypeListResult": { "type": "object", "description": "The List of Extension Types.", "properties": { "value": { "type": "array", "description": "The ExtensionType items on this page", "items": { "$ref": "#/definitions/ExtensionType" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExtensionValue": { "type": "object", "description": "Describes a Extension Metadata", "properties": { "properties": { "$ref": "#/definitions/ExtensionValueProperties", "description": "The single extension based on search criteria", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ExtensionValueListResult": { "type": "object", "description": "The List Extension Metadata response.", "properties": { "value": { "type": "array", "description": "The list of extension metadata", "items": { "$ref": "#/definitions/ExtensionValue" }, "readOnly": true, "x-ms-identifiers": [] }, "nextLink": { "type": "string", "format": "uri", "description": "The URL to get the next set of results.", "readOnly": true } } }, "ExtensionValueListResultV2": { "type": "object", "description": "The List Extension Metadata response.", "properties": { "value": { "type": "array", "description": "The ExtensionValueV2 items on this page", "items": { "$ref": "#/definitions/ExtensionValueV2" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExtensionValueProperties": { "type": "object", "description": "Describes Extension Metadata properties", "properties": { "version": { "type": "string", "description": "The version of the Extension being received.", "readOnly": true }, "extensionType": { "type": "string", "description": "The type of the Extension being received.", "readOnly": true }, "publisher": { "type": "string", "description": "The publisher of the Extension being received.", "readOnly": true } } }, "ExtensionValueV2": { "type": "object", "description": "Describes an Extension Metadata.", "properties": { "properties": { "$ref": "#/definitions/ExtensionValueV2Properties", "description": "The single extension based on search criteria.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "ExtensionValueV2Properties": { "type": "object", "description": "Describes Extension Metadata properties.", "properties": { "extensionUris": { "type": "array", "description": "A list of locations where the extension packages can be found.", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "extensionSignatureUri": { "type": "string", "format": "uri", "description": "Location of the signature files for the extension.", "readOnly": true }, "operatingSystem": { "type": "string", "description": "The operating system (Windows, Linux, etc.) this extension supports.", "readOnly": true }, "architecture": { "type": "array", "description": "Architectures (x64, arms64, etc.) that this extension supports.", "items": { "type": "string" }, "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/ExtensionValueProperties" } ] }, "ExtensionsResourceStatus": { "type": "object", "description": "Instance view status.", "properties": { "code": { "type": "string", "description": "The status code." }, "level": { "$ref": "#/definitions/ExtensionsStatusLevelTypes", "description": "The level code." }, "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." } } }, "ExtensionsStatusLevelTypes": { "type": "string", "description": "The level code.", "enum": [ "Info", "Warning", "Error" ], "x-ms-enum": { "name": "ExtensionsStatusLevelTypes", "modelAsString": false, "values": [ { "name": "Info", "value": "Info", "description": "Info" }, { "name": "Warning", "value": "Warning", "description": "Warning" }, { "name": "Error", "value": "Error", "description": "Error" } ] } }, "FirmwareProfile": { "type": "object", "description": "Describes the firmware of the machine", "properties": { "serialNumber": { "type": "string", "description": "The serial number of the firmware", "readOnly": true }, "type": { "type": "string", "description": "The type of the firmware", "readOnly": true } } }, "Gateway": { "type": "object", "description": "Describes an Arc Gateway.", "properties": { "properties": { "$ref": "#/definitions/GatewayProperties", "description": "Hybrid Compute Gateway properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "GatewayProperties": { "type": "object", "description": "Describes the properties of a Gateway Profile.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state, which only appears in the response.", "readOnly": true }, "gatewayId": { "type": "string", "description": "A unique, immutable, identifier for the Gateway.", "readOnly": true }, "gatewayType": { "$ref": "#/definitions/GatewayType", "description": "The type of the Gateway resource." }, "gatewayEndpoint": { "type": "string", "description": "The endpoint fqdn for the Gateway.", "readOnly": true }, "allowedFeatures": { "type": "array", "description": "Specifies the list of features that are enabled for this Gateway.", "items": { "type": "string" } }, "gatewayBypass": { "type": "array", "description": "Specifies the list of domain names that should bypass the gateway. Each entry must be a valid DNS hostname.", "items": { "type": "string" } } } }, "GatewayType": { "type": "string", "description": "The type of the Gateway resource.", "enum": [ "Public" ], "x-ms-enum": { "name": "GatewayType", "modelAsString": true, "values": [ { "name": "Public", "value": "Public", "description": "Public" } ] } }, "GatewayUpdate": { "type": "object", "description": "Describes a Gateway Update.", "properties": { "properties": { "$ref": "#/definitions/GatewayUpdateProperties", "description": "Gateway Update properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/ResourceUpdate" } ] }, "GatewayUpdateProperties": { "type": "object", "description": "Describes the Update properties of a Gateway Profile.", "properties": { "allowedFeatures": { "type": "array", "description": "Specifies the list of features that are enabled for this Gateway.", "items": { "type": "string" } }, "gatewayBypass": { "type": "array", "description": "Specifies the list of domain names that should bypass the gateway. Each entry must be a valid DNS hostname.", "items": { "type": "string" } } } }, "GatewaysListResult": { "type": "object", "description": "Paged collection of Gateway items", "properties": { "value": { "type": "array", "description": "The Gateway items on this page", "items": { "$ref": "#/definitions/Gateway" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "HardwareProfile": { "type": "object", "description": "Describes the hardware of the machine", "properties": { "totalPhysicalMemoryInBytes": { "type": "integer", "format": "int64", "description": "The total physical memory on the machine", "readOnly": true }, "numberOfCpuSockets": { "type": "integer", "format": "int32", "description": "The total number of CPU sockets available on the machine", "readOnly": true }, "processors": { "type": "array", "description": "The physical processors of the machine.", "items": { "$ref": "#/definitions/Processor" }, "readOnly": true } } }, "HotpatchEnablementStatus": { "type": "string", "description": "Status of hotpatch enablement or disablement.", "enum": [ "Unknown", "PendingEvaluation", "Disabled", "ActionRequired", "Enabled" ], "x-ms-enum": { "name": "HotpatchEnablementStatus", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown", "description": "Unknown" }, { "name": "PendingEvaluation", "value": "PendingEvaluation", "description": "PendingEvaluation" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "ActionRequired", "value": "ActionRequired", "description": "ActionRequired" }, { "name": "Enabled", "value": "Enabled", "description": "Enabled" } ] } }, "HybridComputePrivateLinkScope": { "type": "object", "description": "An Azure Arc PrivateLinkScope definition.", "properties": { "properties": { "$ref": "#/definitions/HybridComputePrivateLinkScopeProperties", "description": "Properties that define a Azure Arc PrivateLinkScope resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "HybridComputePrivateLinkScopeListResult": { "type": "object", "description": "The response of a HybridComputePrivateLinkScope list operation.", "properties": { "value": { "type": "array", "description": "The HybridComputePrivateLinkScope items on this page", "items": { "$ref": "#/definitions/HybridComputePrivateLinkScope" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "HybridComputePrivateLinkScopeProperties": { "type": "object", "description": "Properties that define a Azure Arc PrivateLinkScope resource.", "properties": { "publicNetworkAccess": { "type": "string", "description": "Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.", "default": "Disabled", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "PublicNetworkAccessType", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints." }, { "name": "Disabled", "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." } ] } }, "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": { "type": "string", "description": "The Guid id of the private link scope.", "readOnly": true }, "privateEndpointConnections": { "type": "array", "description": "The collection of associated Private Endpoint Connections.", "items": { "$ref": "#/definitions/PrivateEndpointConnectionDataModel" }, "readOnly": true }, "serviceExtensions": { "type": "array", "description": "Enable private link validation for an Azure Arc Extension.", "items": { "$ref": "#/definitions/ServiceExtension" } } } }, "IdentityKeyStore": { "type": "string", "description": "Specifies the identity key store a machine is using.", "enum": [ "TPM", "Default", "TpmTransition" ], "x-ms-enum": { "name": "IdentityKeyStore", "modelAsString": true, "values": [ { "name": "TPM", "value": "TPM", "description": "TPM" }, { "name": "Default", "value": "Default", "description": "Default" }, { "name": "TpmTransition", "value": "TpmTransition", "description": "The machine is transitioning its identity key store to TPM." } ] } }, "IpAddress": { "type": "object", "description": "Describes properties of the IP address.", "properties": { "address": { "type": "string", "description": "Represents the IP Address." }, "ipAddressVersion": { "type": "string", "description": "Represents the Ip Address Version." }, "subnet": { "$ref": "#/definitions/Subnet", "description": "The subnet to which this IP address belongs.", "readOnly": true } } }, "LastAttemptStatusEnum": { "type": "string", "description": "Specifies the status of Agent Upgrade.", "enum": [ "Success", "Failed" ], "x-ms-enum": { "name": "LastAttemptStatusEnum", "modelAsString": true, "values": [ { "name": "Success", "value": "Success", "description": "Success" }, { "name": "Failed", "value": "Failed", "description": "Failed" } ] } }, "License": { "type": "object", "description": "Describes a license in a hybrid machine.", "properties": { "properties": { "$ref": "#/definitions/LicenseProperties", "description": "Hybrid Compute License properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "LicenseAssignmentState": { "type": "string", "description": "Describes the license assignment state (Assigned or NotAssigned).", "enum": [ "Assigned", "NotAssigned" ], "x-ms-enum": { "name": "LicenseAssignmentState", "modelAsString": true, "values": [ { "name": "Assigned", "value": "Assigned", "description": "Assigned" }, { "name": "NotAssigned", "value": "NotAssigned", "description": "NotAssigned" } ] } }, "LicenseCoreType": { "type": "string", "description": "Describes the license core type (pCore or vCore).", "enum": [ "pCore", "vCore" ], "x-ms-enum": { "name": "LicenseCoreType", "modelAsString": true, "values": [ { "name": "pCore", "value": "pCore", "description": "pCore" }, { "name": "vCore", "value": "vCore", "description": "vCore" } ] } }, "LicenseDetails": { "type": "object", "description": "Describes the properties of a License.", "properties": { "state": { "$ref": "#/definitions/LicenseState", "description": "Describes the state of the license." }, "target": { "$ref": "#/definitions/LicenseTarget", "description": "Describes the license target server." }, "edition": { "$ref": "#/definitions/LicenseEdition", "description": "Describes the edition of the license. The values are either Standard or Datacenter." }, "type": { "$ref": "#/definitions/LicenseCoreType", "description": "Describes the license core type (pCore or vCore)." }, "processors": { "type": "integer", "format": "int32", "description": "Describes the number of processors." }, "assignedLicenses": { "type": "integer", "format": "int32", "description": "Describes the number of assigned licenses.", "readOnly": true }, "immutableId": { "type": "string", "description": "Describes the immutable id.", "readOnly": true }, "volumeLicenseDetails": { "type": "array", "description": "A list of volume license details.", "items": { "$ref": "#/definitions/VolumeLicenseDetails" } } } }, "LicenseEdition": { "type": "string", "description": "Describes the edition of the license. The values are either Standard or Datacenter.", "enum": [ "Standard", "Datacenter" ], "x-ms-enum": { "name": "LicenseEdition", "modelAsString": true, "values": [ { "name": "Standard", "value": "Standard", "description": "Standard" }, { "name": "Datacenter", "value": "Datacenter", "description": "Datacenter" } ] } }, "LicenseProfile": { "type": "object", "description": "Describes a license profile in a hybrid machine.", "properties": { "properties": { "$ref": "#/definitions/LicenseProfileProperties", "description": "Describe the properties of a license profile.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "LicenseProfileArmEsuProperties": { "type": "object", "description": "Describes the properties of a License Profile ARM model.", "properties": { "assignedLicense": { "type": "string", "description": "The resource id of the license." } }, "allOf": [ { "$ref": "#/definitions/LicenseProfileArmEsuPropertiesWithoutAssignedLicense" } ] }, "LicenseProfileArmEsuPropertiesWithoutAssignedLicense": { "type": "object", "description": "Describes the properties of a License Profile ARM model.", "properties": { "serverType": { "$ref": "#/definitions/EsuServerType", "description": "The type of the Esu servers.", "readOnly": true }, "esuEligibility": { "$ref": "#/definitions/EsuEligibility", "description": "Indicates the eligibility state of Esu.", "readOnly": true }, "esuKeyState": { "$ref": "#/definitions/EsuKeyState", "description": "Indicates whether there is an ESU Key currently active for the machine.", "readOnly": true } }, "allOf": [ { "$ref": "#/definitions/LicenseProfileStorageModelEsuProperties" } ] }, "LicenseProfileArmProductProfileProperties": { "type": "object", "description": "Describes the properties of a Product License Profile ARM model.", "properties": { "subscriptionStatus": { "$ref": "#/definitions/LicenseProfileSubscriptionStatus", "description": "Indicates the subscription status of the product." }, "productType": { "$ref": "#/definitions/LicenseProfileProductType", "description": "Indicates the product type of the license." }, "enrollmentDate": { "type": "string", "format": "date-time", "description": "The timestamp in UTC when the user enrolls the feature.", "readOnly": true }, "billingStartDate": { "type": "string", "format": "date-time", "description": "The timestamp in UTC when the billing starts.", "readOnly": true }, "disenrollmentDate": { "type": "string", "format": "date-time", "description": "The timestamp in UTC when the user disenrolled the feature.", "readOnly": true }, "billingEndDate": { "type": "string", "format": "date-time", "description": "The timestamp in UTC when the billing ends.", "readOnly": true }, "error": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "The errors that were encountered during the feature enrollment or disenrollment.", "readOnly": true }, "productFeatures": { "type": "array", "description": "The list of product features.", "items": { "$ref": "#/definitions/ProductFeature" }, "x-ms-identifiers": [] } } }, "LicenseProfileMachineInstanceView": { "type": "object", "description": "License Profile Instance View in Machine Properties.", "properties": { "licenseStatus": { "$ref": "#/definitions/LicenseStatus", "description": "Indicates the license status of the OS.", "readOnly": true }, "licenseChannel": { "type": "string", "description": "Indicates the license channel.", "readOnly": true }, "softwareAssurance": { "$ref": "#/definitions/LicenseProfileMachineInstanceViewSoftwareAssurance", "readOnly": true, "x-ms-client-flatten": true }, "esuProfile": { "$ref": "#/definitions/LicenseProfileMachineInstanceViewEsuProperties", "description": "Properties for the Machine ESU profile." }, "productProfile": { "$ref": "#/definitions/LicenseProfileArmProductProfileProperties", "description": "Hybrid Compute Product Profile properties", "readOnly": true, "x-ms-client-flatten": true } } }, "LicenseProfileMachineInstanceViewEsuProperties": { "type": "object", "description": "Properties for the Machine ESU profile.", "properties": { "assignedLicense": { "$ref": "#/definitions/License", "description": "The assigned license resource." }, "licenseAssignmentState": { "$ref": "#/definitions/LicenseAssignmentState", "description": "Describes the license assignment state (Assigned or NotAssigned)." } }, "allOf": [ { "$ref": "#/definitions/LicenseProfileArmEsuPropertiesWithoutAssignedLicense" } ] }, "LicenseProfileMachineInstanceViewSoftwareAssurance": { "type": "object", "properties": { "softwareAssuranceCustomer": { "type": "boolean", "description": "Specifies if this machine is licensed as part of a Software Assurance agreement." } } }, "LicenseProfileProductType": { "type": "string", "description": "The product type of the license.", "enum": [ "WindowsServer", "WindowsIoTEnterprise" ], "x-ms-enum": { "name": "LicenseProfileProductType", "modelAsString": true, "values": [ { "name": "WindowsServer", "value": "WindowsServer", "description": "WindowsServer" }, { "name": "WindowsIoTEnterprise", "value": "WindowsIoTEnterprise", "description": "WindowsIoTEnterprise" } ] } }, "LicenseProfileProperties": { "type": "object", "description": "Describe the properties of a license profile.", "properties": { "softwareAssurance": { "$ref": "#/definitions/LicenseProfilePropertiesSoftwareAssurance", "x-ms-client-flatten": true }, "esuProfile": { "$ref": "#/definitions/LicenseProfileArmEsuProperties", "description": "Hybrid Compute ESU Profile properties", "x-ms-client-flatten": true }, "productProfile": { "$ref": "#/definitions/LicenseProfileArmProductProfileProperties", "description": "Hybrid Compute Product Profile properties", "x-ms-client-flatten": true }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state, which only appears in the response.", "readOnly": true } } }, "LicenseProfilePropertiesSoftwareAssurance": { "type": "object", "properties": { "softwareAssuranceCustomer": { "type": "boolean", "description": "Specifies if this machine is licensed as part of a Software Assurance agreement." } } }, "LicenseProfileStorageModelEsuProperties": { "type": "object", "description": "License profile storage model for ESU properties.", "properties": { "assignedLicenseImmutableId": { "type": "string", "description": "The guid id of the license.", "readOnly": true }, "esuKeys": { "type": "array", "description": "The list of ESU keys.", "items": { "$ref": "#/definitions/EsuKey" }, "readOnly": true, "x-ms-identifiers": [] } } }, "LicenseProfileSubscriptionStatus": { "type": "string", "description": "Subscription status of the OS or Product feature.", "enum": [ "Unknown", "Enabling", "Enabled", "Disabled", "Disabling", "Failed" ], "x-ms-enum": { "name": "LicenseProfileSubscriptionStatus", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown", "description": "Unknown" }, { "name": "Enabling", "value": "Enabling", "description": "Enabling" }, { "name": "Enabled", "value": "Enabled", "description": "Enabled" }, { "name": "Disabled", "value": "Disabled", "description": "Disabled" }, { "name": "Disabling", "value": "Disabling", "description": "Disabling" }, { "name": "Failed", "value": "Failed", "description": "Failed" } ] } }, "LicenseProfileSubscriptionStatusUpdate": { "type": "string", "description": "Indicates the new subscription status of the OS or Product Features.", "enum": [ "Enable", "Disable" ], "x-ms-enum": { "name": "LicenseProfileSubscriptionStatusUpdate", "modelAsString": true, "values": [ { "name": "Enable", "value": "Enable", "description": "Enable" }, { "name": "Disable", "value": "Disable", "description": "Disable" } ] } }, "LicenseProfileUpdate": { "type": "object", "description": "Describes a License Profile Update.", "properties": { "properties": { "$ref": "#/definitions/LicenseProfileUpdateProperties", "description": "Describe the Update properties of a license profile.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/ResourceUpdate" } ] }, "LicenseProfileUpdateProperties": { "type": "object", "description": "Describe the Update properties of a license profile.", "properties": { "softwareAssurance": { "$ref": "#/definitions/LicenseProfileUpdatePropertiesSoftwareAssurance", "x-ms-client-flatten": true }, "esuProfile": { "$ref": "#/definitions/EsuProfileUpdateProperties", "description": "Hybrid Compute ESU Profile Update properties", "x-ms-client-flatten": true }, "productProfile": { "$ref": "#/definitions/ProductProfileUpdateProperties", "description": "Hybrid Compute Product Profile Update properties", "x-ms-client-flatten": true } } }, "LicenseProfileUpdatePropertiesSoftwareAssurance": { "type": "object", "properties": { "softwareAssuranceCustomer": { "type": "boolean", "description": "Specifies if this machine is licensed as part of a Software Assurance agreement." } } }, "LicenseProfilesListResult": { "type": "object", "description": "Paged collection of LicenseProfile items", "properties": { "value": { "type": "array", "description": "The LicenseProfile items on this page", "items": { "$ref": "#/definitions/LicenseProfile" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "LicenseProperties": { "type": "object", "description": "Describes the properties of a License Profile.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state, which only appears in the response.", "readOnly": true }, "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." } } }, "LicenseState": { "type": "string", "description": "Describes the state of the license.", "enum": [ "Activated", "Deactivated" ], "x-ms-enum": { "name": "LicenseState", "modelAsString": true, "values": [ { "name": "Activated", "value": "Activated", "description": "Activated" }, { "name": "Deactivated", "value": "Deactivated", "description": "Deactivated" } ] } }, "LicenseStatus": { "type": "string", "description": "The license status.", "enum": [ "Unlicensed", "Licensed", "OOBGrace", "OOTGrace", "NonGenuineGrace", "Notification", "ExtendedGrace" ], "x-ms-enum": { "name": "LicenseStatus", "modelAsString": true, "values": [ { "name": "Unlicensed", "value": "Unlicensed", "description": "Unlicensed" }, { "name": "Licensed", "value": "Licensed", "description": "Licensed" }, { "name": "OOBGrace", "value": "OOBGrace", "description": "OOBGrace" }, { "name": "OOTGrace", "value": "OOTGrace", "description": "OOTGrace" }, { "name": "NonGenuineGrace", "value": "NonGenuineGrace", "description": "NonGenuineGrace" }, { "name": "Notification", "value": "Notification", "description": "Notification" }, { "name": "ExtendedGrace", "value": "ExtendedGrace", "description": "ExtendedGrace" } ] } }, "LicenseTarget": { "type": "string", "description": "Describes the license target server.", "enum": [ "Windows Server 2012", "Windows Server 2012 R2", "Windows Server 2016" ], "x-ms-enum": { "name": "LicenseTarget", "modelAsString": true, "values": [ { "name": "Windows Server 2012", "value": "Windows Server 2012", "description": "Windows Server 2012" }, { "name": "Windows Server 2012 R2", "value": "Windows Server 2012 R2", "description": "Windows Server 2012 R2" }, { "name": "Windows Server 2016", "value": "Windows Server 2016", "description": "Windows Server 2016 license target." } ] } }, "LicenseType": { "type": "string", "description": "The type of the license resource.", "enum": [ "ESU" ], "x-ms-enum": { "name": "LicenseType", "modelAsString": true, "values": [ { "name": "ESU", "value": "ESU", "description": "ESU" } ] } }, "LicenseUpdate": { "type": "object", "description": "Describes a License Update.", "properties": { "properties": { "$ref": "#/definitions/LicenseUpdateProperties", "description": "License Update properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/ResourceUpdate" } ] }, "LicenseUpdateProperties": { "type": "object", "description": "Describes the Update properties of a License Profile.", "properties": { "licenseType": { "$ref": "#/definitions/LicenseType", "description": "The type of the license resource." }, "licenseDetails": { "$ref": "#/definitions/LicenseUpdatePropertiesLicenseDetails", "x-ms-client-flatten": true } } }, "LicenseUpdatePropertiesLicenseDetails": { "type": "object", "properties": { "state": { "$ref": "#/definitions/LicenseState", "description": "Describes the state of the license." }, "target": { "$ref": "#/definitions/LicenseTarget", "description": "Describes the license target server." }, "edition": { "$ref": "#/definitions/LicenseEdition", "description": "Describes the edition of the license. The values are either Standard or Datacenter." }, "type": { "$ref": "#/definitions/LicenseCoreType", "description": "Describes the license core type (pCore or vCore)." }, "processors": { "type": "integer", "format": "int32", "description": "Describes the number of processors." } } }, "LicensesListResult": { "type": "object", "description": "Paged collection of License items", "properties": { "value": { "type": "array", "description": "The License items on this page", "items": { "$ref": "#/definitions/License" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "LinuxParameters": { "type": "object", "description": "Input for InstallPatches on a Linux VM, as directly received by the API", "properties": { "classificationsToInclude": { "type": "array", "description": "The update classifications to select when installing patches for Linux.", "items": { "$ref": "#/definitions/VMGuestPatchClassification_Linux" } }, "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" } } } }, "Machine": { "type": "object", "description": "Describes a hybrid machine.", "properties": { "properties": { "$ref": "#/definitions/MachineProperties", "description": "Hybrid Compute Machine properties", "x-ms-client-flatten": true }, "resources": { "type": "array", "description": "The list of extensions affiliated to the machine", "items": { "$ref": "#/definitions/MachineExtension" }, "readOnly": true }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "Identity for the resource." }, "kind": { "$ref": "#/definitions/ArcKindEnum", "description": "Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "MachineAssessPatchesResult": { "type": "object", "description": "Describes the properties of an AssessPatches result.", "properties": { "status": { "$ref": "#/definitions/PatchOperationStatus", "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.\"", "readOnly": true }, "assessmentActivityId": { "type": "string", "format": "uuid", "description": "The activity ID of the operation that produced this result.", "readOnly": true }, "rebootPending": { "type": "boolean", "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.", "readOnly": true }, "availablePatchCountByClassification": { "$ref": "#/definitions/AvailablePatchCountByClassification", "description": "Summarization of patches available for installation on the machine by classification." }, "startDateTime": { "type": "string", "format": "date-time", "description": "The UTC timestamp when the operation began.", "readOnly": true }, "lastModifiedDateTime": { "type": "string", "format": "date-time", "description": "The UTC timestamp when the operation finished.", "readOnly": true }, "startedBy": { "$ref": "#/definitions/PatchOperationStartedBy", "description": "Indicates if operation was triggered by user or by platform.", "readOnly": true }, "patchServiceUsed": { "$ref": "#/definitions/PatchServiceUsed", "description": "Specifies the patch service used for the operation.", "readOnly": true }, "osType": { "$ref": "#/definitions/OsType", "description": "The operating system type of the machine.", "readOnly": true }, "errorDetails": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "The errors that were encountered during execution of the operation. The details array contains the list of them.", "readOnly": true } } }, "MachineExtension": { "type": "object", "description": "Describes a Machine Extension.", "properties": { "properties": { "$ref": "#/definitions/MachineExtensionProperties", "description": "Describes Machine Extension Properties." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "MachineExtensionInstanceView": { "type": "object", "description": "Describes the Machine Extension Instance View.", "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": { "$ref": "#/definitions/MachineExtensionInstanceViewStatus", "description": "Instance view status." } } }, "MachineExtensionInstanceViewStatus": { "type": "object", "description": "Instance view status.", "properties": { "code": { "type": "string", "description": "The status code." }, "level": { "$ref": "#/definitions/StatusLevelTypes", "description": "The level code." }, "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." } } }, "MachineExtensionProperties": { "type": "object", "description": "Describes the properties of a Machine Extension.", "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", "description": "Json formatted public settings for the extension.", "additionalProperties": {} }, "protectedSettings": { "type": "object", "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.", "additionalProperties": {} }, "provisioningState": { "type": "string", "description": "The provisioning state, which only appears in the response.", "readOnly": true }, "instanceView": { "$ref": "#/definitions/MachineExtensionInstanceView", "description": "The machine extension instance view." } } }, "MachineExtensionUpdate": { "type": "object", "description": "Describes a Machine Extension Update.", "properties": { "properties": { "$ref": "#/definitions/MachineExtensionUpdateProperties", "description": "Describes Machine Extension Update Properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/ResourceUpdate" } ] }, "MachineExtensionUpdateProperties": { "type": "object", "description": "Describes the properties of a Machine Extension.", "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", "description": "Json formatted public settings for the extension.", "additionalProperties": {} }, "protectedSettings": { "type": "object", "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.", "additionalProperties": {} } } }, "MachineExtensionUpgrade": { "type": "object", "description": "Describes the Machine Extension Upgrade Properties.", "properties": { "extensionTargets": { "type": "object", "description": "Describes the Extension Target Properties.", "additionalProperties": { "$ref": "#/definitions/ExtensionTargetProperties" } } } }, "MachineExtensionsListResult": { "type": "object", "description": "Paged collection of MachineExtension items", "properties": { "value": { "type": "array", "description": "The MachineExtension items on this page", "items": { "$ref": "#/definitions/MachineExtension" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "MachineInstallPatchesParameters": { "type": "object", "description": "Input for InstallPatches as directly received by the API", "properties": { "maximumDuration": { "type": "string", "format": "duration", "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": { "$ref": "#/definitions/VMGuestPatchRebootSetting", "description": "Defines when it is acceptable to reboot a VM during a software update operation." }, "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" ] }, "MachineInstallPatchesResult": { "type": "object", "description": "The result summary of an installation operation.", "properties": { "status": { "$ref": "#/definitions/PatchOperationStatus", "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.\"", "readOnly": true }, "installationActivityId": { "type": "string", "description": "The activity ID of the operation that produced this result.", "readOnly": true }, "rebootStatus": { "$ref": "#/definitions/VMGuestPatchRebootStatus", "description": "The reboot state of the VM following completion of the operation.", "readOnly": true }, "maintenanceWindowExceeded": { "type": "boolean", "description": "Whether the operation ran out of time before it completed all its intended actions.", "readOnly": true }, "excludedPatchCount": { "type": "integer", "format": "int32", "description": "The number of patches that were not installed due to the user blocking their installation.", "readOnly": true }, "notSelectedPatchCount": { "type": "integer", "format": "int32", "description": "The number of patches that were detected as available for install, but did not meet the operation's criteria.", "readOnly": true }, "pendingPatchCount": { "type": "integer", "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.", "readOnly": true }, "installedPatchCount": { "type": "integer", "format": "int32", "description": "The number of patches successfully installed.", "readOnly": true }, "failedPatchCount": { "type": "integer", "format": "int32", "description": "The number of patches that could not be installed due to some issue. See errors for details.", "readOnly": true }, "startDateTime": { "type": "string", "format": "date-time", "description": "The UTC timestamp when the operation began.", "readOnly": true }, "lastModifiedDateTime": { "type": "string", "format": "date-time", "description": "The UTC timestamp when the operation finished.", "readOnly": true }, "startedBy": { "$ref": "#/definitions/PatchOperationStartedBy", "description": "Indicates if operation was triggered by user or by platform.", "readOnly": true }, "patchServiceUsed": { "$ref": "#/definitions/PatchServiceUsed", "description": "Specifies the patch service used for the operation.", "readOnly": true }, "osType": { "$ref": "#/definitions/OsType", "description": "The operating system type of the machine.", "readOnly": true }, "errorDetails": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "The errors that were encountered during execution of the operation. The details array contains the list of them.", "readOnly": true } } }, "MachineListResult": { "type": "object", "description": "The response of a Machine list operation.", "properties": { "value": { "type": "array", "description": "The Machine items on this page", "items": { "$ref": "#/definitions/Machine" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "MachineProperties": { "type": "object", "description": "Describes the properties of a hybrid machine.", "properties": { "locationData": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/locationData", "description": "Metadata pertaining to the geographic location of the resource." }, "agentConfiguration": { "$ref": "#/definitions/AgentConfiguration", "description": "Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM.", "readOnly": true }, "serviceStatuses": { "$ref": "#/definitions/ServiceStatuses", "description": "Statuses of dependent services that are reported back to ARM." }, "hardwareProfile": { "$ref": "#/definitions/HardwareProfile", "description": "Information about the machine's hardware", "readOnly": true }, "storageProfile": { "$ref": "#/definitions/StorageProfile", "description": "Information about the machine's storage", "readOnly": true }, "firmwareProfile": { "$ref": "#/definitions/FirmwareProfile", "description": "Information about the machine's firmware", "readOnly": true }, "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 License related properties for a machine." }, "statusReason": { "$ref": "#/definitions/MachineStatusReason", "description": "Indicates whether the service has detected that this Arc machine is a clone of another onboarded machine. Service-computed; not settable by the user.", "readOnly": true }, "provisioningState": { "type": "string", "description": "The provisioning state, which only appears in the response.", "readOnly": true }, "status": { "$ref": "#/definitions/StatusTypes", "description": "The status of the hybrid machine agent.", "readOnly": true }, "lastStatusChange": { "type": "string", "format": "date-time", "description": "The time of the last status change.", "readOnly": true }, "errorDetails": { "type": "array", "description": "Details about the error state.", "items": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail" }, "readOnly": true, "x-ms-identifiers": [] }, "agentVersion": { "type": "string", "description": "The hybrid machine agent full version.", "readOnly": true }, "vmId": { "type": "string", "format": "uuid", "description": "Specifies the hybrid machine unique ID.", "x-ms-mutability": [ "read", "create" ] }, "displayName": { "type": "string", "description": "Specifies the hybrid machine display name.", "readOnly": true }, "machineFqdn": { "type": "string", "description": "Specifies the hybrid machine FQDN.", "readOnly": true }, "clientPublicKey": { "type": "string", "description": "Public Key that the client provides to be used during initial resource onboarding" }, "identityKeyStore": { "$ref": "#/definitions/IdentityKeyStore", "description": "Specifies the identity key store a machine is using." }, "tpmEkCertificate": { "type": "string", "description": "Endorsement Key Certificate of the Trusted Platform Module (TPM) that the client provides to be used during initial resource onboarding." }, "osName": { "type": "string", "description": "The Operating System running on the hybrid machine.", "readOnly": true }, "osVersion": { "type": "string", "description": "The version of Operating System running on the hybrid machine.", "readOnly": true }, "osType": { "type": "string", "description": "The type of Operating System (windows/linux)." }, "vmUuid": { "type": "string", "format": "uuid", "description": "Specifies the Arc Machine's unique SMBIOS ID", "readOnly": true }, "extensions": { "type": "array", "description": "Machine Extensions information (deprecated field)", "items": { "$ref": "#/definitions/MachineExtensionInstanceView" }, "x-ms-identifiers": [] }, "osSku": { "type": "string", "description": "Specifies the Operating System product SKU.", "readOnly": true }, "osEdition": { "type": "string", "description": "The edition of the Operating System.", "readOnly": true }, "domainName": { "type": "string", "description": "Specifies the Windows domain name.", "readOnly": true }, "adFqdn": { "type": "string", "description": "Specifies the AD fully qualified display name.", "readOnly": true }, "dnsFqdn": { "type": "string", "description": "Specifies the DNS fully qualified display name.", "readOnly": true }, "privateLinkScopeResourceId": { "type": "string", "format": "arm-id", "description": "The resource id of the private link scope this machine is assigned to, if any." }, "parentClusterResourceId": { "type": "string", "format": "arm-id", "description": "The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any." }, "hardwareResourceId": { "type": "string", "description": "Specifies the resource ID of the associated hardware device. Only settable by HCI RP." }, "mssqlDiscovered": { "type": "string", "description": "Specifies whether any MS SQL instance is discovered on the machine." }, "detectedProperties": { "type": "object", "description": "Detected properties from the machine.", "additionalProperties": { "type": "string" }, "readOnly": true }, "networkProfile": { "$ref": "#/definitions/NetworkProfile", "description": "Information about the network the machine is on.", "readOnly": true } } }, "MachineRunCommand": { "type": "object", "description": "Describes a Run Command", "properties": { "properties": { "$ref": "#/definitions/MachineRunCommandProperties", "description": "Describes Run Command Properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "MachineRunCommandInstanceView": { "type": "object", "description": "The instance view of a machine run command.", "properties": { "executionState": { "$ref": "#/definitions/ExecutionState", "description": "Script execution status." }, "executionMessage": { "type": "string", "description": "Communicate script configuration errors or execution messages." }, "exitCode": { "type": "integer", "format": "int32", "description": "Exit code returned from script execution." }, "output": { "type": "string", "description": "Script output stream." }, "error": { "type": "string", "description": "Script error stream." }, "startTime": { "type": "string", "format": "date-time", "description": "Script start time." }, "endTime": { "type": "string", "format": "date-time", "description": "Script end time." }, "statuses": { "type": "array", "description": "The status information.", "items": { "$ref": "#/definitions/ExtensionsResourceStatus" }, "x-ms-identifiers": [] } } }, "MachineRunCommandProperties": { "type": "object", "description": "Describes the properties of a run command.", "properties": { "source": { "$ref": "#/definitions/MachineRunCommandScriptSource", "description": "The source of the run command script." }, "parameters": { "type": "array", "description": "The parameters used by the script.", "items": { "$ref": "#/definitions/RunCommandInputParameter" }, "x-ms-identifiers": [ "name" ] }, "protectedParameters": { "type": "array", "description": "The parameters used by the script.", "items": { "$ref": "#/definitions/RunCommandInputParameter" }, "x-ms-identifiers": [ "name" ] }, "asyncExecution": { "type": "boolean", "description": "Optional. If set to true, provisioning will complete as soon as script starts and will not wait for script to complete.", "default": false }, "runAsUser": { "type": "string", "description": "Specifies the user account on the machine when executing the run command." }, "runAsPassword": { "type": "string", "format": "password", "description": "Specifies the user account password on the machine when executing the run command.", "x-ms-secret": true }, "timeoutInSeconds": { "type": "integer", "format": "int32", "description": "The timeout in seconds to execute the run command." }, "outputBlobUri": { "type": "string", "description": "Specifies the Azure storage blob where script output stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer outputBlobManagedIdentity parameter." }, "errorBlobUri": { "type": "string", "description": "Specifies the Azure storage blob where script error stream will be uploaded. Use a SAS URI with read, append, create, write access OR use managed identity to provide the VM access to the blob. Refer errorBlobManagedIdentity parameter." }, "outputBlobManagedIdentity": { "$ref": "#/definitions/RunCommandManagedIdentity", "description": "User-assigned managed identity that has access to outputBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged" }, "errorBlobManagedIdentity": { "$ref": "#/definitions/RunCommandManagedIdentity", "description": "User-assigned managed identity that has access to errorBlobUri storage blob. Use an empty object in case of system-assigned identity. Make sure managed identity has been given access to blob's container with 'Storage Blob Data Contributor' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged" }, "provisioningState": { "type": "string", "description": "The provisioning state, which only appears in the response.", "readOnly": true }, "instanceView": { "$ref": "#/definitions/MachineRunCommandInstanceView", "description": "The machine run command instance view.", "readOnly": true } } }, "MachineRunCommandScriptSource": { "type": "object", "description": "Describes the script sources for run command. Use only one of script, scriptUri, commandId.", "properties": { "script": { "type": "string", "description": "Specifies the script content to be executed on the machine." }, "scriptUri": { "type": "string", "description": "Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI." }, "commandId": { "type": "string", "description": "Specifies the commandId of predefined built-in script." }, "scriptUriManagedIdentity": { "$ref": "#/definitions/RunCommandManagedIdentity", "description": "User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged." } } }, "MachineRunCommandUpdate": { "type": "object", "description": "Describes a Machine Extension Update.", "allOf": [ { "$ref": "#/definitions/ResourceUpdate" } ] }, "MachineRunCommandsListResult": { "type": "object", "description": "Paged collection of MachineRunCommand items", "properties": { "value": { "type": "array", "description": "The MachineRunCommand items on this page", "items": { "$ref": "#/definitions/MachineRunCommand" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "MachineStatusReason": { "type": "string", "description": "The reason describing why the service set the machine status to a particular value.", "enum": [ "Cloned" ], "x-ms-enum": { "name": "MachineStatusReason", "modelAsString": true, "values": [ { "name": "Cloned", "value": "Cloned", "description": "Indicates the service has detected that this Arc machine is a clone of another onboarded machine." } ] } }, "MachineUpdate": { "type": "object", "description": "Describes a hybrid machine Update.", "properties": { "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "Identity for the resource." }, "kind": { "$ref": "#/definitions/ArcKindEnum", "description": "Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc." }, "properties": { "$ref": "#/definitions/MachineUpdateProperties", "description": "Hybrid Compute Machine properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "#/definitions/ResourceUpdate" } ] }, "MachineUpdateProperties": { "type": "object", "description": "Describes the ARM updatable properties of a hybrid machine.", "properties": { "locationData": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/locationData", "description": "Metadata pertaining to the geographic location of the resource." }, "osProfile": { "$ref": "#/definitions/OSProfile", "description": "Specifies the operating system settings for the hybrid machine." }, "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", "format": "arm-id", "description": "The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any." }, "privateLinkScopeResourceId": { "type": "string", "format": "arm-id", "description": "The resource id of the private link scope this machine is assigned to, if any." }, "identityKeyStore": { "type": "string", "description": "Identity key store type of the machine" }, "tpmEkCertificate": { "type": "string", "description": "Endorsement Key Certificate of the Trusted Platform Module (TPM) that the client provides to be used during initial resource onboarding." }, "clientPublicKey": { "type": "string", "description": "Public Key that the client provides to be used during initial resource onboarding" } } }, "NetworkInterface": { "type": "object", "description": "Describes a network interface.", "properties": { "macAddress": { "type": "string", "description": "Represents MAC address of the network interface." }, "id": { "type": "string", "description": "Represents the ID of the network interface." }, "name": { "type": "string", "description": "Represents the name of the network interface." }, "ipAddresses": { "type": "array", "description": "The list of IP addresses in this interface.", "items": { "$ref": "#/definitions/IpAddress" }, "readOnly": true, "x-ms-identifiers": [] } } }, "NetworkProfile": { "type": "object", "description": "Describes the network information on this machine.", "properties": { "networkInterfaces": { "type": "array", "description": "The list of network interfaces.", "items": { "$ref": "#/definitions/NetworkInterface" }, "readOnly": true, "x-ms-identifiers": [] } } }, "NetworkSecurityPerimeter": { "type": "object", "description": "Properties that define a Network Security Perimeter resource.", "properties": { "id": { "type": "string", "description": "Azure resource Id", "readOnly": true }, "perimeterGuid": { "type": "string", "description": "Guid of the Network Security Perimeter", "readOnly": true }, "location": { "type": "string", "description": "Regional location of the perimeter", "readOnly": true } } }, "NetworkSecurityPerimeterConfiguration": { "type": "object", "description": "Properties that define a Network Security Perimeter resource.", "properties": { "properties": { "$ref": "#/definitions/NetworkSecurityPerimeterConfigurationProperties", "description": "Properties that define a Network Security Perimeter resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "NetworkSecurityPerimeterConfigurationListResult": { "type": "object", "description": "The response of a NetworkSecurityPerimeterConfiguration list operation.", "properties": { "value": { "type": "array", "description": "The NetworkSecurityPerimeterConfiguration items on this page", "items": { "$ref": "#/definitions/NetworkSecurityPerimeterConfiguration" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "NetworkSecurityPerimeterConfigurationProperties": { "type": "object", "description": "Properties that define a Network Security Perimeter resource.", "properties": { "provisioningState": { "type": "string", "description": "Current state of this NetworkSecurityPerimeter: 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 }, "provisioningIssues": { "type": "array", "description": "Provisioning issues.", "items": { "$ref": "#/definitions/ProvisioningIssue" }, "readOnly": true, "x-ms-identifiers": [] }, "networkSecurityPerimeter": { "$ref": "#/definitions/NetworkSecurityPerimeter", "description": "The Network Security Perimeter associated with this configuration." }, "resourceAssociation": { "$ref": "#/definitions/ResourceAssociation", "description": "The Resource Association." }, "profile": { "$ref": "#/definitions/NetworkSecurityPerimeterProfile", "description": "Network Security Perimeter profile" } } }, "NetworkSecurityPerimeterConfigurationReconcileResult": { "type": "object", "description": "Result of network security perimeter configurations.", "properties": { "location": { "type": "string", "description": "The URL of the resource used to check the status of the asynchronous operation.", "readOnly": true } } }, "NetworkSecurityPerimeterProfile": { "type": "object", "description": "Network Security Perimeter profile", "properties": { "name": { "type": "string", "description": "Name of the resource", "readOnly": true }, "accessRulesVersion": { "type": "integer", "format": "int32", "description": "Access rules version number", "readOnly": true }, "accessRules": { "type": "array", "description": "Collection of access rules for the profile", "items": { "$ref": "#/definitions/AccessRule" }, "readOnly": true, "x-ms-identifiers": [] }, "diagnosticSettingsVersion": { "type": "integer", "format": "int32", "description": "Diagnostic settings version number", "readOnly": true }, "enabledLogCategories": { "type": "array", "description": "Collection of enabled log categories for the profile", "items": { "type": "string" }, "readOnly": true } } }, "OSProfile": { "type": "object", "description": "Specifies the operating system settings for the hybrid machine.", "properties": { "computerName": { "type": "string", "description": "Specifies the host OS name of the hybrid machine.", "readOnly": true }, "windowsConfiguration": { "$ref": "#/definitions/OSProfileWindowsConfiguration", "description": "Specifies the windows configuration for update management." }, "linuxConfiguration": { "$ref": "#/definitions/OSProfileLinuxConfiguration", "description": "Specifies the linux configuration for update management." } } }, "OSProfileLinuxConfiguration": { "type": "object", "description": "Specifies the linux configuration for update management.", "properties": { "patchSettings": { "$ref": "#/definitions/PatchSettings", "description": "Specifies the patch settings.", "x-ms-client-flatten": true } } }, "OSProfileWindowsConfiguration": { "type": "object", "description": "Specifies the windows configuration for update management.", "properties": { "patchSettings": { "$ref": "#/definitions/PatchSettings", "description": "Specifies the patch settings.", "x-ms-client-flatten": true } } }, "OperationListResult": { "type": "object", "description": "The List of Operations.", "properties": { "value": { "type": "array", "description": "The list of operations.", "items": { "$ref": "#/definitions/OperationValue" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The URL to get the next set of results.", "readOnly": true } } }, "OperationValue": { "type": "object", "description": "Describes the properties of a Compute Operation value.", "properties": { "origin": { "type": "string", "description": "The origin of the compute operation.", "readOnly": true }, "name": { "type": "string", "description": "The name of the compute operation.", "readOnly": true }, "display": { "$ref": "#/definitions/OperationValueDisplay", "description": "Display properties" }, "isDataAction": { "type": "boolean", "description": "This property indicates if the operation is an action or a data action", "readOnly": true } } }, "OperationValueDisplay": { "type": "object", "description": "Describes the properties of a Hybrid Compute Operation Value Display.", "properties": { "operation": { "type": "string", "description": "The display name of the compute operation.", "readOnly": true }, "resource": { "type": "string", "description": "The display name of the resource the operation applies to.", "readOnly": true }, "description": { "type": "string", "description": "The description of the operation.", "readOnly": true }, "provider": { "type": "string", "description": "The resource provider for the operation.", "readOnly": true } } }, "OsType": { "type": "string", "description": "The operating system type of the machine.", "enum": [ "Windows", "Linux" ], "x-ms-enum": { "name": "OsType", "modelAsString": true, "values": [ { "name": "Windows", "value": "Windows", "description": "Windows" }, { "name": "Linux", "value": "Linux", "description": "Linux" } ] } }, "PatchModeTypes": { "type": "string", "description": "Specifies the patch mode.", "enum": [ "ImageDefault", "AutomaticByPlatform", "AutomaticByOS", "Manual" ], "x-ms-enum": { "name": "PatchModeTypes", "modelAsString": true, "values": [ { "name": "ImageDefault", "value": "ImageDefault", "description": "ImageDefault" }, { "name": "AutomaticByPlatform", "value": "AutomaticByPlatform", "description": "AutomaticByPlatform" }, { "name": "AutomaticByOS", "value": "AutomaticByOS", "description": "AutomaticByOS" }, { "name": "Manual", "value": "Manual", "description": "Manual" } ] } }, "PatchOperationStartedBy": { "type": "string", "description": "Indicates if operation was triggered by user or by platform.", "enum": [ "User", "Platform" ], "x-ms-enum": { "name": "PatchOperationStartedBy", "modelAsString": true, "values": [ { "name": "User", "value": "User", "description": "User" }, { "name": "Platform", "value": "Platform", "description": "Platform" } ] } }, "PatchOperationStatus": { "type": "string", "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, "values": [ { "name": "Unknown", "value": "Unknown", "description": "Unknown" }, { "name": "InProgress", "value": "InProgress", "description": "InProgress" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "CompletedWithWarnings", "value": "CompletedWithWarnings", "description": "CompletedWithWarnings" } ] } }, "PatchServiceUsed": { "type": "string", "description": "Specifies the patch service used for the operation.", "enum": [ "Unknown", "WU", "WU_WSUS", "YUM", "APT", "Zypper" ], "x-ms-enum": { "name": "PatchServiceUsed", "modelAsString": true, "values": [ { "name": "Unknown", "value": "Unknown", "description": "Unknown" }, { "name": "WU", "value": "WU", "description": "WU" }, { "name": "WU_WSUS", "value": "WU_WSUS", "description": "WU_WSUS" }, { "name": "YUM", "value": "YUM", "description": "YUM" }, { "name": "APT", "value": "APT", "description": "APT" }, { "name": "Zypper", "value": "Zypper", "description": "Zypper" } ] } }, "PatchSettings": { "type": "object", "description": "Specifies the patch settings.", "properties": { "assessmentMode": { "$ref": "#/definitions/AssessmentModeTypes", "description": "Specifies the assessment mode." }, "patchMode": { "$ref": "#/definitions/PatchModeTypes", "description": "Specifies the patch mode." }, "enableHotpatching": { "type": "boolean", "description": "Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot." }, "status": { "$ref": "#/definitions/PatchSettingsStatus", "description": "Status of the hotpatch capability enrollment or disenrollment.", "readOnly": true } } }, "PatchSettingsStatus": { "type": "object", "description": "Status of the hotpatch capability enrollment or disenrollment.", "properties": { "hotpatchEnablementStatus": { "$ref": "#/definitions/HotpatchEnablementStatus", "description": "Indicates the current status of the hotpatch being enabled or disabled." }, "error": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "The errors that were encountered during the hotpatch capability enrollment or disenrollment.", "readOnly": true } } }, "PrivateEndpointConnection": { "type": "object", "description": "A private endpoint connection", "properties": { "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "description": "Resource properties." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "PrivateEndpointConnectionDataModel": { "type": "object", "description": "The Data Model for a Private Endpoint Connection associated with a Private Link Scope", "properties": { "id": { "type": "string", "description": "The ARM Resource Id of the Private Endpoint.", "readOnly": true }, "name": { "type": "string", "description": "The Name of the Private Endpoint.", "readOnly": true }, "type": { "type": "string", "description": "Azure resource type", "readOnly": true }, "properties": { "$ref": "#/definitions/PrivateEndpointConnectionProperties", "description": "The Private Endpoint Connection properties." } } }, "PrivateEndpointConnectionListResult": { "type": "object", "description": "The response of a PrivateEndpointConnection list operation.", "properties": { "value": { "type": "array", "description": "The PrivateEndpointConnection items on this page", "items": { "$ref": "#/definitions/PrivateEndpointConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "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": { "type": "string", "description": "State of the private endpoint connection.", "readOnly": true }, "groupIds": { "type": "array", "description": "List of group IDs.", "items": { "type": "string" }, "readOnly": true } } }, "PrivateEndpointProperty": { "type": "object", "description": "Private endpoint which the connection belongs to.", "properties": { "id": { "type": "string", "description": "Resource id of the private endpoint." } } }, "PrivateLinkResource": { "type": "object", "description": "A private link resource", "properties": { "properties": { "$ref": "#/definitions/PrivateLinkResourceProperties", "description": "Resource properties." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "PrivateLinkResourceListResult": { "type": "object", "description": "The response of a PrivateLinkResource list operation.", "properties": { "value": { "type": "array", "description": "The PrivateLinkResource items on this page", "items": { "$ref": "#/definitions/PrivateLinkResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PrivateLinkResourceProperties": { "type": "object", "description": "Properties of a private link resource.", "properties": { "groupId": { "type": "string", "description": "The private link resource group id.", "readOnly": true }, "requiredMembers": { "type": "array", "description": "The private link resource required member names.", "items": { "type": "string" }, "readOnly": true }, "requiredZoneNames": { "type": "array", "description": "Required DNS zone names of the the private link resource.", "items": { "type": "string" }, "readOnly": true } } }, "PrivateLinkScopeValidationDetails": { "type": "object", "properties": { "id": { "type": "string", "description": "Azure resource Id", "readOnly": true }, "publicNetworkAccess": { "type": "string", "description": "Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.", "default": "Disabled", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "PublicNetworkAccessType", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Allows Azure Arc agents to communicate with Azure Arc services over both public (internet) and private endpoints." }, { "name": "Disabled", "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." } ] } }, "connectionDetails": { "type": "array", "description": "List of Private Endpoint Connection details.", "items": { "$ref": "#/definitions/ConnectionDetail" } } } }, "PrivateLinkServiceConnectionStateProperty": { "type": "object", "description": "State of the private endpoint connection.", "properties": { "status": { "type": "string", "description": "The private link service connection status." }, "description": { "type": "string", "description": "The private link service connection description." }, "actionsRequired": { "type": "string", "description": "The actions required for private link service connection.", "readOnly": true } }, "required": [ "status", "description" ] }, "Processor": { "type": "object", "description": "Describes the firmware of the machine", "properties": { "name": { "type": "string", "description": "The name of the processor.", "readOnly": true }, "numberOfCores": { "type": "integer", "format": "int32", "description": "The total number of physical cores on the processor.", "readOnly": true } } }, "ProductFeature": { "type": "object", "description": "Product Feature", "properties": { "name": { "type": "string", "description": "Product feature name." }, "subscriptionStatus": { "$ref": "#/definitions/LicenseProfileSubscriptionStatus", "description": "Indicates the current status of the product features." }, "enrollmentDate": { "type": "string", "format": "date-time", "description": "The timestamp in UTC when the user enrolls the feature.", "readOnly": true }, "billingStartDate": { "type": "string", "format": "date-time", "description": "The timestamp in UTC when the billing starts.", "readOnly": true }, "disenrollmentDate": { "type": "string", "format": "date-time", "description": "The timestamp in UTC when the user disenrolled the feature.", "readOnly": true }, "billingEndDate": { "type": "string", "format": "date-time", "description": "The timestamp in UTC when the billing ends.", "readOnly": true }, "error": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", "description": "The errors that were encountered during the feature enrollment or disenrollment.", "readOnly": true } } }, "ProductFeatureUpdate": { "type": "object", "description": "Product Feature", "properties": { "name": { "type": "string", "description": "Product feature name." }, "subscriptionStatus": { "$ref": "#/definitions/LicenseProfileSubscriptionStatusUpdate", "description": "Indicates the new status of the product feature." } } }, "ProductProfileUpdateProperties": { "type": "object", "description": "Describes the Update properties of a Product Profile.", "properties": { "subscriptionStatus": { "$ref": "#/definitions/LicenseProfileSubscriptionStatusUpdate", "description": "Indicates the subscription status of the product." }, "productType": { "$ref": "#/definitions/LicenseProfileProductType", "description": "Indicates the product type of the license." }, "productFeatures": { "type": "array", "description": "The list of product feature updates.", "items": { "$ref": "#/definitions/ProductFeatureUpdate" }, "x-ms-identifiers": [] } } }, "ProgramYear": { "type": "string", "description": "Describes the program year the volume license is for.", "enum": [ "Year 1", "Year 2", "Year 3" ], "x-ms-enum": { "name": "ProgramYear", "modelAsString": true, "values": [ { "name": "Year 1", "value": "Year 1", "description": "Year 1" }, { "name": "Year 2", "value": "Year 2", "description": "Year 2" }, { "name": "Year 3", "value": "Year 3", "description": "Year 3" } ] } }, "ProvisioningIssue": { "type": "object", "description": "Details on issues that occurred during provisioning.", "properties": { "name": { "type": "string", "description": "Name of the provisioning issue.", "readOnly": true }, "properties": { "$ref": "#/definitions/ProvisioningIssueProperties", "description": "Provisioning issue properties", "readOnly": true, "x-ms-client-flatten": true } } }, "ProvisioningIssueProperties": { "type": "object", "description": "Properties of a provisioning issue.", "properties": { "issueType": { "$ref": "#/definitions/ProvisioningIssueType", "description": "Issue type", "readOnly": true }, "severity": { "$ref": "#/definitions/ProvisioningIssueSeverity", "description": "Severity of the provisioning issue.", "readOnly": true }, "description": { "type": "string", "description": "Description of the provisioning issue.", "readOnly": true }, "suggestedResourceIds": { "type": "array", "description": "ARM Ids of the resources that can be associated to the same perimeter to remediate the issue", "items": { "type": "string" }, "readOnly": true }, "suggestedAccessRules": { "type": "array", "description": "Access rules that can be added to the perimeter to remediate the issue", "items": { "$ref": "#/definitions/AccessRule" }, "readOnly": true, "x-ms-identifiers": [] } } }, "ProvisioningIssueSeverity": { "type": "string", "description": "Severity of the provisioning issue.", "enum": [ "Warning", "Error" ], "x-ms-enum": { "name": "ProvisioningIssueSeverity", "modelAsString": true, "values": [ { "name": "Warning", "value": "Warning", "description": "Warnings can cause connectivity issues after provisioning succeeds." }, { "name": "Error", "value": "Error", "description": "Errors will cause association provisioning to fail." } ] } }, "ProvisioningIssueType": { "type": "string", "description": "Type of provisioning issue.", "enum": [ "MissingPerimeterConfiguration", "MissingIdentityConfiguration", "ConfigurationPropagationFailure", "Other" ], "x-ms-enum": { "name": "ProvisioningIssueType", "modelAsString": true, "values": [ { "name": "MissingPerimeterConfiguration", "value": "MissingPerimeterConfiguration", "description": "Perimeter configuration is missing." }, { "name": "MissingIdentityConfiguration", "value": "MissingIdentityConfiguration", "description": "Identity configuration is missing." }, { "name": "ConfigurationPropagationFailure", "value": "ConfigurationPropagationFailure", "description": "Configuration failed to propagate." }, { "name": "Other", "value": "Other", "description": "Other failure." } ] } }, "ProvisioningState": { "type": "string", "description": "The provisioning state, which only appears in the response.", "enum": [ "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Accepted", "Canceled", "Deleted" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Creating", "value": "Creating", "description": "Creating" }, { "name": "Updating", "value": "Updating", "description": "Updating" }, { "name": "Deleting", "value": "Deleting", "description": "Deleting" }, { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Accepted", "value": "Accepted", "description": "Accepted" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" }, { "name": "Deleted", "value": "Deleted", "description": "Deleted" } ] } }, "ResourceAssociation": { "type": "object", "description": "Properties that define a Resource Association.", "properties": { "name": { "type": "string", "description": "Name of the Resource Association", "readOnly": true }, "accessMode": { "$ref": "#/definitions/AccessMode", "description": "The access mode", "readOnly": true } } }, "ResourceUpdate": { "type": "object", "description": "The Update Resource model definition.", "properties": { "tags": { "type": "object", "description": "Resource tags", "additionalProperties": { "type": "string" } } } }, "RunCommandInputParameter": { "type": "object", "description": "Describes the properties of a run command parameter.", "properties": { "name": { "type": "string", "description": "The run command parameter name." }, "value": { "type": "string", "description": "The run command parameter value." } }, "required": [ "name", "value" ] }, "RunCommandManagedIdentity": { "type": "object", "description": "Contains clientId or objectId (use only one, not both) of a user-assigned managed identity that has access to storage blob used in Run Command. Use an empty RunCommandManagedIdentity object in case of system-assigned identity. Make sure the Azure storage blob exists in case of scriptUri, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment with scriptUri blob and 'Storage Blob Data Contributor' for Append blobs(outputBlobUri, errorBlobUri). In case of user assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.", "properties": { "clientId": { "type": "string", "description": "Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided." }, "objectId": { "type": "string", "description": "Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided." } } }, "ServiceExtension": { "type": "object", "description": "Enable private link validation for an Azure Arc Extension", "properties": { "serviceExtensionType": { "$ref": "#/definitions/ServiceExtensionType", "description": "The name of the Azure Arc Extension." }, "serviceExtensionPublicNetworkAccess": { "$ref": "#/definitions/ServiceExtensionPublicNetworkAccess", "description": "The network access policy to determine if the specified Azure Arc Extension can use public Azure Arc Extension service endpoints." } } }, "ServiceExtensionPublicNetworkAccess": { "type": "string", "description": "The network access policy to determine if the specified Azure Arc Extension can use public Azure Arc Extension service endpoints.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "ServiceExtensionPublicNetworkAccess", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Allows Azure Arc Extension agents to communicate with Azure Arc services over both public (internet) and private endpoints." }, { "name": "Disabled", "value": "Disabled", "description": "Does not allow Azure Arc Extension agents to communicate with Azure Arc services over public (internet) endpoints. The agents must use the private link." } ] } }, "ServiceExtensionType": { "type": "string", "x-nullable": false }, "ServiceStatus": { "type": "object", "description": "Describes the status and behavior of a service.", "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." } } }, "ServiceStatuses": { "type": "object", "description": "Reports the state and behavior of dependent services.", "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." } } }, "Settings": { "type": "object", "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", "properties": { "properties": { "$ref": "#/definitions/SettingsProperties", "description": "Settings properties", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "SettingsGatewayProperties": { "type": "object", "description": "Settings Gateway properties", "properties": { "gatewayResourceId": { "type": "string", "format": "arm-id", "description": "Associated Gateway Resource Id", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.HybridCompute/gateways" } ] } } } }, "SettingsProperties": { "type": "object", "description": "Settings properties", "properties": { "tenantId": { "type": "string", "description": "Azure resource tenant Id", "readOnly": true }, "gatewayProperties": { "$ref": "#/definitions/SettingsGatewayProperties", "description": "Settings Gateway properties", "x-ms-client-flatten": true } } }, "SetupExtensionRequest": { "type": "object", "properties": { "extensions": { "type": "array", "description": "The list of extensions", "items": { "$ref": "#/definitions/MachineExtensionProperties" } } } }, "StatusLevelTypes": { "type": "string", "description": "The level code.", "enum": [ "Info", "Warning", "Error" ], "x-ms-enum": { "name": "StatusLevelTypes", "modelAsString": true, "values": [ { "name": "Info", "value": "Info", "description": "Info" }, { "name": "Warning", "value": "Warning", "description": "Warning" }, { "name": "Error", "value": "Error", "description": "Error" } ] } }, "StatusTypes": { "type": "string", "description": "The status of the hybrid machine agent.", "enum": [ "Connected", "Disconnected", "Error", "AwaitingConnection" ], "x-ms-enum": { "name": "StatusTypes", "modelAsString": true, "values": [ { "name": "Connected", "value": "Connected", "description": "Connected" }, { "name": "Disconnected", "value": "Disconnected", "description": "Disconnected" }, { "name": "Error", "value": "Error", "description": "Error" }, { "name": "AwaitingConnection", "value": "AwaitingConnection", "description": "AwaitingConnection" } ] } }, "StorageProfile": { "type": "object", "description": "Describes the storage configuration of the machine", "properties": { "disks": { "type": "array", "description": "The disks on the machine.", "items": { "$ref": "#/definitions/Disk" }, "readOnly": true } } }, "Subnet": { "type": "object", "description": "Describes the subnet.", "properties": { "addressPrefix": { "type": "string", "description": "Represents address prefix." } } }, "TagsResource": { "type": "object", "description": "A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance.", "properties": { "tags": { "type": "object", "description": "Resource tags", "additionalProperties": { "type": "string" } } } }, "VMGuestPatchClassification_Linux": { "type": "string", "enum": [ "Critical", "Security", "Other" ], "x-ms-enum": { "name": "VMGuestPatchClassification_Linux", "modelAsString": true, "values": [ { "name": "Critical", "value": "Critical", "description": "Critical" }, { "name": "Security", "value": "Security", "description": "Security" }, { "name": "Other", "value": "Other", "description": "Other" } ] } }, "VMGuestPatchClassification_Windows": { "type": "string", "enum": [ "Critical", "Security", "UpdateRollUp", "FeaturePack", "ServicePack", "Definition", "Tools", "Updates" ], "x-ms-enum": { "name": "VMGuestPatchClassification_Windows", "modelAsString": true, "values": [ { "name": "Critical", "value": "Critical", "description": "Critical" }, { "name": "Security", "value": "Security", "description": "Security" }, { "name": "UpdateRollUp", "value": "UpdateRollUp", "description": "UpdateRollUp" }, { "name": "FeaturePack", "value": "FeaturePack", "description": "FeaturePack" }, { "name": "ServicePack", "value": "ServicePack", "description": "ServicePack" }, { "name": "Definition", "value": "Definition", "description": "Definition" }, { "name": "Tools", "value": "Tools", "description": "Tools" }, { "name": "Updates", "value": "Updates", "description": "Updates" } ] } }, "VMGuestPatchRebootSetting": { "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, "values": [ { "name": "IfRequired", "value": "IfRequired", "description": "IfRequired" }, { "name": "Never", "value": "Never", "description": "Never" }, { "name": "Always", "value": "Always", "description": "Always" } ] } }, "VMGuestPatchRebootStatus": { "type": "string", "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, "values": [ { "name": "Unknown", "value": "Unknown", "description": "Unknown" }, { "name": "NotNeeded", "value": "NotNeeded", "description": "NotNeeded" }, { "name": "Required", "value": "Required", "description": "Required" }, { "name": "Started", "value": "Started", "description": "Started" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Completed", "value": "Completed", "description": "Completed" } ] } }, "VmApplication": { "type": "object", "description": "A VM application installed on a hybrid machine.", "properties": { "properties": { "$ref": "#/definitions/VmApplicationProperties", "description": "The VM application properties." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "VmApplicationInstanceView": { "type": "object", "description": "The instance view of a VM application.", "properties": { "name": { "type": "string", "description": "The application name." }, "version": { "type": "string", "description": "The application version." }, "result": { "type": "string", "description": "The current installation result." }, "actionsPerformed": { "type": "array", "description": "The recent actions performed for the application.", "items": { "$ref": "#/definitions/VmApplicationInstanceViewAction" }, "x-ms-identifiers": [] } } }, "VmApplicationInstanceViewAction": { "type": "object", "description": "An action recently performed for a VM application.", "properties": { "operation": { "type": "string", "description": "The operation that was performed." }, "result": { "type": "string", "description": "The result of the operation." } } }, "VmApplicationProperties": { "type": "object", "description": "The properties of a VM application. Exactly one gallery application reference must be specified when creating or replacing the resource.", "properties": { "order": { "type": "integer", "format": "int32", "description": "The order in which the application is installed." }, "packageReferenceId": { "type": "string", "format": "arm-id", "description": "The resource ID of the gallery application version. The version name can be `latest` or a specific version. This property is mutually exclusive with sharedGalleryApplicationId and communityGalleryApplicationId.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Compute/galleries/applications/versions" } ] } }, "sharedGalleryApplicationId": { "type": "string", "description": "The identifier of a direct shared gallery application version. Use `/sharedGalleries/{sharedGalleryUniqueName}/applications/{applicationName}/versions/{versionName}`, where the version name can be `latest` or a specific version. This property is mutually exclusive with packageReferenceId and communityGalleryApplicationId." }, "communityGalleryApplicationId": { "type": "string", "description": "The identifier of a community gallery application version. Use `/communityGalleries/{communityGalleryPublicName}/applications/{applicationName}/versions/{versionName}`, where the version name can be `latest` or a specific version. This property is mutually exclusive with packageReferenceId and sharedGalleryApplicationId." }, "configurationReference": { "type": "string", "format": "uri", "description": "The URI of configuration data that replaces the package's default configuration." }, "treatFailureAsDeploymentFailure": { "type": "boolean", "description": "Indicates whether an application operation failure causes the deployment to fail." }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The provisioning state of the VM application.", "readOnly": true }, "instanceView": { "$ref": "#/definitions/VmApplicationInstanceView", "description": "The instance view of the VM application.", "readOnly": true } } }, "VmApplicationUpdate": { "type": "object", "description": "The update request for a VM application.", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } }, "properties": { "$ref": "#/definitions/VmApplicationUpdateProperties", "description": "The resource-specific properties for this resource." } } }, "VmApplicationUpdateProperties": { "type": "object", "description": "The updatable properties of the VmApplication.", "properties": { "order": { "type": "integer", "format": "int32", "description": "The order in which the application is installed." }, "packageReferenceId": { "type": "string", "format": "arm-id", "description": "The resource ID of the gallery application version. The version name can be `latest` or a specific version. This property is mutually exclusive with sharedGalleryApplicationId and communityGalleryApplicationId.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Compute/galleries/applications/versions" } ] } }, "sharedGalleryApplicationId": { "type": "string", "description": "The identifier of a direct shared gallery application version. Use `/sharedGalleries/{sharedGalleryUniqueName}/applications/{applicationName}/versions/{versionName}`, where the version name can be `latest` or a specific version. This property is mutually exclusive with packageReferenceId and communityGalleryApplicationId." }, "communityGalleryApplicationId": { "type": "string", "description": "The identifier of a community gallery application version. Use `/communityGalleries/{communityGalleryPublicName}/applications/{applicationName}/versions/{versionName}`, where the version name can be `latest` or a specific version. This property is mutually exclusive with packageReferenceId and sharedGalleryApplicationId." }, "configurationReference": { "type": "string", "format": "uri", "description": "The URI of configuration data that replaces the package's default configuration." }, "treatFailureAsDeploymentFailure": { "type": "boolean", "description": "Indicates whether an application operation failure causes the deployment to fail." } } }, "VmApplicationsListResult": { "type": "object", "description": "A page of VM applications.", "properties": { "value": { "type": "array", "description": "The VmApplication items on this page", "items": { "$ref": "#/definitions/VmApplication" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "VolumeLicenseDetails": { "type": "object", "properties": { "programYear": { "$ref": "#/definitions/ProgramYear", "description": "Describes the program year the volume license is for." }, "invoiceId": { "type": "string", "description": "The invoice id for the volume license." } } }, "WindowsParameters": { "type": "object", "description": "Input for InstallPatches on a Windows VM, as directly received by the API", "properties": { "classificationsToInclude": { "type": "array", "description": "The update classifications to select when installing patches for Windows.", "items": { "$ref": "#/definitions/VMGuestPatchClassification_Windows" } }, "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." }, "patchNameMasksToInclude": { "type": "array", "description": "This is used to include patches that match the given patch name masks. Alphanumeric strings and wildcard expressions consisting of * and ? are only supported as input values in the list. Null, empty and only whitespaces strings as inputs values are not supported.", "items": { "type": "string" } }, "patchNameMasksToExclude": { "type": "array", "description": "This is used to exclude patches that match the given patch name masks. Alphanumeric strings and wildcard expressions consisting of * and ? are only supported as input values in the list. Null, empty and only whitespaces strings as inputs values are not supported.", "items": { "type": "string" } } } } }, "parameters": {} }