{ "swagger": "2.0", "info": { "version": "2022-05-04", "title": "Automanage" }, "host": "management.azure.com", "schemes": [ "https" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/providers/Microsoft.Automanage/bestPractices/{bestPracticeName}": { "get": { "tags": [ "BestPractices" ], "operationId": "BestPractices_Get", "description": "Get information about a Automanage best practice", "x-ms-examples": { "Get an Automanage best practice ": { "$ref": "./examples/getBestPractice.json" } }, "parameters": [ { "name": "bestPracticeName", "in": "path", "required": true, "type": "string", "description": "The Automanage best practice name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The Automanage best practice was returned successfully.", "schema": { "$ref": "#/definitions/BestPractice" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/providers/Microsoft.Automanage/bestPractices": { "get": { "tags": [ "BestPractices" ], "operationId": "BestPractices_ListByTenant", "description": "Retrieve a list of Automanage best practices", "x-ms-examples": { "List Automanage bestPractices ": { "$ref": "./examples/listBestPracticesByTenant.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. List of Automanage bestPractices configuration profile.", "schema": { "$ref": "#/definitions/BestPracticeList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/providers/Microsoft.Automanage/bestPractices/{bestPracticeName}/versions/{versionName}": { "get": { "tags": [ "BestPracticesVersions" ], "operationId": "BestPracticesVersions_Get", "description": "Get information about a Automanage best practice version", "x-ms-examples": { "Get an Automanage best practice version ": { "$ref": "./examples/getBestPracticeVersion.json" } }, "parameters": [ { "name": "bestPracticeName", "in": "path", "required": true, "type": "string", "description": "The Automanage best practice name." }, { "name": "versionName", "in": "path", "required": true, "type": "string", "description": "The Automanage best practice version name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The Automanage best practice version was returned successfully.", "schema": { "$ref": "#/definitions/BestPractice" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/providers/Microsoft.Automanage/bestPractices/{bestPracticeName}/versions": { "get": { "tags": [ "BestPracticesVersions" ], "operationId": "BestPracticesVersions_ListByTenant", "description": "Retrieve a list of Automanage best practices versions", "x-ms-examples": { "List Automanage best practices versions ": { "$ref": "./examples/listBestPracticesVersionsByTenant.json" } }, "parameters": [ { "name": "bestPracticeName", "in": "path", "required": true, "type": "string", "description": "The Automanage best practice name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. List of Automanage bestPractices configuration profile versions.", "schema": { "$ref": "#/definitions/BestPracticeList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automanage/configurationProfiles/{configurationProfileName}": { "put": { "tags": [ "ConfigurationProfiles" ], "operationId": "ConfigurationProfiles_CreateOrUpdate", "description": "Creates a configuration profile", "x-ms-examples": { "Create or update configuration profile": { "$ref": "./examples/createOrUpdateConfigurationProfile.json" } }, "parameters": [ { "name": "configurationProfileName", "in": "path", "required": true, "type": "string", "description": "Name of the configuration profile." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationProfile" }, "description": "Parameters supplied to create or update configuration profile." } ], "responses": { "200": { "description": "OK. The configuration profile was updated successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfile" } }, "201": { "description": "Created. The configuration profile was created successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfile" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": false, "produces": [ "application/json" ], "consumes": [ "application/json" ] }, "get": { "tags": [ "ConfigurationProfiles" ], "operationId": "ConfigurationProfiles_Get", "description": "Get information about a configuration profile", "x-ms-examples": { "Get a configuration profile": { "$ref": "./examples/getConfigurationProfile.json" } }, "parameters": [ { "name": "configurationProfileName", "in": "path", "required": true, "type": "string", "description": "The configuration profile name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The configuration profile was returned successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfile" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "produces": [ "application/json" ], "consumes": [ "application/json" ] }, "delete": { "tags": [ "ConfigurationProfiles" ], "operationId": "ConfigurationProfiles_Delete", "description": "Delete a configuration profile", "x-ms-examples": { "Delete a configuration profile": { "$ref": "./examples/deleteConfigurationProfile.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "configurationProfileName", "in": "path", "required": true, "type": "string", "description": "Name of the configuration profile" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": false, "produces": [ "application/json" ], "consumes": [ "application/json" ] }, "patch": { "tags": [ "ConfigurationProfiles" ], "operationId": "ConfigurationProfiles_Update", "description": "Updates a configuration profile", "x-ms-examples": { "Update configuration profile": { "$ref": "./examples/updateConfigurationProfile.json" } }, "parameters": [ { "name": "configurationProfileName", "in": "path", "required": true, "type": "string", "description": "Name of the configuration profile." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationProfileUpdate" }, "description": "Parameters supplied to update configuration profile." } ], "responses": { "200": { "description": "OK. The configuration profile was updated successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfile" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": false, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automanage/configurationProfiles": { "get": { "tags": [ "ConfigurationProfiles" ], "operationId": "ConfigurationProfiles_ListByResourceGroup", "description": "Retrieve a list of configuration profile within a given resource group", "x-ms-examples": { "List configuration profiles by resource group": { "$ref": "./examples/listConfigurationProfilesByResourceGroup.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. List of configuration profiles.", "schema": { "$ref": "#/definitions/ConfigurationProfileList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Automanage/configurationProfiles": { "get": { "tags": [ "ConfigurationProfiles" ], "operationId": "ConfigurationProfiles_ListBySubscription", "description": "Retrieve a list of configuration profile within a subscription", "x-ms-examples": { "List configuration profiles by subscription": { "$ref": "./examples/listConfigurationProfilesBySubscription.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. List of configuration profiles.", "schema": { "$ref": "#/definitions/ConfigurationProfileList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automanage/configurationProfiles/{configurationProfileName}/versions/{versionName}": { "put": { "tags": [ "ConfigurationProfilesVersions" ], "operationId": "ConfigurationProfilesVersions_CreateOrUpdate", "description": "Creates a configuration profile version", "x-ms-examples": { "Create or update configuration profile version": { "$ref": "./examples/createOrUpdateConfigurationProfileVersion.json" } }, "parameters": [ { "name": "configurationProfileName", "in": "path", "required": true, "type": "string", "description": "Name of the configuration profile." }, { "name": "versionName", "in": "path", "required": true, "type": "string", "description": "The configuration profile version name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationProfile" }, "description": "Parameters supplied to create or update configuration profile." } ], "responses": { "200": { "description": "OK. The configuration profile was updated successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfile" } }, "201": { "description": "Created. The configuration profile was created successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfile" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": false, "produces": [ "application/json" ], "consumes": [ "application/json" ] }, "get": { "tags": [ "ConfigurationProfilesVersions" ], "operationId": "ConfigurationProfilesVersions_Get", "description": "Get information about a configuration profile version", "x-ms-examples": { "Get a configuration profile version": { "$ref": "./examples/getConfigurationProfileVersion.json" } }, "parameters": [ { "name": "configurationProfileName", "in": "path", "required": true, "type": "string", "description": "The configuration profile name." }, { "name": "versionName", "in": "path", "required": true, "type": "string", "description": "The configuration profile version name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The configuration profile was returned successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfile" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "produces": [ "application/json" ], "consumes": [ "application/json" ] }, "delete": { "tags": [ "ConfigurationProfilesVersions" ], "operationId": "ConfigurationProfilesVersions_Delete", "description": "Delete a configuration profile version", "x-ms-examples": { "Delete a configuration profile version": { "$ref": "./examples/deleteConfigurationProfileVersion.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "configurationProfileName", "in": "path", "required": true, "type": "string", "description": "Name of the configuration profile" }, { "name": "versionName", "in": "path", "required": true, "type": "string", "description": "The configuration profile version name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": false, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automanage/configurationProfiles/{configurationProfileName}/versions": { "get": { "tags": [ "ConfigurationProfilesVersions" ], "operationId": "ConfigurationProfilesVersions_ListChildResources", "description": "Retrieve a list of configuration profile version for a configuration profile ", "x-ms-examples": { "List configuration profile versions by configuration profile": { "$ref": "./examples/listConfigurationProfileVersions.json" } }, "parameters": [ { "name": "configurationProfileName", "in": "path", "required": true, "type": "string", "description": "Name of the configuration profile." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. List of configuration profiles.", "schema": { "$ref": "#/definitions/ConfigurationProfileList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Automanage/configurationProfileAssignments/{configurationProfileAssignmentName}": { "put": { "tags": [ "ConfigurationProfileAssignments" ], "operationId": "ConfigurationProfileAssignments_CreateOrUpdate", "description": "Creates an association between a VM and Automanage configuration profile", "x-ms-examples": { "Create or update configuration profile assignment": { "$ref": "./examples/createOrUpdateConfigurationProfileAssignment.json" } }, "parameters": [ { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "Name of the configuration profile assignment. Only default is supported." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationProfileAssignment" }, "description": "Parameters supplied to the create or update configuration profile assignment." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VmNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The configuration profile assignment for the VM was updated successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignment" } }, "201": { "description": "Created. The Automanage configuration profile assignment for the VM was created successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignment" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": false, "produces": [ "application/json" ], "consumes": [ "application/json" ] }, "get": { "tags": [ "ConfigurationProfileAssignments" ], "operationId": "ConfigurationProfileAssignments_Get", "description": "Get information about a configuration profile assignment", "x-ms-examples": { "Get a configuration profile assignment": { "$ref": "./examples/getConfigurationProfileAssignment.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "The configuration profile assignment name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/VmNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The configuration profile assignment was returned successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignment" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "produces": [ "application/json" ], "consumes": [ "application/json" ] }, "delete": { "tags": [ "ConfigurationProfileAssignments" ], "operationId": "ConfigurationProfileAssignments_Delete", "description": "Delete a configuration profile assignment", "x-ms-examples": { "Delete an configuration profile assignment": { "$ref": "./examples/deleteConfigurationProfileAssignment.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "Name of the configuration profile assignment" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/VmNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": false, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Automanage/configurationProfileAssignments": { "get": { "tags": [ "ConfigurationProfileAssignments" ], "operationId": "ConfigurationProfileAssignments_ListByVirtualMachines", "description": "Get list of configuration profile assignments", "x-ms-examples": { "List configuration profile assignments by resourceGroup and virtual machine": { "$ref": "./examples/listConfigurationProfileAssignmentsByVirtualMachines.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/VmNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The list of configuration profile assignments were returned successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignmentList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automanage/configurationProfileAssignments": { "get": { "tags": [ "ConfigurationProfileAssignments" ], "operationId": "ConfigurationProfileAssignments_List", "description": "Get list of configuration profile assignments", "x-ms-examples": { "List configuration profile assignments by resourceGroup": { "$ref": "./examples/listConfigurationProfileAssignmentsByResourceGroup.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The list of configuration profile assignments were returned successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignmentList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Automanage/configurationProfileAssignments": { "get": { "tags": [ "ConfigurationProfileAssignments" ], "operationId": "ConfigurationProfileAssignments_ListBySubscription", "description": "Get list of configuration profile assignments under a given subscription", "x-ms-examples": { "List configuration profile assignments by subscription": { "$ref": "./examples/listConfigurationProfileAssignmentsBySubscription.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The list of configuration profile assignments were returned successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignmentList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/providers/Microsoft.Automanage/operations": { "get": { "tags": [ "Operations" ], "description": "Lists all of the available Automanage REST API operations.", "x-ms-examples": { "Lists all of the available Automanage REST API operations": { "$ref": "./examples/listOperations.json" } }, "operationId": "Operations_List", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Success. The response describes the list of operations.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Automanage/configurationProfileAssignments/{configurationProfileAssignmentName}/reports/{reportName}": { "get": { "tags": [ "reports" ], "operationId": "reports_Get", "description": "Get information about a report associated with a configuration profile assignment run", "x-ms-examples": { "Get a report for a configuration profile assignment": { "$ref": "./examples/getReport.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "The configuration profile assignment name." }, { "name": "reportName", "in": "path", "required": true, "type": "string", "description": "The report name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/VmNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The report was returned successfully.", "schema": { "$ref": "#/definitions/Report" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Automanage/configurationProfileAssignments/{configurationProfileAssignmentName}/reports": { "get": { "tags": [ "reports" ], "operationId": "reports_ListByConfigurationProfileAssignments", "description": "Retrieve a list of reports within a given configuration profile assignment", "x-ms-examples": { "List reports by configuration profiles assignment": { "$ref": "./examples/listReportsByconfigurationProfileAssignment.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "The configuration profile assignment name." }, { "$ref": "#/parameters/VmNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. List of reports.", "schema": { "$ref": "#/definitions/ReportList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Automanage/servicePrincipals": { "get": { "tags": [ "servicePrincipals" ], "operationId": "ServicePrincipals_ListBySubscription", "description": "Get the Automanage AAD first party Application Service Principal details for the subscription id.", "x-ms-examples": { "List service principal by subscription": { "$ref": "./examples/listServicePrincipalBySubscription.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Returns the Automanage ADD first party Application Service Principal details for the subscription.", "schema": { "$ref": "#/definitions/ServicePrincipalListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Automanage/servicePrincipals/default": { "get": { "tags": [ "servicePrincipals" ], "operationId": "ServicePrincipals_Get", "description": "Get the Automanage AAD first party Application Service Principal details for the subscription id.", "x-ms-examples": { "Get service principal": { "$ref": "./examples/getServicePrincipal.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Returns the Automanage ADD first party Application Service Principal details for the subscription.", "schema": { "$ref": "#/definitions/ServicePrincipal" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.Automanage/configurationProfileAssignments/{configurationProfileAssignmentName}": { "put": { "tags": [ "ConfigurationProfileHCRPAssignments" ], "operationId": "ConfigurationProfileHCRPAssignments_CreateOrUpdate", "description": "Creates an association between a ARC machine and Automanage configuration profile", "x-ms-examples": { "Create or update HCRP configuration profile assignment": { "$ref": "./examples/createOrUpdateConfigurationProfileHCRPAssignment.json" } }, "parameters": [ { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationProfileAssignment" }, "description": "Parameters supplied to the create or update configuration profile assignment." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/MachineNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "Name of the configuration profile assignment. Only default is supported." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The configuration profile assignment for the ARC machine was updated successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignment" } }, "201": { "description": "Created. The Automanage configuration profile assignment for the ARC machine was created successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignment" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": false, "produces": [ "application/json" ], "consumes": [ "application/json" ] }, "get": { "tags": [ "ConfigurationProfileHCRPAssignments" ], "operationId": "ConfigurationProfileHCRPAssignments_Get", "description": "Get information about a configuration profile assignment", "x-ms-examples": { "Get a HCRP configuration profile assignment": { "$ref": "./examples/getConfigurationProfileHCRPAssignment.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/MachineNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "The configuration profile assignment name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The configuration profile assignment was returned successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignment" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "produces": [ "application/json" ], "consumes": [ "application/json" ] }, "delete": { "tags": [ "ConfigurationProfileHCRPAssignments" ], "operationId": "ConfigurationProfileHCRPAssignments_Delete", "description": "Delete a configuration profile assignment", "x-ms-examples": { "Delete a HCRP configuration profile assignment": { "$ref": "./examples/deleteConfigurationProfileHCRPAssignment.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/MachineNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "Name of the configuration profile assignment" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "NoContent" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": false, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.Automanage/configurationProfileAssignments": { "get": { "tags": [ "ConfigurationProfileAssignments" ], "operationId": "ConfigurationProfileAssignments_ListByMachineName", "description": "Get list of configuration profile assignments", "x-ms-examples": { "List configuration profile assignments by resourceGroup and machine": { "$ref": "./examples/listConfigurationProfileAssignmentsByMachineName.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/MachineNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The list of configuration profile assignments were returned successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignmentList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.Automanage/configurationProfileAssignments/{configurationProfileAssignmentName}/reports/{reportName}": { "get": { "tags": [ "HCRPReports" ], "operationId": "HCRPReports_Get", "description": "Get information about a report associated with a configuration profile assignment run", "x-ms-examples": { "Get a report for a HCRP configuration profile assignment": { "$ref": "./examples/getHCRPReport.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/MachineNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "The configuration profile assignment name." }, { "name": "reportName", "in": "path", "required": true, "type": "string", "description": "The report name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The report was returned successfully.", "schema": { "$ref": "#/definitions/Report" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.Automanage/configurationProfileAssignments/{configurationProfileAssignmentName}/reports": { "get": { "tags": [ "HCRPReports" ], "operationId": "HCRPReports_ListByConfigurationProfileAssignments", "description": "Retrieve a list of reports within a given configuration profile assignment", "x-ms-examples": { "List reports by HCRP configuration profiles assignment": { "$ref": "./examples/listReportsByconfigurationProfileHCRPAssignment.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/MachineNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "The configuration profile assignment name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. List of reports.", "schema": { "$ref": "#/definitions/ReportList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHci/clusters/{clusterName}/providers/Microsoft.Automanage/configurationProfileAssignments/{configurationProfileAssignmentName}": { "put": { "tags": [ "ConfigurationProfileHCIAssignments" ], "operationId": "ConfigurationProfileHCIAssignments_CreateOrUpdate", "description": "Creates an association between a AzureStackHCI cluster and Automanage configuration profile", "x-ms-examples": { "Create or update a HCI configuration profile assignment": { "$ref": "./examples/createOrUpdateConfigurationProfileHCIAssignment.json" } }, "parameters": [ { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigurationProfileAssignment" }, "description": "Parameters supplied to the create or update configuration profile assignment." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "Name of the configuration profile assignment. Only default is supported." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The configuration profile assignment for the AzureStackHCI cluster was updated successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignment" } }, "201": { "description": "Created. The Automanage configuration profile assignment for the AzureStackHCI cluster was created successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignment" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": false, "produces": [ "application/json" ], "consumes": [ "application/json" ] }, "get": { "tags": [ "ConfigurationProfileHCIAssignments" ], "operationId": "ConfigurationProfileHCIAssignments_Get", "description": "Get information about a configuration profile assignment", "x-ms-examples": { "Get a HCI configuration profile assignment": { "$ref": "./examples/getConfigurationProfileHCIAssignment.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "The configuration profile assignment name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The configuration profile assignment was returned successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignment" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "produces": [ "application/json" ], "consumes": [ "application/json" ] }, "delete": { "tags": [ "ConfigurationProfileHCIAssignments" ], "operationId": "ConfigurationProfileHCIAssignments_Delete", "description": "Delete a configuration profile assignment", "x-ms-examples": { "Delete a HCI configuration profile assignment": { "$ref": "./examples/deleteConfigurationProfileHCIAssignment.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "Name of the configuration profile assignment" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "OK" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation": false, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHci/clusters/{clusterName}/providers/Microsoft.Automanage/configurationProfileAssignments": { "get": { "tags": [ "ConfigurationProfileAssignments" ], "operationId": "ConfigurationProfileAssignments_ListByClusterName", "description": "Get list of configuration profile assignments", "x-ms-examples": { "List configuration profile assignments by resourceGroup and cluster": { "$ref": "./examples/listConfigurationProfileAssignmentsByClusterName.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The list of configuration profile assignments were returned successfully.", "schema": { "$ref": "#/definitions/ConfigurationProfileAssignmentList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHci/clusters/{clusterName}/providers/Microsoft.Automanage/configurationProfileAssignments/{configurationProfileAssignmentName}/reports/{reportName}": { "get": { "tags": [ "HCIReports" ], "operationId": "HCIReports_Get", "description": "Get information about a report associated with a configuration profile assignment run", "x-ms-examples": { "Get a report for a HCI configuration profile assignment": { "$ref": "./examples/getHCIReport.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "The configuration profile assignment name." }, { "name": "reportName", "in": "path", "required": true, "type": "string", "description": "The report name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. The report was returned successfully.", "schema": { "$ref": "#/definitions/Report" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHci/clusters/{clusterName}/providers/Microsoft.Automanage/configurationProfileAssignments/{configurationProfileAssignmentName}/reports": { "get": { "tags": [ "HCIReports" ], "operationId": "HCIReports_ListByConfigurationProfileAssignments", "description": "Retrieve a list of reports within a given configuration profile assignment", "x-ms-examples": { "List reports by HCI configuration profiles assignment": { "$ref": "./examples/listReportsByconfigurationProfileHCIAssignment.json" } }, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ClusterNameParameter" }, { "name": "configurationProfileAssignmentName", "in": "path", "required": true, "type": "string", "description": "The configuration profile assignment name." }, { "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK. List of reports.", "schema": { "$ref": "#/definitions/ReportList" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null }, "produces": [ "application/json" ], "consumes": [ "application/json" ] } } }, "definitions": { "BestPracticeList": { "description": "The response of the list best practice operation.", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/BestPractice" }, "description": "Result of the list best practice operation." } } }, "ConfigurationProfileList": { "description": "The response of the list configuration profile operation.", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationProfile" }, "description": "Result of the list ConfigurationProfile operation." } } }, "BestPractice": { "description": "Definition of the Automanage best practice.", "type": "object", "x-ms-azure-resource": true, "properties": { "id": { "type": "string", "description": "The fully qualified ID for the best practice. For example, /providers/Microsoft.Automanage/bestPractices/azureBestPracticesProduction", "readOnly": true }, "type": { "type": "string", "description": "The type of the resource. For example, Microsoft.Automanage/bestPractices", "readOnly": true }, "name": { "type": "string", "description": "The name of the best practice. For example, azureBestPracticesProduction", "readOnly": true }, "properties": { "title": "Properties", "$ref": "#/definitions/ConfigurationProfileProperties", "description": "Properties of the best practice." }, "systemData": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", "readOnly": true, "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information." } } }, "ConfigurationProfile": { "description": "Definition of the configuration profile.", "type": "object", "properties": { "properties": { "$ref": "#/definitions/ConfigurationProfileProperties", "description": "Properties of the configuration profile." }, "systemData": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", "readOnly": true, "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" } ] }, "ConfigurationProfileProperties": { "description": "Automanage configuration profile properties.", "type": "object", "properties": { "configuration": { "title": "configuration", "$ref": "#/definitions/ConfigurationDictionary", "description": "configuration dictionary of the configuration profile." } } }, "ConfigurationDictionary": { "description": "The custom configuration for configuration profile. Name and value pairs that define the configuration details of the configuration profile.", "type": "object", "example": { "Antimalware/Enable": true } }, "ConfigurationProfileUpdate": { "description": "Definition of the configuration profile.", "type": "object", "properties": { "properties": { "$ref": "#/definitions/ConfigurationProfileProperties", "description": "Properties of the configuration profile." } }, "allOf": [ { "$ref": "#/definitions/UpdateResource" } ] }, "ConfigurationProfileAssignmentList": { "description": "The response of the list configuration profile assignment operation.", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationProfileAssignment" }, "description": "Result of the list configuration profile assignment operation." } } }, "ConfigurationProfileAssignment": { "description": "Configuration profile assignment is an association between a VM and automanage profile configuration.", "type": "object", "properties": { "properties": { "$ref": "#/definitions/ConfigurationProfileAssignmentProperties", "description": "Properties of the configuration profile assignment." }, "managedBy": { "readOnly": true, "description": "Azure resource id. Indicates if this resource is managed by another Azure resource.", "$ref": "#/definitions/ManagedBy" }, "systemData": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", "readOnly": true, "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ] }, "ConfigurationProfileAssignmentProperties": { "description": "Automanage configuration profile assignment properties.", "type": "object", "properties": { "configurationProfile": { "type": "string", "description": "The Automanage configurationProfile ARM Resource URI." }, "targetId": { "type": "string", "description": "The target VM resource URI", "readOnly": true }, "status": { "type": "string", "readOnly": true, "description": "The status of onboarding, which only appears in the response." } } }, "UpdateResource": { "description": "Represents an update resource", "type": "object", "properties": { "tags": { "description": "The tags of the resource.", "type": "object", "additionalProperties": { "type": "string" } } } }, "ReportList": { "description": "The response of the list report operation.", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/Report" }, "description": "Result of the list report operation." } } }, "Report": { "description": "Definition of the report.", "type": "object", "properties": { "properties": { "title": "Properties", "$ref": "#/definitions/AssignmentReportProperties", "description": "The properties for the report." }, "systemData": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", "readOnly": true, "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ] }, "AssignmentReportProperties": { "description": "Data related to the report detail.", "type": "object", "properties": { "startTime": { "type": "string", "description": "Start time of the configuration profile assignment processing." }, "endTime": { "type": "string", "description": "End time of the configuration profile assignment processing." }, "lastModifiedTime": { "type": "string", "readOnly": true, "description": "Last modified time of the configuration profile assignment processing." }, "duration": { "type": "string", "format": "duration", "readOnly": true, "description": "Duration of the configuration profile assignment processing." }, "type": { "type": "string", "readOnly": true, "description": "Type of the configuration profile assignment processing (Initial/Consistency)." }, "status": { "type": "string", "readOnly": true, "description": "The status of the configuration profile assignment." }, "configurationProfile": { "type": "string", "readOnly": true, "description": "The configurationProfile linked to the assignment." }, "resources": { "type": "array", "readOnly": true, "items": { "$ref": "#/definitions/ReportResource" }, "description": "List of resources processed by the configuration profile assignment." }, "error": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail", "readOnly": true, "description": "Error message, if any, returned by the configuration profile assignment processing." }, "reportFormatVersion": { "type": "string", "readOnly": true, "description": "Version of the report format" } } }, "ReportResource": { "description": "Details about the resource processed by the configuration profile assignment", "type": "object", "properties": { "name": { "type": "string", "readOnly": true, "description": "Name of the resource." }, "id": { "type": "string", "readOnly": true, "description": "ARM id of the resource." }, "type": { "type": "string", "readOnly": true, "description": "Type of the resource." }, "status": { "type": "string", "readOnly": true, "description": "Status of the resource." }, "error": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail", "readOnly": true, "description": "Error message, if any, returned when deploying the resource." } } }, "ServicePrincipalListResult": { "description": "The list of ServicePrincipals.", "type": "object", "properties": { "value": { "description": "The list of servicePrincipals.", "type": "array", "items": { "$ref": "#/definitions/ServicePrincipal" } } } }, "ServicePrincipal": { "description": "The Service Principal Id for the subscription.", "type": "object", "properties": { "properties": { "title": "Properties", "$ref": "#/definitions/ServicePrincipalProperties", "description": "The Service Principal properties for the subscription" }, "systemData": { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", "readOnly": true, "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" } ] }, "ServicePrincipalProperties": { "description": "The Service Principal properties for the subscription.", "type": "object", "properties": { "servicePrincipalId": { "type": "string", "readOnly": true, "description": "The Service Principal Id for the subscription." }, "authorizationSet": { "type": "boolean", "readOnly": true, "description": "Returns the contributor RBAC Role exist or not for the Service Principal Id." } } }, "ManagedBy": { "type": "string", "description": "Azure resource id. Indicates if this resource is managed by another Azure resource." } }, "parameters": { "VmNameParameter": { "name": "vmName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual machine.", "x-ms-parameter-location": "method" }, "MachineNameParameter": { "name": "machineName", "in": "path", "required": true, "type": "string", "description": "The name of the Arc machine.", "x-ms-parameter-location": "method" }, "ClusterNameParameter": { "name": "clusterName", "in": "path", "required": true, "type": "string", "description": "The name of the Arc machine.", "x-ms-parameter-location": "method" } } }