swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector ImportJobsController API schemes: - https tags: - name: ImportJobsController paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteJobs : get: operationId: microsoftAzureImportjobscontrollerListdeletejobs tags: - ImportJobsController description: Method to get all delete import machines job for the given site. 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: siteName in: path description: Site name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/PagedDeleteImportMachinesJob' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: ImportJobsController_ListDeletejobs_MaximumSet_Gen: $ref: ./examples/ImportJobsController_ListDeletejobs_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Importsites Sitename Deletejobs ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/deleteJobs/{jobName} : get: operationId: microsoftAzureImportjobscontrollerGetdeletejob tags: - ImportJobsController description: Gets the delete imported machines job with the given job name. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: siteName in: path description: Site name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: jobName in: path description: Job Arm Name. required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/DeleteImportMachinesJob' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: ImportJobsController_GetDeletejob_MaximumSet_Gen: $ref: ./examples/ImportJobsController_GetDeletejob_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Importsites Sitename Deletejobs Jobname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportJobs : get: operationId: microsoftAzureImportjobscontrollerListexportjobs tags: - ImportJobsController description: Method to get all export import machines job for the given site. 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: siteName in: path description: Site name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/PagedExportImportedMachinesJob' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: ImportJobsController_ListExportjobs_MaximumSet_Gen: $ref: ./examples/ImportJobsController_ListExportjobs_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Importsites Sitename Exportjobs ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/exportJobs/{jobName} : get: operationId: microsoftAzureImportjobscontrollerGetexportjob tags: - ImportJobsController description: Gets the export imported machines job with the given job name. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: siteName in: path description: Site name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: jobName in: path description: Job Arm Name. required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/ExportImportedMachinesJob' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: ImportJobsController_GetExportjob_MaximumSet_Gen: $ref: ./examples/ImportJobsController_GetExportjob_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Importsites Sitename Exportjobs Jobname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importJobs : get: operationId: microsoftAzureImportjobscontrollerListimportjobs tags: - ImportJobsController description: Method to get all import machines job for the given site. 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: siteName in: path description: Site name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/PagedImportMachinesJob' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: ImportJobsController_ListImportjobs_MaximumSet_Gen: $ref: ./examples/ImportJobsController_ListImportjobs_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Importsites Sitename Importjobs ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/importJobs/{jobName} : get: operationId: microsoftAzureImportjobscontrollerGetimportjob tags: - ImportJobsController description: Gets the import job with the given job name. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: siteName in: path description: Site name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: jobName in: path description: Job Arm Name. required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/ImportMachinesJob' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: ImportJobsController_GetImportjob_MaximumSet_Gen: $ref: ./examples/ImportJobsController_GetImportjob_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Importsites Sitename Importjobs Jobname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/jobs : get: operationId: microsoftAzureImportjobscontrollerListbyimportsite tags: - ImportJobsController description: List ImportJob resources by ImportSite 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: siteName in: path description: Site name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/ImportJobListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: ImportJobsController_ListByImportSite_MaximumSet_Gen: $ref: ./examples/ImportJobsController_ListByImportSite_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Importsites Sitename Jobs ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/importSites/{siteName}/jobs/{jobName} : get: operationId: microsoftAzureImportjobscontrollerGet tags: - ImportJobsController description: Get a ImportJob 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: siteName in: path description: Site name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: jobName in: path description: ' Jobs name' required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/ImportJob' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: ImportJobsController_Get_MaximumSet_Gen: $ref: ./examples/ImportJobsController_Get_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Importsites Sitename Jobs Jobname definitions: PagedImportMachinesJob: type: object description: Paged collection of ImportMachinesJob items properties: value: type: array description: The ImportMachinesJob items on this page items: $ref: '#/definitions/ImportMachinesJob' readOnly: true x-ms-identifiers: [] nextLink: type: string description: The link to the next page of items readOnly: true JobProperties: type: object description: Job REST Resource. properties: status: type: string description: Gets operation status. readOnly: true startTime: type: string description: Gets operation start time. readOnly: true endTime: type: string description: Gets operation end time. readOnly: true displayName: type: string description: Gets or sets the display name of the Job. readOnly: true clientRequestId: type: string description: Gets the client request Id used in the operation execution context. readOnly: true activityId: type: string description: Gets the activity Id used in the operation execution context. readOnly: true errors: type: array description: Gets the errors. items: $ref: '#/definitions/ErrorDetails' readOnly: true x-ms-identifiers: [] provisioningState: $ref: '#/definitions/ProvisioningState' description: The status of the last operation. readOnly: true ImportJobListResult: type: object description: The response of a ImportJob list operation. properties: value: type: array description: The ImportJob items on this page items: $ref: '#/definitions/ImportJob' nextLink: type: string format: uri description: The link to the next page of items required: - value ExportImportedMachinesJobEntityProperties: type: object description: ' Export Imported Machines JobEntity Properties ' properties: blobName: type: string description: blob name sasUri: type: string description: sas uri JobResult: type: string description: JobResultValues enum: - Unknown - Completed - CompletedWithWarnings - CompletedWithErrors - Failed - WaitingForBlobUpload - InProgress x-ms-enum: name: JobResult modelAsString: true values: - name: Unknown value: Unknown description: Unknown value. - name: Completed value: Completed description: Completed value. - name: CompletedWithWarnings value: CompletedWithWarnings description: CompletedWithWarnings value. - name: CompletedWithErrors value: CompletedWithErrors description: CompletedWithErrors value. - name: Failed value: Failed description: Failed value. - name: WaitingForBlobUpload value: WaitingForBlobUpload description: WaitingForBlobUpload value. - name: InProgress value: InProgress description: InProgress value. DeleteImportMachinesJob: type: object description: A host resource belonging to a site resource. properties: properties: $ref: '#/definitions/DeleteImportedMachinesJobProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource DeleteImportedMachinesJobProperties: type: object description: Delete Imported Machines Job Properties properties: blobName: type: string description: blob name errorSasUri: type: string description: error Sas Uri jobState: $ref: '#/definitions/DeleteImportedMachinesJobPropertiesJobState' description: job State numberOfMachinesDeleted: type: integer format: int32 description: number Of Machines Deleted deletionConfirmation: type: boolean description: deletion Confirmation errors: type: array description: errors list items: type: string readOnly: true status: type: string description: Gets or sets the Job status. startTime: type: string description: Gets or sets the Job start time. endTime: type: string description: Gets or sets the Job end time. displayName: type: string description: Gets or sets the Display name. provisioningState: $ref: '#/definitions/ProvisioningState' description: The status of the last operation. ErrorDetails: type: object description: Error contract returned when some exception occurs in Rest API. properties: code: type: string description: Gets the error code. readOnly: true message: type: string description: Gets the error message. readOnly: true possibleCauses: type: string description: Gets the possible causes of error. readOnly: true recommendedAction: type: string description: Gets the recommended action to resolve error. readOnly: true severity: type: string description: Gets the error severity. readOnly: true isAgentReportedError: type: boolean description: Gets a value indicating whether the error originated from a agent or not. readOnly: true agentErrorCode: type: string description: Gets the agent error code. readOnly: true agentErrorMessage: type: string description: Gets the error message from the agent. readOnly: true agentErrorPossibleCauses: type: string description: Gets possible causes for the agent error. readOnly: true agentErrorRecommendedAction: type: string description: Gets the recommended action for the agent error. readOnly: true ExportImportedMachinesJob: type: object description: Export machines job REST resource. properties: type: type: string description: Type name for export job. readOnly: true properties: $ref: '#/definitions/ExportImportedMachinesJobEntityProperties' description: Gets or sets the export machines job properties. id: type: string description: Gets or sets the relative ARM name to get job. name: type: string description: Gets or sets the Job ID. status: type: string description: Gets or sets the Job status. startTime: type: string description: Gets or sets the Job start time. endTime: type: string description: Gets or sets the Job end time. displayName: type: string description: Gets or sets the Display name. DeleteImportedMachinesJobPropertiesJobState: type: string description: Cosmos db Imported Machines JobEntity enum: - Unknown - Verified - VerifiedWithErrors - Completed - Failed x-ms-enum: name: DeleteImportedMachinesJobPropertiesJobState modelAsString: true values: - name: Unknown value: Unknown description: Unknown value. - name: Verified value: Verified description: Verified value. - name: VerifiedWithErrors value: VerifiedWithErrors description: VerifiedWithErrors value. - name: Completed value: Completed description: Completed value. - name: Failed value: Failed description: Failed value. ImportMachinesJob: type: object description: Import machines Job REST Resource. properties: type: type: string description: 'Handled by resource provider. Type = Microsoft.OffAzure/ImportSites/jobs/importJobs.' readOnly: true properties: $ref: '#/definitions/ImportMachinesJobProperties' description: Gets or sets the import job properties. id: type: string description: Gets or sets the relative ARM name to get job. name: type: string description: Gets or sets the Job ID. status: type: string description: Gets or sets the Job status. startTime: type: string description: Gets or sets the Job start time. endTime: type: string description: Gets or sets the Job end time. displayName: type: string description: Gets or sets the Display name. ProvisioningState: type: string description: The status of the current operation. enum: - Created - Updated - Running - Completed - Failed - Succeeded - Canceled x-ms-enum: name: ProvisioningState modelAsString: true values: - name: Created value: Created description: Created value. - name: Updated value: Updated description: Updated value. - name: Running value: Running description: Running value. - name: Completed value: Completed description: Completed value. - name: Failed value: Failed description: Failed value. - name: Succeeded value: Succeeded description: Succeeded value. - name: Canceled value: Canceled description: Canceled value. JobErrorSummary: type: object description: Job Error Summary properties: errors: type: array description: errors list items: type: string errorCount: type: integer format: int32 description: error count warningCount: type: integer format: int32 description: warning Count PagedExportImportedMachinesJob: type: object description: Paged collection of ExportImportedMachinesJob items properties: value: type: array description: The ExportImportedMachinesJob items on this page items: $ref: '#/definitions/ExportImportedMachinesJob' readOnly: true x-ms-identifiers: [] nextLink: type: string description: The link to the next page of items readOnly: true PagedDeleteImportMachinesJob: type: object description: Paged collection of DeleteImportMachinesJob items properties: value: type: array description: The DeleteImportMachinesJob items on this page items: $ref: '#/definitions/DeleteImportMachinesJob' readOnly: true x-ms-identifiers: [] nextLink: type: string description: The link to the next page of items readOnly: true ImportJob: type: object description: A host resource belonging to a site resource. properties: properties: $ref: '#/definitions/JobProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource ImportMachinesJobProperties: type: object description: ImportMachines JobProperties properties: blobName: type: string description: blob name blobSasUri: type: string description: blob sasUri jobResult: $ref: '#/definitions/JobResult' description: job Result numberOfMachinesImported: type: integer format: int32 description: number Of Machines Imported blobCreationTimeStamp: type: string format: date-time description: blob Creation TimeStamp errorSummary: $ref: '#/definitions/JobErrorSummary' description: error summary x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'