{"files":{"SKILL.md":"---\nname: databoxmanagementclient\ndescription: \"DataBoxManagementClient API skill. Use when working with DataBoxManagementClient for providers, subscriptions. Covers 16 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# DataBoxManagementClient\nAPI version: 2019-09-01\n\n## Auth\nOAuth2\n\n## Base URL\nhttps://management.azure.com\n\n## Setup\n1. Configure auth: OAuth2\n2. GET /providers/Microsoft.DataBox/operations -- this method gets all the operations.\n3. POST /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/availableSkus -- create first availableSkus\n\n## Endpoints\n16 endpoints across 2 groups. See references/api-spec.lap for full details.\n\n### Providers\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /providers/Microsoft.DataBox/operations | This method gets all the operations. |\n\n### Subscriptions\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs | Lists all the jobs available under the subscription. |\n| POST | /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/availableSkus | This method provides the list of available skus for the given subscription and location. |\n| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/availableSkus | This method provides the list of available skus for the given subscription, resource group and location. |\n| POST | /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress | [DEPRECATED NOTICE: This operation will soon be removed] This method validates the customer shipping address and provide alternate addresses if any. |\n| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/validateInputs | This method does all necessary pre-job creation validation under resource group. |\n| POST | /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateInputs | This method does all necessary pre-job creation validation under subscription. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs | Lists all the jobs available under the given resource group. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName} | Gets information about the specified job. |\n| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName} | Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API. |\n| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName} | Deletes a job. |\n| PATCH | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName} | Updates the properties of an existing job. |\n| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp | Book shipment pick up. |\n| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel | CancelJob. |\n| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials | This method gets the unencrypted secrets related to the job. |\n| POST | /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration | This API provides configuration details specific to given region/location. |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all operations?\" -> GET /providers/Microsoft.DataBox/operations\n- \"List all jobs?\" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs\n- \"Create a availableSkus?\" -> POST /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/availableSkus\n- \"Create a validateAddress?\" -> POST /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress\n- \"Create a validateInput?\" -> POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/validateInputs\n- \"Get job details?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}\n- \"Update a job?\" -> PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}\n- \"Delete a job?\" -> DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}\n- \"Partially update a job?\" -> PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}\n- \"Create a bookShipmentPickUp?\" -> POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp\n- \"Create a cancel?\" -> POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel\n- \"Create a listCredential?\" -> POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials\n- \"Create a regionConfiguration?\" -> POST /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Create/update endpoints return the modified resource on success\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api DataBoxManagementClient\n@base https://management.azure.com\n@version 2019-09-01\n@auth OAuth2\n@common_fields {api-version: any # The API Version}\n@endpoints 16\n@toc providers(1), subscriptions(15)\n\n@group providers\n@endpoint GET /providers/Microsoft.DataBox/operations\n@desc This method gets all the operations.\n@returns(200) The supported operations list.\n\n@endgroup\n\n@group subscriptions\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs\n@desc Lists all the jobs available under the subscription.\n@required {subscriptionId: any # The Subscription Id}\n@optional {$skipToken: any # $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.}\n@returns(200) List of jobs available under the subscription.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/availableSkus\n@desc This method provides the list of available skus for the given subscription and location.\n@required {subscriptionId: any # The Subscription Id, location: any # The location of the resource, availableSkuRequest: map # Filters for showing the available skus.}\n@returns(200) The list of available skus under subscription.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/availableSkus\n@desc This method provides the list of available skus for the given subscription, resource group and location.\n@required {subscriptionId: any # The Subscription Id, resourceGroupName: any # The Resource Group Name, location: any # The location of the resource, availableSkuRequest: map # Filters for showing the available skus.}\n@returns(200) The list of available skus under Resource group.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress\n@desc [DEPRECATED NOTICE: This operation will soon be removed] This method validates the customer shipping address and provide alternate addresses if any.\n@required {subscriptionId: any # The Subscription Id, location: any # The location of the resource, validateAddress: map # Shipping address of the customer.}\n@returns(200) The valid and alternate addresses.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/locations/{location}/validateInputs\n@desc This method does all necessary pre-job creation validation under resource group.\n@required {subscriptionId: any # The Subscription Id, resourceGroupName: any # The Resource Group Name, location: any # The location of the resource, validationRequest: map # Inputs of the customer.}\n@returns(200) The validation status and responses of each validating parameter.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateInputs\n@desc This method does all necessary pre-job creation validation under subscription.\n@required {subscriptionId: any # The Subscription Id, location: any # The location of the resource, validationRequest: map # Inputs of the customer.}\n@returns(200) The validation status and responses of each validating parameter.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs\n@desc Lists all the jobs available under the given resource group.\n@required {subscriptionId: any # The Subscription Id, resourceGroupName: any # The Resource Group Name}\n@optional {$skipToken: any # $skipToken is supported on Get list of jobs, which provides the next page in the list of jobs.}\n@returns(200) List of jobs by resource group.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}\n@desc Gets information about the specified job.\n@required {subscriptionId: any # The Subscription Id, resourceGroupName: any # The Resource Group Name, jobName: any # The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@optional {$expand: any # $expand is supported on details parameter for job, which provides details on the job stages.}\n@returns(200) Job object.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}\n@desc Creates a new job with the specified parameters. Existing job cannot be updated with this API and should instead be updated with the Update job API.\n@required {subscriptionId: any # The Subscription Id, resourceGroupName: any # The Resource Group Name, jobName: any # The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only, jobResource: map # Job details from request body.}\n@returns(200) Job object.\n@returns(202) Accepted request for create Job.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}\n@desc Deletes a job.\n@required {subscriptionId: any # The Subscription Id, resourceGroupName: any # The Resource Group Name, jobName: any # The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(202) Accepted request for delete Job.\n@returns(204) Job deleted.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}\n@desc Updates the properties of an existing job.\n@required {subscriptionId: any # The Subscription Id, resourceGroupName: any # The Resource Group Name, jobName: any # The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only, jobResourceUpdateParameter: map # Job update parameters from request body.}\n@optional {If-Match: any # Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.}\n@returns(200) Job object.\n@returns(202) Accepted request for job updated.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp\n@desc Book shipment pick up.\n@required {subscriptionId: any # The Subscription Id, resourceGroupName: any # The Resource Group Name, jobName: any # The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only, shipmentPickUpRequest: map # Details of shipment pick up request.}\n@returns(200) Booked shipment pick up successfully.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel\n@desc CancelJob.\n@required {subscriptionId: any # The Subscription Id, resourceGroupName: any # The Resource Group Name, jobName: any # The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only, cancellationReason: map # Reason for cancellation.}\n@returns(204) Job cancelled.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials\n@desc This method gets the unencrypted secrets related to the job.\n@required {subscriptionId: any # The Subscription Id, resourceGroupName: any # The Resource Group Name, jobName: any # The name of the job Resource within the specified resource group. job names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(200) List of unencrypted credentials of the job.\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/regionConfiguration\n@desc This API provides configuration details specific to given region/location.\n@required {subscriptionId: any # The Subscription Id, location: any # The location of the resource, regionConfigurationRequest: map # Request body to get the configuration for the region.}\n@returns(200) Region configuration response.\n\n@endgroup\n\n@end\n"}}