swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Solutions API schemes: - https tags: - name: Solutions paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/solutions/{solutionId} : put: tags: - Solutions description: Install Or Update Solution. operationId: microsoftAzureSolutionsCreateorupdate consumes: - application/json produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter' - in: path name: solutionId description: SolutionId for Data Manager For Agriculture Resource. required: true type: string pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$ - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - in: body name: requestBody description: Solution resource request body. schema: $ref: '#/definitions/Solution' responses: '200': description: Success schema: $ref: '#/definitions/Solution' '201': description: Created schema: $ref: '#/definitions/Solution' default: description: Error schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-examples: Solutions_CreateOrUpdate: $ref: ./examples/Solutions_CreateOrUpdate.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Solutions Solutionid get: tags: - Solutions description: Get installed Solution details by Solution id. operationId: microsoftAzureSolutionsGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter' - in: path name: solutionId description: SolutionId for Data Manager For Agriculture Resource. required: true type: string pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$ - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: Success schema: $ref: '#/definitions/Solution' default: description: Error schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-examples: Solutions_Get: $ref: ./examples/Solutions_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Solutions Solutionid delete: tags: - Solutions description: Uninstall Solution. operationId: microsoftAzureSolutionsDelete produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter' - in: path name: solutionId description: SolutionId for Data Manager For Agriculture Resource. required: true type: string pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$ - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter responses: '200': description: Success '204': description: No Content default: description: Error schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-examples: Solutions_Delete: $ref: ./examples/Solutions_Delete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Solutions Solutionid ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{dataManagerForAgricultureResourceName}/solutions : get: tags: - Solutions description: Get installed Solutions details. operationId: microsoftAzureSolutionsList produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DataManagerForAgricultureResourceNameParameter' - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - in: query name: solutionIds description: Installed Solution ids. type: array items: type: string collectionFormat: multi - in: query name: ids description: Ids of the resource. type: array items: type: string collectionFormat: multi - in: query name: names description: Names of the resource. type: array items: type: string collectionFormat: multi - in: query name: propertyFilters description: "Filters on key-value pairs within the Properties object.\r\neg. \"{testKey} eq {testValue}\"." type: array items: type: string collectionFormat: multi - in: query name: statuses description: Statuses of the resource. type: array items: type: string collectionFormat: multi - in: query name: minCreatedDateTime description: Minimum creation date of resource (inclusive). type: string format: date-time - in: query name: maxCreatedDateTime description: Maximum creation date of resource (inclusive). type: string format: date-time - in: query name: minLastModifiedDateTime description: Minimum last modified date of resource (inclusive). type: string format: date-time - in: query name: maxLastModifiedDateTime description: Maximum last modified date of resource (inclusive). type: string format: date-time - in: query name: $maxPageSize description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50." type: integer format: int32 default: 50 maximum: 1000 minimum: 10 - in: query name: $skipToken description: Skip token for getting next set of results. type: string responses: '200': description: Success schema: $ref: '#/definitions/SolutionListResponse' default: description: Error schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Solutions_List: $ref: ./examples/Solutions_List.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Agfoodplatform Farmbeats Datamanagerforagricultureresourcename Solutions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName} : get: tags: - Solutions summary: Microsoft Azure Gets A Solution In The Migrate Project operationId: microsoftAzureSolutionsGetsolution parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/migrateProjectName' - $ref: '#/parameters/solutionName' - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/Solution_2' deprecated: false x-ms-examples: Solutions_Get: $ref: ./examples/Solutions_Get.json description: Needs a more full description created. put: tags: - Solutions summary: Microsoft Azure Creates A Solution In The Migrate Project operationId: microsoftAzureSolutionsPutsolution parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/migrateProjectName' - $ref: '#/parameters/solutionName' - name: solutionInput in: body description: The input for the solution. required: true schema: $ref: '#/definitions/Solution_2' - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/Solution_2' '201': description: Created schema: $ref: '#/definitions/Solution_2' deprecated: false x-ms-examples: Solutions_Put: $ref: ./examples/Solutions_Put.json description: Needs a more full description created. patch: tags: - Solutions summary: Microsoft Azure Update Solution description: Update a solution with specified name. Supports partial updates, for example only tags can be provided. operationId: microsoftAzureSolutionsPatchsolution parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/migrateProjectName' - $ref: '#/parameters/solutionName' - name: solutionInput in: body description: The input for the solution. required: true schema: $ref: '#/definitions/Solution_2' - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/Solution_2' deprecated: false x-ms-examples: Solutions_Patch: $ref: ./examples/Solutions_Patch.json delete: tags: - Solutions summary: Microsoft Azure Delete The Solution description: Delete the solution. Deleting non-existent project is a no-operation. operationId: microsoftAzureSolutionsDeletesolution parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/migrateProjectName' - $ref: '#/parameters/solutionName' - $ref: '#/parameters/api-version' - $ref: '#/parameters/acceptLanguage' responses: '200': description: OK deprecated: false x-ms-examples: Solutions_Delete: $ref: ./examples/Solutions_Delete.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions : get: tags: - Solutions summary: Microsoft Azure Gets The List Of Solutions In The Migrate Project operationId: microsoftAzureSolutionsEnumeratesolutions parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/migrateProjectName' - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/SolutionsCollection' deprecated: false x-ms-examples: Solutions_List: $ref: ./examples/Solutions_List.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}/getConfig : post: tags: - Solutions summary: Microsoft Azure Gets The Config For The Solution In The Migrate Project operationId: microsoftAzureSolutionsGetconfig parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/migrateProjectName' - $ref: '#/parameters/solutionName' - $ref: '#/parameters/api-version' responses: '200': description: OK schema: $ref: '#/definitions/SolutionConfig' deprecated: false x-ms-examples: Solutions_GetConfig: $ref: ./examples/Solutions_GetConfig.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/solutions/{solutionName}/cleanupData : post: tags: - Solutions summary: Microsoft Azure Cleanup The Solution Data In The Migrate Project operationId: microsoftAzureSolutionsCleanupsolutiondata parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/migrateProjectName' - $ref: '#/parameters/solutionName' - $ref: '#/parameters/api-version' responses: '200': description: OK deprecated: false x-ms-examples: Solutions_CleanupData: $ref: ./examples/Solutions_CleanupData.json description: Needs a more full description created. /{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}: put: tags: - Solutions description: 'Creates a solution for the specific Azure resource or subscription using the inputs ‘solutionId and requiredInputs’ from discovery solutions. Azure solutions comprise a comprehensive library of self-help resources that have been thoughtfully curated by Azure engineers to aid customers in resolving typical troubleshooting issues. These solutions encompass: (1.) Dynamic and context-aware diagnostics, guided troubleshooting wizards, and data visualizations. (2.) Rich instructional video tutorials and illustrative diagrams and images. (3.) Thoughtfully assembled textual troubleshooting instructions. All these components are seamlessly converged into unified solutions tailored to address a specific support problem area.' operationId: microsoftAzureSolutionCreate x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/SolutionResourceNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: solutionRequestBody description: The required request body for this solution resource creation. in: body schema: $ref: '#/definitions/SolutionResource' responses: '200': description: Create or Update solution invocation. schema: $ref: '#/definitions/SolutionResource' '201': description: Create or Update solution invocation. schema: $ref: '#/definitions/SolutionResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Solution_Create: $ref: ./examples/Solution_Create.json summary: Microsoft Azure Put Scope Providers Microsoft Help Solutions Solutionresourcename get: tags: - Solutions description: Get the solution using the applicable solutionResourceName while creating the solution. operationId: microsoftAzureSolutionGet parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/SolutionResourceNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Successful fetched solution result. schema: $ref: '#/definitions/SolutionResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Solution_Get: $ref: ./examples/Solution_Get.json summary: Microsoft Azure Get Scope Providers Microsoft Help Solutions Solutionresourcename patch: tags: - Solutions description: 'Update the requiredInputs or additional information needed to execute the solution ' operationId: microsoftAzureSolutionUpdate x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/SolutionResourceNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: solutionPatchRequestBody description: The required request body for updating a solution resource. in: body schema: $ref: '#/definitions/SolutionPatchRequestBody' responses: '200': description: Successful updated solution resource. headers: Location: type: string schema: $ref: '#/definitions/SolutionResource' '202': description: Successful updated solution resource. headers: Location: type: string schema: $ref: '#/definitions/SolutionResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Solution_Update: $ref: ./examples/Solution_Update.json summary: Microsoft Azure Patch Scope Providers Microsoft Help Solutions Solutionresourcename /{scope}/providers/Microsoft.Help/solutions/{solutionResourceName}/warmup: post: tags: - Solutions description: Warm up the solution resource by preloading asynchronous diagnostics results into cache operationId: microsoftAzureSolutionWarmup parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/SolutionResourceNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: solutionWarmUpRequestBody description: The required request body for warming up a solution resource. in: body schema: $ref: '#/definitions/SolutionWarmUpRequestBody' responses: '204': description: Successfully warmed up the solution resource default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Solution_WarmUp: $ref: ./examples/Solution_WarmUp.json summary: Microsoft Azure Post Scope Providers Microsoft Help Solutions Solutionresourcename Warmup /subscriptions/{subscriptionId}/providers/Microsoft.IoTOperationsOrchestrator/solutions: get: operationId: microsoftAzureSolutionsListbysubscription tags: - Solutions description: List Solution resources by subscription ID parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/SolutionListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Solutions_ListBySubscription - generated by [MaximumSet] rule - generated by [MaximumSet] rule: $ref: ./examples/Solutions_ListBySubscription_MaximumSet_Gen.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Iotoperationsorchestrator Solutions /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsOrchestrator/solutions: get: operationId: microsoftAzureSolutionsListbyresourcegroup tags: - Solutions description: List Solution resources by resource group parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/SolutionListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Solutions_ListByResourceGroup - generated by [MaximumSet] rule - generated by [MaximumSet] rule: $ref: ./examples/Solutions_ListByResourceGroup_MaximumSet_Gen.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsorchestrator Solutions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsOrchestrator/solutions/{name} : get: operationId: microsoftAzureSolutionsGet tags: - Solutions description: Get a Solution parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of solution. required: true type: string pattern: ^[a-z0-9][a-z0-9-]{1,60}[a-z0-9]$ responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/Solution_3' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Solutions_Get - generated by [MaximumSet] rule - generated by [MaximumSet] rule: $ref: ./examples/Solutions_Get_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsorchestrator Solutions Name put: operationId: microsoftAzureSolutionsCreateorupdate tags: - Solutions description: Create a Solution parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of solution. required: true type: string pattern: ^[a-z0-9][a-z0-9-]{1,60}[a-z0-9]$ - name: resource in: body description: Resource create parameters. required: true schema: $ref: '#/definitions/Solution_3' responses: '200': description: Resource 'Solution' update operation succeeded schema: $ref: '#/definitions/Solution_3' '201': description: Resource 'Solution' create operation succeeded schema: $ref: '#/definitions/Solution_3' headers: 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/v3/types.json#/definitions/ErrorResponse x-ms-examples: Solutions_CreateOrUpdate - generated by [MaximumSet] rule - generated by [MaximumSet] rule: $ref: ./examples/Solutions_CreateOrUpdate_MaximumSet_Gen.json x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsorchestrator Solutions Name patch: operationId: microsoftAzureSolutionsUpdate tags: - Solutions description: Update a Solution parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of solution. required: true type: string pattern: ^[a-z0-9][a-z0-9-]{1,60}[a-z0-9]$ - name: properties in: body description: The resource properties to be updated. required: true schema: $ref: '#/definitions/SolutionTagsUpdate' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/Solution_3' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Solutions_Update - generated by [MaximumSet] rule - generated by [MaximumSet] rule: $ref: ./examples/Solutions_Update_MaximumSet_Gen.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsorchestrator Solutions Name delete: operationId: microsoftAzureSolutionsDelete tags: - Solutions description: Delete a Solution parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of solution. required: true type: string pattern: ^[a-z0-9][a-z0-9-]{1,60}[a-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/v3/types.json#/definitions/ErrorResponse x-ms-examples: Solutions_Delete - generated by [MaximumSet] rule - generated by [MaximumSet] rule: $ref: ./examples/Solutions_Delete_MaximumSet_Gen.json x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsorchestrator Solutions Name definitions: SolutionResource: description: Solution response. type: object x-ms-azure-resource: true allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/SolutionResourceProperties' x-ms-client-flatten: true ReplacementMaps: description: Solution replacement maps. type: object properties: webResults: description: Solution AzureKB results type: array items: $ref: '#/definitions/WebResult' x-ms-identifiers: [] diagnostics: description: Solution diagnostics results. type: array items: $ref: '#/definitions/SolutionsDiagnostic' x-ms-identifiers: - solutionId troubleshooters: description: Solutions Troubleshooters type: array items: $ref: '#/definitions/SolutionsTroubleshooters' x-ms-identifiers: - solutionId metricsBasedCharts: description: Solution metrics based charts type: array items: $ref: '#/definitions/MetricsBasedChart' x-ms-identifiers: [] videos: description: Video solutions, which have the power to engage the customer by stimulating their senses type: array items: $ref: '#/definitions/Video' x-ms-identifiers: [] videoGroups: description: Group of Videos type: array items: $ref: '#/definitions/VideoGroup' x-ms-identifiers: [] Solution: description: Solution resource. type: object allOf: - $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource properties: systemData: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/systemData properties: $ref: '#/definitions/SolutionProperties' eTag: description: The ETag value to implement optimistic concurrency. type: string readOnly: true x-ms-azure-resource: true ExtendedLocation: type: object description: Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances. properties: name: type: string description: The name of the extended location. type: type: string description: The type of the extended location. required: - name - type SolutionConfig: description: Class representing the config for the solution in the migrate project. type: object properties: publisherSasUri: description: Gets or sets the publisher sas uri for the solution. type: string Solution_2: description: Solution REST Resource. x-ms-azure-resource: true type: object properties: id: description: Gets the relative URL to get to this REST resource. type: string readOnly: true name: description: Gets the name of this REST resource. type: string readOnly: true type: description: Gets the type of this REST resource. type: string readOnly: true etag: description: Gets or sets the ETAG for optimistic concurrency control. type: string properties: $ref: '#/definitions/SolutionProperties_2' description: Gets or sets the properties of the solution. SolutionProperties: description: Solution resource properties. required: - marketplacePublisherId - offerId - planId - saasSubscriptionId - saasSubscriptionName - termId type: object properties: partnerId: description: Partner Id of the Solution. type: string readOnly: true saasSubscriptionId: description: SaaS subscriptionId of the installed SaaS application. minLength: 1 type: string saasSubscriptionName: description: SaaS subscription name of the installed SaaS application. minLength: 1 type: string marketplacePublisherId: description: SaaS application Marketplace Publisher Id. minLength: 1 type: string planId: description: SaaS application Plan Id. minLength: 1 type: string roleAssignmentId: description: Role Assignment Id. type: string offerId: description: SaaS application Offer Id. minLength: 1 type: string termId: description: SaaS application Term Id. minLength: 1 type: string additionalProperties: {} TriggerCriterion: description: Solution request trigger criterion. SolutionId/ProblemClassificationId is the only supported trigger type for Solution PUT request. ReplacementKey is the only supported trigger type for Solution PATCH request. type: object properties: name: description: Trigger criterion name. type: string enum: - SolutionId - ProblemClassificationId - ReplacementKey x-ms-enum: name: name modelAsString: true value: description: Trigger criterion value. type: string SolutionListResponse: description: Paged response contains list of requested objects and a URL link to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/Solution' $skipToken: description: Token used in retrieving the next page. If null, there are no additional pages. type: string nextLink: description: Continuation link (absolute URI) to the next page of results in the list. type: string Video: allOf: - $ref: '#/definitions/VideoGroupVideo' description: Video detail type: object properties: replacementKey: description: Place holder used in HTML Content replace control with the insight content type: string SolutionResourceProperties: description: Solution result type: object properties: triggerCriteria: description: Solution request trigger criteria type: array items: $ref: '#/definitions/TriggerCriterion' x-ms-identifiers: - name parameters: description: Client input parameters to run Solution type: object additionalProperties: type: string solutionId: description: Solution Id to identify single solution. readOnly: true type: string provisioningState: description: Status of solution provisioning. type: string readOnly: true enum: - Succeeded - PartialComplete - Failed - Running - Canceled x-ms-enum: name: SolutionProvisioningState modelAsString: true values: - value: Succeeded description: All Solutions in the Batch succeeded. - value: PartialComplete description: Some Solutions are still running or failed. - value: Failed description: All Solutions failed to run. - value: Running description: All Solutions are still running. - value: Canceled description: When Solutions request gets canceled. title: description: The title. readOnly: true type: string content: description: The HTML content that needs to be rendered and shown to customer. readOnly: true type: string replacementMaps: $ref: '#/definitions/ReplacementMaps' readOnly: true sections: description: List of section object. type: array readOnly: true items: $ref: '#/definitions/Section' x-ms-identifiers: - title SolutionsCollection: description: Collection of solutions. type: object properties: value: description: Gets or sets the list of solutions. type: array items: $ref: '#/definitions/Solution_2' nextLink: description: Gets or sets the value of next link. type: string SolutionProperties_3: type: object description: The properties of a Solution resource. properties: components: type: array description: A list of components items: $ref: '#/definitions/ComponentProperties' x-ms-identifiers: [] version: type: string description: Version of the particular resource. provisioningState: $ref: '#/definitions/Azure.ResourceManager.ResourceProvisioningState' description: The status of the last operation. readOnly: true SolutionSummary: description: The solution summary class. type: object properties: instanceType: description: Gets the Instance type. type: string readOnly: true discriminator: instanceType ComponentProperties: type: object description: Defines a desired runtime component. properties: dependencies: type: array description: Component dependencies. items: type: string name: type: string description: Name of the component. properties: type: object description: Properties of the component. additionalProperties: {} type: type: string description: Component type. required: - name - type VideoGroup: description: Video group detail type: object properties: videos: description: List of videos will be shown to customers type: array items: $ref: '#/definitions/VideoGroupVideo' x-ms-identifiers: [] replacementKey: description: Place holder used in HTML Content replace control with the insight content type: string FilterGroup: description: Filter group type: object properties: filter: description: List of filters type: array items: $ref: '#/definitions/Filter' x-ms-identifiers: [] SolutionWarmUpRequestBody: description: Solution WarmUpRequest body type: object x-ms-azure-resource: true properties: parameters: type: object additionalProperties: type: string Azure.ResourceManager.ResourceProvisioningState: type: string description: The provisioning state of a resource type. enum: - Succeeded - Failed - Canceled x-ms-enum: name: ResourceProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Resource has been created. - name: Failed value: Failed description: Resource creation failed. - name: Canceled value: Canceled description: Resource creation was canceled. WebResult: description: AzureKB web result type: object properties: replacementKey: description: Place holder used in HTML Content replace control with the content type: string searchResults: description: AzureKB search results type: array items: $ref: '#/definitions/SearchResult' x-ms-identifiers: - solutionId SolutionDetails: description: Class representing the details of the solution. type: object properties: groupCount: format: int32 description: Gets or sets the count of groups reported by the solution. type: integer assessmentCount: format: int32 description: Gets or sets the count of assessments reported by the solution. type: integer extendedDetails: description: Gets or sets the extended details reported by the solution. type: object additionalProperties: type: string SolutionsDiagnostic: description: Solutions Diagnostic type: object properties: solutionId: description: Solution Id to identify single Solutions Diagnostic type: string status: $ref: '#/definitions/Status' statusDetails: description: Details of the status type: string replacementKey: description: Place holder used in HTML Content replace control with the content type: string estimatedCompletionTime: description: Diagnostics estimated completion time in minutes type: string requiredParameters: description: Required parameters of this item type: array items: type: string x-ms-identifiers: [] insights: description: Diagnostic insights type: array items: $ref: '#/definitions/Insight' x-ms-identifiers: [] SolutionPatchRequestBody: description: Solution PatchRequest body type: object x-ms-azure-resource: true properties: properties: $ref: '#/definitions/SolutionResourceProperties' x-ms-client-flatten: true SolutionListResult: type: object description: The response of a Solution list operation. properties: value: type: array description: The Solution items on this page items: $ref: '#/definitions/Solution_3' nextLink: type: string format: uri description: The link to the next page of items required: - value Status: description: The status of the resource. type: string enum: - Failed - MissingInputs - Running - Succeeded - Timeout x-ms-enum: name: status modelAsString: true MetricsBasedChart: description: Solutions metrics based chart type: object properties: name: description: Chart name type: string aggregationType: description: Allowed values are Sum, Avg, Count, Min, Max. Default is Sum type: string enum: - Sum - Avg - Count - Min - Max x-ms-enum: name: aggregationType modelAsString: true timeSpanDuration: description: Time span duration type: string title: description: Chart title type: string filterGroup: $ref: '#/definitions/FilterGroup' replacementKey: description: Place holder used in HTML Content replace control with the content type: string Solution_3: type: object description: A Solution resource belonging to an Instance resource. properties: properties: $ref: '#/definitions/SolutionProperties_3' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create extendedLocation: $ref: '#/definitions/ExtendedLocation' description: Edge location of the resource. x-ms-mutability: - read - create required: - extendedLocation allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource VideoGroupVideo: description: VideoGroup video detail type: object properties: src: description: Link to the video type: string title: description: Title of the video type: string SolutionProperties_2: description: Class for solution properties. type: object properties: tool: description: Gets or sets the tool being used in the solution. enum: - ServerDiscovery - ServerAssessment - ServerMigration - Cloudamize - Turbonomic - Zerto - CorentTech - ServerAssessmentV1 - ServerMigration_Replication - Carbonite - DataMigrationAssistant - DatabaseMigrationService type: string purpose: description: Gets or sets the purpose of the solution. enum: - Discovery - Assessment - Migration type: string goal: description: Gets or sets the goal of the solution. enum: - Servers - Databases type: string status: description: Gets or sets the current status of the solution. enum: - Inactive - Active type: string cleanupState: description: Gets or sets the cleanup state of the solution. enum: - None - Started - InProgress - Completed - Failed type: string summary: $ref: '#/definitions/SolutionSummary' description: Gets or sets the summary of the solution. details: $ref: '#/definitions/SolutionDetails' description: Gets or sets the details of the solution. Filter: description: Filter criterion type: object properties: name: description: Filter name type: string values: description: Filter values type: string operator: description: Filter operator type: string SearchResult: description: Details of an AzureKB search result. type: object properties: solutionId: description: Unique id of the result. type: string content: description: Content of the search result. type: string title: description: Title of the search result. type: string confidence: description: Confidence of the search result. type: string enum: - Low - Medium - High x-ms-enum: name: confidence modelAsString: true source: description: Source of the search result. type: string resultType: description: Result type of the search result. type: string enum: - Community - Documentation x-ms-enum: name: resultType modelAsString: true rank: description: rank of the search result type: integer format: int32 link: description: Link to the document. type: string Section: description: Part of the solution and are dividers in the solution rendering. type: object properties: title: description: Solution sections title. type: string content: description: Solution sections content. type: string replacementMaps: $ref: '#/definitions/ReplacementMaps' SolutionTagsUpdate: type: object description: The type used for updating tags in Solution resources. properties: tags: type: object description: Resource tags. additionalProperties: type: string SolutionsTroubleshooters: description: Troubleshooters in Solutions type: object properties: solutionId: description: Solution Id to identify single Solutions Troubleshooter type: string title: description: Troubleshooter title type: string summary: description: Troubleshooter summary type: string Insight: description: Detailed insights(s) obtained via the invocation of an insight diagnostic type: object properties: id: description: Article id. type: string title: description: This insight's title. type: string results: description: Detailed result content. type: string importanceLevel: description: Importance level of the insight. type: string enum: - Critical - Warning - Information x-ms-enum: name: importanceLevel modelAsString: true values: - value: Critical description: A critical insight has been found after running the diagnostic. - value: Warning description: A warning insight has been found after running the diagnostic. - value: Information description: An information insight has been found after running the diagnostic. parameters: migrateProjectName: name: migrateProjectName description: Name of the Azure Migrate project. type: string in: path x-ms-parameter-location: method required: true ApiVersionParameter: name: api-version in: query required: true type: string description: Client Api Version. x-ms-parameter-location: client DataManagerForAgricultureResourceNameParameter: in: path name: dataManagerForAgricultureResourceName description: DataManagerForAgriculture resource name. required: true type: string x-ms-parameter-location: method pattern: ^[A-Za-z0-9]+(-[A-Za-z0-9]+)*$ minLength: 1 maxLength: 63 acceptLanguage: description: Standard request header. Used by service to respond to client in appropriate language. name: Accept-Language type: string in: header x-ms-parameter-location: client resourceGroupName: name: resourceGroupName description: Name of the Azure Resource Group that migrate project is part of. type: string in: path x-ms-parameter-location: method required: true api-version: name: api-version description: Standard request header. Used by service to identify API version used by client. type: string in: query required: true enum: - 2018-09-01-preview SolutionResourceNameParameter: name: solutionResourceName in: path required: true type: string description: Solution resource Name. x-ms-parameter-location: method minLength: 1 maxLength: 100 pattern: ^[A-Za-z0-9-+@()_]+$ subscriptionId: name: subscriptionId description: Azure Subscription Id in which migrate project was created. type: string in: path required: true ScopeParameter: name: scope in: path required: true type: string description: 'scope = resourceUri of affected resource.
For example: /subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read ' x-ms-parameter-location: method x-ms-skip-url-encoding: true solutionName: name: solutionName description: Unique name of a migration solution within a migrate project. type: string in: path x-ms-parameter-location: method required: true x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'