swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Datasets API schemes: - https tags: - name: Datasets paths: /datasets: post: x-publish: true description: '**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).

Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.

This API allows the caller to create a dataset from data that was uploaded to the Azure Maps Data Service and converted using the Azure Maps Conversion Service.

You can use this API in a scenario like uploading a DWG zip package for a building, converting the zip package using the Azure Maps Conversion Service, and creating a dataset from the converted zip package. The created dataset can be used to create tilesets using the Azure Maps Tileset Service and can be queried via the Azure Maps WFS Service.

### Submit Create Request

To create your dataset, you will use a `POST` request where the `conversionId` query parameter is an ID that represents the converted DWG zip package, the `datasetId` parameter will be the ID of a previously created dataset to append with the current dataset and, optionally, the `description` query parameter will contain a description (if description is not provided a default description will be given).

The Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).' operationId: microsoftAzureDatasetCreate x-ms-examples: Create dataset from a converted CAD file provided by conversionId: $ref: ./examples/Dataset_Create.json parameters: - $ref: '#/parameters/SubscriptionKey' - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/ConversionIdQuery' - $ref: '#/parameters/AppendDatasetId' - $ref: '#/parameters/DescriptionDataset' responses: '202': $ref: '#/responses/202Accepted' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '500': $ref: '#/responses/500' summary: Microsoft Azure Post Datasets tags: - Datasets get: x-publish: true description: '**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).

Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.

This API allows the caller to fetch a list of all previously successfully created datasets.

### Submit List Request

To list all your datasets, you will issue a `GET` request with no additional parameters.

### List Data Response

The List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):
> created - The timestamp the dataset was created.
> datasetId - The id for the dataset.
> description - The description for the dataset.
> datasetSources - The source data that was used when the create request was issued.
> ontology - The source [ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.

The `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):

> conversionIds - The list of `conversionId` (null if none were provided).
> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).
>featureCounts - The counts for each feature type in the dataset.

Here''s a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 3 dataset resources:

```json
{
"datasets": [
{
"timestamp": "2020-01-01T22:50:48.123Z",
"datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
"description": "Some description or comment for the dataset.",
"datasetSources": {
"conversionIds": [
"15d21452-c9bb-27b6-5e79-743ca5c3205d"
], },
"ontology": "facility-2.0",
"featureCounts": {
"directoryInfo": 2,
"category": 10,
"facility": 1,
"level": 3,
"unit": 183,
"zone": 3,
"verticalPenetration": 6,
"opening": 48,
"areaElement": 108
}
},
{
"timestamp": "2020-01-01T22:57:53.123Z",
"datasetId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c",
"description": "Create from upload ''0c1288fa-2058-4a1b-b68d-13a5f5af7d7c''.",
"datasetSources": {
"conversionIds": [
"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c"
],
"appendDatasetId": "46d1edb6-d29e-4786-9589-dbd4efd7a977"
},
"ontology": "facility-2.0",
"featureCounts": {
"directoryInfo": 2,
"category": 10,
"facility": 1,
"level": 3,
"unit": 183,
"zone": 3,
"verticalPenetration": 6,
"opening": 48,
"areaElement": 108
}
}
]
}
```' operationId: microsoftAzureDatasetList x-ms-examples: List all the previously created datasets: $ref: ./examples/Dataset_List.json parameters: - $ref: '#/parameters/SubscriptionKey' - $ref: '#/parameters/ApiVersion' responses: '200': description: The dataset request completed successfully. The response body contains the previously created dataset. schema: $ref: '#/definitions/DatasetListResponse' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '500': $ref: '#/responses/500' summary: Microsoft Azure Get Datasets tags: - Datasets /datasets/{datasetId}: get: x-publish: true description: '**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).

Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.

This API allows the caller to fetch a previously successfully created dataset.

### Submit Get Details Request

To get the details for a previously created dataset, you will issue a `GET` request with the `datasetId` in the path.

### Get Details Response

The Get Details API returns the details for a dataset in `json` format. The response contains the following fields (if they are not null or empty):
> created - The timestamp the dataset was created.
> datasetId - The id for the dataset.
> description - The description for the dataset.
> datasetSources - The source data that was used when the create request was issued.
> ontology - The source [ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.

The `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):
> conversionIds - The list of `conversionId` (null if none were provided).
> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).
>featureCounts - The counts for each feature type in the dataset.

Here''s a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:

```json
{
"timestamp": "2020-01-01T22:50:48.123Z",
"datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
"description": "Some description or comment for the dataset.",
"datasetSources": {
"conversionIds": [
"15d21452-c9bb-27b6-5e79-743ca5c3205d"
],
},
"ontology": "facility-2.0",
"featureCounts": {
"directoryInfo": 2,
"category": 10,
"facility": 1,
"level": 3,
"unit": 183,
"zone": 3,
"verticalPenetration": 6,
"opening": 48,
"areaElement": 108
}
}
```' operationId: microsoftAzureDatasetGet x-ms-examples: Get details for a previously created dataset: $ref: ./examples/Dataset_GetDetails.json parameters: - $ref: '#/parameters/DatasetId' - $ref: '#/parameters/SubscriptionKey' - $ref: '#/parameters/ApiVersion' responses: '200': description: The get dataset request completed successfully. schema: $ref: '#/definitions/DatasetDetailInfo' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '500': $ref: '#/responses/500' summary: Microsoft Azure Get Datasets Datasetid tags: - Datasets delete: x-publish: true description: '**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).

Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.

You can also use this API to delete old/unused datasets to create space for new Creator content.

### Submit Delete Request

To delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.' operationId: microsoftAzureDatasetDelete x-ms-examples: Delete previously created dataset: $ref: ./examples/Dataset_Delete.json parameters: - $ref: '#/parameters/SubscriptionKey' - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/DatasetId' responses: '204': description: The dataset delete request completed successfully. The resource referenced by the `datasetId` was deleted from the server. '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '500': $ref: '#/responses/500' summary: Microsoft Azure Delete Datasets Datasetid tags: - Datasets patch: tags: - Datasets description: Creates or updates a dataset. operationId: microsoftAzureDatasetsCreateorupdate consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: datasetId description: Id of the dataset resource. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: dataset description: Dataset resource payload to create or update. required: true schema: $ref: '#/definitions/Dataset_2' responses: '200': description: Success schema: $ref: '#/definitions/Dataset_2' '201': description: Created schema: $ref: '#/definitions/Dataset_2' default: description: Error schema: $ref: '#/definitions/ErrorResponse_2' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-examples: Datasets_CreateOrUpdate: $ref: ./examples/Datasets_CreateOrUpdate.json summary: Microsoft Azure Patch Datasets Datasetid /datasets/operations/{operationId}: get: description: This API allows the caller to view the current progress of a dataset operation and the path is obtained from a call to the Create API.

### Submit Operations Request

To view the current progress of a dataset operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.

### Operation Response

While in progress, a `200-OK` http status code will be returned with no extra headers. If the operation succeeds, a `200-OK` http status code with Resource-Location header will be returned. operationId: microsoftAzureDatasetGetoperation x-ms-examples: Get the status of an operation which is still running: $ref: ./examples/GetOperationStillRunning.json Get the status of an operation which has finished successfully: $ref: ./examples/GetOperation.json parameters: - $ref: '#/parameters/SubscriptionKey' - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/DatasetOperationId' responses: '200': $ref: '#/responses/200Async' '400': $ref: '#/responses/400' summary: Microsoft Azure Get Datasets Operations Operationid tags: - Datasets /datasets/{name}: put: tags: - Datasets summary: "Microsoft Azure Register A New Dataset \r\n \r\nstatus Codes Returned:\r\n 201: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 409: A Dataset With The Specified Name Already Exists" operationId: microsoftAzureDatasetsRegister consumes: - application/json-patch+json produces: - application/json parameters: - in: path name: name description: A name that can be used to uniquely identify the dataset after it has been registered. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - $ref: '#/parameters/ApiVersion_2' - in: body name: body description: Properties for the dataset, such as the list of URIs to the annotation files. required: true schema: $ref: '#/definitions/Dataset' responses: '201': description: Created schema: $ref: '#/definitions/Dataset' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-examples: RegisterDataset_ImageClassification: $ref: ./examples/RegisterDataset_ImageClassification.json description: Needs a more full description created. get: tags: - Datasets summary: "Microsoft Azure Get Information About A Specific Dataset \r\n \r\nstatus Codes Returned:\r\n 200: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Dataset With The Specified Name Was Not Found" operationId: microsoftAzureDatasetsGet produces: - application/json parameters: - in: path name: name description: The name of the dataset to get. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - $ref: '#/parameters/ApiVersion_2' responses: '200': description: Success schema: $ref: '#/definitions/Dataset' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-examples: Datasets_Get: $ref: ./examples/Datasets_Get.json description: Needs a more full description created. patch: tags: - Datasets summary: "Microsoft Azure Update The Properties Of An Existing Dataset \r\n \r\nstatus Codes Returned:\r\n 200: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Dataset With The Specified Name Was Not Found \r\n 412: An If Match Header Was Provided, But The Given Etag Did Not Match The Current Etag Value" operationId: microsoftAzureDatasetsUpdate consumes: - application/json-patch+json produces: - application/json parameters: - in: path name: name description: The name of the dataset to update. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - in: header name: If-Match description: "Optional ETag for the dataset to update.
\r\nIf an ETag is provided, then the dataset will be updated only if its current ETag value matches the given ETag.\r\nIf the ETag values don't match, then the update operation will fail with status code 412 (Precondition Failed).\r\nThis indicates that the dataset has been updated since the last time information for the dataset was obtained.
\r\nIf an ETag is not provided or its value is '*', then the dataset will always be updated regardless of the current ETag value." type: string - $ref: '#/parameters/ApiVersion_2' - in: body name: body description: Properties to update on the existing dataset. required: true schema: $ref: '#/definitions/Dataset' responses: '200': description: Success schema: $ref: '#/definitions/Dataset' default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-examples: Datasets_Update: $ref: ./examples/Datasets_Update.json description: Needs a more full description created. delete: tags: - Datasets summary: "Microsoft Azure Unregister A Dataset \r\n \r\nstatus Codes Returned:\r\n 204: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Dataset With The Specified Name Was Not Found \r\n 412: An If Match Header Was Provided, But The Given Etag Did Not Match The Current Etag Value" operationId: microsoftAzureDatasetsUnregister produces: - application/json parameters: - in: path name: name description: The name of the dataset to unregister. required: true type: string maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ - in: header name: If-Match description: "Optional ETag for the dataset to unregister.
\r\nIf an ETag is provided, then the dataset will be unregistered only if its current ETag value matches the given ETag.\r\nIf the ETag values don't match, then the unregister operation will fail with status code 412 (Precondition Failed).\r\nThis indicates that the dataset has been updated since the last time information for the dataset was obtained.
\r\nIf an ETag is not provided or its value is '*', then the dataset will always be unregistered regardless of the current ETag value." type: string - $ref: '#/parameters/ApiVersion_2' responses: '204': description: No Content default: description: Error schema: $ref: '#/definitions/ErrorResponse' headers: x-ms-error-code: type: string x-ms-examples: Datasets_Unregister: $ref: ./examples/Datasets_Unregister.json description: Needs a more full description created. /datasets/{datasetId}/access: get: tags: - Datasets description: Dataset access list. operationId: microsoftAzureDatasetsListauthorizedaccess produces: - application/json parameters: - in: path name: datasetId description: Id of dataset to be accessed. required: true type: string - in: query name: subscriptionIds description: Subscription Ids. type: array items: type: string collectionFormat: multi - in: query name: resourceIds description: Resource Ids. type: array items: type: string collectionFormat: multi - 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 - in: query name: api-version description: The requested API version required: true type: string responses: '200': description: Success schema: $ref: '#/definitions/DatasetAccessListResponse' default: description: Error schema: $ref: '#/definitions/ErrorResponse_2' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-pageable: nextLinkName: nextLink x-ms-examples: Datasets_ListAuthorizedAccess: $ref: ./examples/Datasets_ListAuthorizedAccess.json summary: Microsoft Azure Get Datasets Datasetid Access /datasets/{datasetId}/access:grant: post: tags: - Datasets description: Dataset access grant. operationId: microsoftAzureDatasetsAuthorizeaccess consumes: - application/json produces: - application/json parameters: - in: path name: datasetId description: Id of dataset to be accessed. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: datasetAccess description: Dataset access details. required: true schema: $ref: '#/definitions/DatasetAccess' responses: '200': description: Success schema: $ref: '#/definitions/DatasetAccess' default: description: Error schema: $ref: '#/definitions/ErrorResponse_2' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-examples: Datasets_AuthorizeAccess: $ref: ./examples/Datasets_AuthorizeAccess.json summary: Microsoft Azure Post Datasets Datasetid Access:grant /datasets/{datasetId}/access:remove: post: tags: - Datasets description: Dataset access remove. operationId: microsoftAzureDatasetsRemoveaccess consumes: - application/json produces: - application/json parameters: - in: path name: datasetId description: Id of dataset to be accessed. required: true type: string - in: query name: api-version description: The requested API version required: true type: string - in: body name: datasetAccess description: Dataset access details. required: true schema: $ref: '#/definitions/DatasetAccess' responses: '204': description: No Content default: description: Error schema: $ref: '#/definitions/ErrorResponse_2' headers: x-ms-error-code: type: string x-ms-client-name: ErrorCode x-ms-error-response: true x-ms-examples: Datasets_RemoveAccess: $ref: ./examples/Datasets_RemoveAccess.json summary: Microsoft Azure Post Datasets Datasetid Access:remove ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsDataProcessor/instances/{instanceName}/datasets : get: operationId: microsoftAzureDatasetsListbyinstance tags: - Datasets description: List Dataset resources by Instance 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: instanceName in: path description: Name of instance. 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/DatasetListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Datasets_ListByInstance - generated by [MaximumSet] rule: $ref: ./examples/Datasets_ListByInstance_MaximumSet_Gen.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsdataprocessor Instances Instancename Datasets ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsDataProcessor/instances/{instanceName}/datasets/{datasetName} : get: operationId: microsoftAzureDatasetsGet tags: - Datasets description: Get a Dataset 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: instanceName in: path description: Name of instance. required: true type: string pattern: ^[a-z0-9][a-z0-9-]{1,60}[a-z0-9]$ - name: datasetName in: path description: Name of dataset. 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/Dataset_3' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Datasets_Get - generated by [MaximumSet] rule: $ref: ./examples/Datasets_Get_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsdataprocessor Instances Instancename Datasets Datasetname put: operationId: microsoftAzureDatasetsCreateorupdate tags: - Datasets description: Create a Dataset 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: instanceName in: path description: Name of instance. required: true type: string pattern: ^[a-z0-9][a-z0-9-]{1,60}[a-z0-9]$ - name: datasetName in: path description: Name of dataset. 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/Dataset_3' responses: '200': description: Resource 'Dataset' update operation succeeded schema: $ref: '#/definitions/Dataset_3' '201': description: Resource 'Dataset' create operation succeeded schema: $ref: '#/definitions/Dataset_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: Datasets create or update - generated by [MaximumSet] rule: $ref: ./examples/Datasets_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 Iotoperationsdataprocessor Instances Instancename Datasets Datasetname patch: operationId: microsoftAzureDatasetsUpdate tags: - Datasets description: Update a Dataset 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: instanceName in: path description: Name of instance. required: true type: string pattern: ^[a-z0-9][a-z0-9-]{1,60}[a-z0-9]$ - name: datasetName in: path description: Name of dataset. 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/DatasetTagsUpdate' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/Dataset_3' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Datasets_Update - generated by [MaximumSet] rule: $ref: ./examples/Datasets_Update_MaximumSet_Gen.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsdataprocessor Instances Instancename Datasets Datasetname delete: operationId: microsoftAzureDatasetsDelete tags: - Datasets description: Delete a Dataset 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: instanceName in: path description: Name of instance. required: true type: string pattern: ^[a-z0-9][a-z0-9-]{1,60}[a-z0-9]$ - name: datasetName in: path description: Name of dataset. 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: Datasets_Delete - generated by [MaximumSet] rule: $ref: ./examples/Datasets_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 Iotoperationsdataprocessor Instances Instancename Datasets Datasetname definitions: DatasetAccess: description: DatasetAccess object. type: object properties: subscriptionId: description: Subscription Id. maxLength: 100 minLength: 2 type: string resourceId: description: Azure Data Manager for Agriculture resource Id. maxLength: 200 minLength: 2 type: string createdDateTime: format: date-time description: 'Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string readOnly: true example: '2020-12-31T11:10:21Z' modifiedDateTime: format: date-time description: 'Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string readOnly: true example: '2020-12-31T11:10:21Z' createdBy: description: Created by user/tenant id. type: string readOnly: true modifiedBy: description: Modified by user/tenant id. type: string readOnly: 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 DatasetListResult: type: object description: The response of a Dataset list operation. properties: value: type: array description: The Dataset items on this page items: $ref: '#/definitions/Dataset_3' nextLink: type: string format: uri description: The link to the next page of items required: - value ErrorResponse_2: description: An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document. type: object properties: error: $ref: '#/definitions/Error' traceId: description: Unique trace Id. type: string DatasetTagsUpdate: type: object description: The type used for updating tags in Dataset resources. properties: tags: type: object description: Resource tags. additionalProperties: type: string InnerError: description: Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document. type: object properties: code: description: Specific error code than was provided by the containing error. type: string innererror: $ref: '#/definitions/InnerError' DatasetProperties: type: object description: The properties of a Dataset resource. properties: description: type: string description: Detailed description of the Dataset. payload: type: string description: Path to the payload in the message. Enrich will add only the payload to the enriched message, other fields will not be kept except for in the indexes. timestamp: type: string description: Path to an RFC3339 timestamp in the message. If no path is provided, the ingestion time of the record is used for time-based joins. ttl: type: string description: Time to live for individual records. keys: type: object description: List of keys that can be used for joining on enrich. additionalProperties: $ref: '#/definitions/DatasetPropertyKey' provisioningState: $ref: '#/definitions/ProvisioningState' description: The status of the last operation. readOnly: true Dataset_2: description: Schema of dataset resource. type: object properties: type: description: 'Type of the dataset. Supported types: Crop, CropProduct, ChemicalProduct, Equipment.' enum: - Crop - CropProduct - ChemicalProduct - FarmEquipment type: string x-ms-enum: name: DatasetType modelAsString: true recordsSchema: description: Schema for records under the dataset. type: object additionalProperties: {} solutionId: description: Solution id of the dataset solution. type: string readOnly: true id: description: Unique resource ID. type: string readOnly: true eTag: description: The ETag value to implement optimistic concurrency. type: string readOnly: true status: description: Status of the resource. maxLength: 100 minLength: 0 type: string createdDateTime: format: date-time description: 'Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string readOnly: true example: '2020-12-31T11:10:21Z' modifiedDateTime: format: date-time description: 'Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.' type: string readOnly: true example: '2020-12-31T11:10:21Z' source: description: Source of the resource. maxLength: 100 minLength: 2 type: string name: description: Name to identify resource. maxLength: 100 minLength: 0 type: string description: description: Textual description of the resource. maxLength: 500 minLength: 0 type: string createdBy: description: Created by user/tenant id. type: string readOnly: true modifiedBy: description: Modified by user/tenant id. type: string readOnly: true properties: description: "A collection of key value pairs that belongs to the resource.\r\nEach pair must not have a key greater than 50 characters\r\nand must not have a value greater than 150 characters.\r\nNote: A maximum of 25 key value pairs can be provided for a resource and only string,\r\nnumeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported." type: object additionalProperties: {} example: key1: value1 key2: 123.45 StorageAuthenticationSettingsApiModel: description: Describes the storage authentication settings. required: - kind type: object properties: kind: description: The storage authentication kind. enum: - none - managedIdentity - sas type: string x-ms-enum: name: StorageAuthenticationKind modelAsString: true sasToken: description: Optional. The sas token to access container. Only needed when Kind = Sas. type: string ODataErrorResponse: type: object description: This response object is returned when an error occurs in the Azure Maps API. properties: error: $ref: '#/definitions/ODataError' DatasetListResponse: description: The response model for the Dataset List API. The response body will contain a list of all the previously created datasets. type: object properties: datasets: description: A list of all the previously created datasets. type: array readOnly: true items: $ref: '#/definitions/DatasetDetailInfo' nextLink: description: If present, the location of the next page of data. type: string readOnly: true ErrorResponseInnerError: description: Detailed error. required: - code - message type: object properties: code: description: Error code. type: string message: description: Error message. type: string innererror: $ref: '#/definitions/ErrorResponseInnerError' DatasetPropertyKey: type: object description: Key that can be used for joining on enrich. properties: path: type: string description: Path to the input value from the message. primaryKey: type: boolean description: If true the property will be used as a primary key. At most one primary key can exists. required: - path DatasetAccessListResponse: description: Paged response contains list of requested objects and a skipToken to get the next set of results. required: - value type: object properties: value: description: List of requested objects. type: array items: $ref: '#/definitions/DatasetAccess' 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 Error: description: An error from the Azure AgPlatform service. required: - code - message type: object properties: code: description: Server-defined set of error codes. minLength: 1 type: string message: description: Human-readable representation of the error. minLength: 1 type: string target: description: Target of the error. type: string details: description: Array of details about specific errors that led to this reported error. type: array items: $ref: '#/definitions/Error' innererror: $ref: '#/definitions/InnerError' ErrorResponse: description: Response returned when an error occurs. required: - error type: object properties: error: $ref: '#/definitions/ErrorResponseDetails' ErrorResponseDetails: description: Error info. required: - code - message type: object properties: code: description: Error code. type: string message: description: Error message. type: string target: description: Target of the error. type: string details: description: List of detailed errors. type: array items: $ref: '#/definitions/ErrorResponseDetails' innererror: $ref: '#/definitions/ErrorResponseInnerError' ProvisioningState: type: string description: The provisioning status of the resource. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted x-ms-enum: name: ProvisioningState 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. - name: Provisioning value: Provisioning description: The resource is being created. - name: Updating value: Updating description: The resource is being updated. - name: Deleting value: Deleting description: The resource is being deleted. - name: Accepted value: Accepted description: The resource was accepted by the server. DatasetSources: description: Information about the details of the create request for the dataset. type: object properties: conversionIds: description: The list of `conversionId` that were used to create the dataset. type: array readOnly: true items: type: string appendDatasetId: description: The dataset that was appended to to create the current dataset. type: string readOnly: true Dataset: description: Describes a dataset, which represents a set of images and annotations that can be used for training or testing a model. type: object properties: annotationKind: description: "The kind of annotations contained in the annotation files.\r\nFor example, \"ImageClassification\" to specify that the annotation file contain object labels for training or testing a multiclass image classification model." enum: - imageClassification - imageObjectDetection type: string x-ms-enum: name: AnnotationKind modelAsString: true annotationFileUris: description: "List of absolute URIs to annotation files, each of which must be stored as a blob in an Azure Storage blob container.\r\nEach file must follow the COCO format for the specified AnnotationKind, with each image path being an absolute URI to a blob in a blob container.\r\nThe Computer Vision resource must have permission to read the annotation files and all referenced image files.\r\nThis can be done by turning on System managed identities for the Computer Vision resource, then assigning the identity to a role that has permission to read from the blob container containing the annotation and image files." maxItems: 10 type: array items: format: uri type: string customProperties: description: Dictionary of arbitrary key-value pairs for use by the application. A maximum of 10 key-value pairs are allowed. maxLength: 10 type: object additionalProperties: type: string name: description: Read only. The name that is used to uniquely identify the dataset. maxLength: 255 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$ type: string createdDateTime: format: date-time description: Read only. The date and time when the dataset was first registered, in UTC. type: string updatedDateTime: format: date-time description: Read only. The date and time when the dataset was last updated, in UTC. type: string eTag: description: Read only. The latest ETag for the dataset. May be used with the 'If-Match' header when updating or deleting a dataset. type: string authentication: $ref: '#/definitions/StorageAuthenticationSettingsApiModel' LongRunningOperationResult: description: The response model for a Long-Running Operations API. type: object properties: operationId: description: The Id for this long-running operation. type: string status: description: The status state of the request. type: string enum: - NotStarted - Running - Failed - Succeeded x-ms-enum: name: type modelAsString: true values: - value: NotStarted description: The request has not started processing yet. - value: Running description: The request has started processing. - value: Failed description: The request has one or more failures. - value: Succeeded description: The request has successfully completed. readOnly: true created: description: The created timestamp. type: string readOnly: true error: $ref: '#/definitions/ODataError' warning: $ref: '#/definitions/ODataError' ODataError: type: object description: This object is returned when an error occurs in the Azure Maps API. properties: code: type: string readOnly: true description: The ODataError code. message: type: string readOnly: true description: If available, a human-readable description of the error. details: type: array items: $ref: '#/definitions/ODataError' target: type: string readOnly: true description: If available, the target causing the error. DatasetDetailInfo: description: Detail information for the dataset. type: object properties: created: description: The created timestamp for the dataset. type: string readOnly: true datasetId: description: The id for the dataset. type: string readOnly: true ontology: description: The ontology version of this dataset. type: string readOnly: true description: description: The description for the dataset. type: string readOnly: true datasetSources: $ref: '#/definitions/DatasetSources' featureCounts: description: The feature counts for the dataset. type: object readOnly: true Dataset_3: type: object description: A Dataset resource belonging to an Instance resource. properties: properties: $ref: '#/definitions/DatasetProperties' 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 parameters: DatasetId: name: datasetId type: string in: path description: The identifier for the dataset to query from. required: true x-ms-parameter-location: method DatasetOperationId: name: operationId type: string in: path description: The ID to query the status for the dataset create/import request. required: true x-ms-parameter-location: method SubscriptionKey: name: subscription-key description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. type: string in: query required: false x-ms-parameter-location: client DescriptionDataset: name: description description: The description to be given to the dataset. type: string in: query required: false x-ms-parameter-location: method ApiVersion: name: api-version description: Version number of Azure Maps API. Current version is 2.0 type: string in: query required: true default: '2.0' x-ms-parameter-location: client ApiVersion_2: in: query name: api-version description: Requested API version. required: true type: string x-ms-parameter-location: client ConversionIdQuery: name: conversionId description: The unique ID used to create the dataset. The `conversionId` must have been obtained from a successful call to the Conversion Service [Convert API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert) and may be provided with multiple query parameters with same name (if more than one is provided). type: string in: query required: true x-ms-parameter-location: method AppendDatasetId: name: datasetId type: string in: query description: The ID for the dataset to append with. The dataset must originate from a previous dataset creation call that matches the datasetId required: false x-ms-parameter-location: method responses: '500': description: An error occurred while processing the request. Please try again later. schema: $ref: '#/definitions/ODataErrorResponse' 200Async: description: The operation is running or complete. If the operation was successful, use the Resource-Location header to obtain the path to the result. schema: $ref: '#/definitions/LongRunningOperationResult' headers: Resource-Location: type: string description: If successful, a URI where details on the newly created resource can be found. 202Accepted: description: 'Request Accepted: The request has been accepted for processing. Please use the URL in the Operation-Location Header to obtain status.' headers: Operation-Location: type: string description: New URL to check for the results of the [long-running operation](https://aka.ms/am-creator-lrt-v2). '404': description: 'Not Found: the requested resource could not be found, but it may be available again in the future.' schema: $ref: '#/definitions/ODataErrorResponse' '401': description: Access denied due to invalid subscription key or invalid Microsoft Entra ID bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Microsoft Entra ID bearer token. schema: $ref: '#/definitions/ODataErrorResponse' headers: WWW-Authenticate: type: string description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" '400': description: 'Bad request: one or more parameters were incorrectly specified or are mutually exclusive.' schema: $ref: '#/definitions/ODataErrorResponse' '403': description: Permission, capacity, or authentication issues. schema: $ref: '#/definitions/ODataErrorResponse' x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'