diff --git a/specification/maps/data-plane/Creator/preview/2.0/alias.json b/specification/maps/data-plane/Creator/preview/2.0/alias.json index d18b32e962d3..0f400b72c3be 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/alias.json +++ b/specification/maps/data-plane/Creator/preview/2.0/alias.json @@ -95,7 +95,7 @@ "/aliases": { "post": { "summary": "Use to create an alias.", - "description": "\n\nThe `Create` API is an HTTP `POST` request that allows the caller to create an alias and optionally assign it to a resource. An alias can reference an ID generated by a creator service, but cannot reference another alias ID.\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response with the alias resource in the body.\n\nA sample response from creating an alias:\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Create` API is an HTTP `POST` request that allows the caller to create an alias and optionally assign it to a resource. An alias can reference an ID generated by a creator service, but cannot reference another alias ID.\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response with the alias resource in the body.\n\nA sample response from creating an alias:\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", "operationId": "Alias_Create", "x-ms-examples": { "Create an alias that does not reference any resource": { @@ -133,7 +133,7 @@ }, "get": { "summary": "Use to get a list of aliases.", - "description": "\n\nThe `List` API is an HTTP `GET` request that allows the caller to fetch a list of all existing aliases.\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ\n\nA sample response returning 2 alias resources:\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33.123Z\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"creatorDataItemId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33.123Z\"\n }\n ]\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `List` API is an HTTP `GET` request that allows the caller to fetch a list of all existing aliases.\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ\n\nA sample response returning 2 alias resources:\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33.123Z\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"creatorDataItemId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33.123Z\"\n }\n ]\n}\n```", "operationId": "Alias_List", "x-ms-examples": { "List all the previously created aliases": { @@ -168,7 +168,7 @@ "/aliases/{aliasId}": { "put": { "summary": "Use to assign an alias as a reference to a resource.", - "description": "\n\nThe `Assign` API is an HTTP `PUT` request used to assign an alias as a reference to a resource.\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter.\n\n### Assign Alias Response\n\nThe Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Assign` API is an HTTP `PUT` request used to assign an alias as a reference to a resource.\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter.\n\n### Assign Alias Response\n\nThe Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", "operationId": "Alias_Assign", "x-ms-examples": { "Assign an alias to a resource": { @@ -203,7 +203,7 @@ }, "delete": { "summary": "Use to delete an alias.", - "description": "\n\nThe `Delete` API is an HTTP `DELETE` request that is used to delete the specified alias. Note that only the alias is deleted, not the resource it references.\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Delete` API is an HTTP `DELETE` request that is used to delete the specified alias. Note that only the alias is deleted, not the resource it references.\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.", "operationId": "Alias_Delete", "x-ms-examples": { "Delete previously created alias": { @@ -232,7 +232,7 @@ }, "get": { "summary": "Use to get details of an alias.", - "description": "\n\nThe `Get` API is an HTTP `GET` request that allows the caller to fetch the details of an existing alias.\n\n### Submit Get Details Request\n\nTo get the details of your alias, you will issue a `GET` request with the `aliasId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource:\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\nHere's a sample response:\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get` API is an HTTP `GET` request that allows the caller to fetch the details of an existing alias.\n\n### Submit Get Details Request\n\nTo get the details of your alias, you will issue a `GET` request with the `aliasId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource:\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\nHere's a sample response:\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", "operationId": "Alias_Get", "x-ms-examples": { "Get a previously created alias": { diff --git a/specification/maps/data-plane/Creator/preview/2.0/dataset.json b/specification/maps/data-plane/Creator/preview/2.0/dataset.json index 4c0e91eb141b..67e688159f16 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/dataset.json +++ b/specification/maps/data-plane/Creator/preview/2.0/dataset.json @@ -110,7 +110,7 @@ "/datasets": { "post": { "summary": "Use to create a dataset.", - "description": "\n\nThe `Create` API is an HTTP `POST` request that takes the `conversionId` value of the converted drawing package and returns the `datasetId` property of the newly created dataset. For more information, see [Create a dataset](/azure/azure-maps/tutorial-creator-indoor-maps#create-a-dataset).\n\nYou can use this request in a scenario like uploading a DWG zip package for a building, converting the zip package using the Azure Maps [Conversion](/rest/api/maps-creator/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](/rest/api/maps-creator/tileset) service and can be queried via the Azure Maps [WFS](/rest/api/maps-creator/wfs) service.\n\n### Submit Create Request\n\nTo 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 is 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).\n\nThe Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Create` API is an HTTP `POST` request that takes the `conversionId` value of the converted drawing package and returns the `datasetId` property of the newly created dataset. For more information, see [Create a dataset](/azure/azure-maps/tutorial-creator-indoor-maps#create-a-dataset).\n\nYou can use this request in a scenario like uploading a DWG zip package for a building, converting the zip package using the Azure Maps [Conversion](/rest/api/maps-creator/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](/rest/api/maps-creator/tileset) service and can be queried via the Azure Maps [WFS](/rest/api/maps-creator/wfs) service.\n\n### Submit Create Request\n\nTo 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 is 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).\n\nThe Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", "operationId": "Dataset_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -152,7 +152,7 @@ }, "get": { "summary": "Use to fetch a list of all existing datasets.", - "description": "\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe 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):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `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):\n\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 3 dataset resources:\n\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ], },\n \"\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53.123Z\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n ]\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe 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):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `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):\n\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 3 dataset resources:\n\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ], },\n \"\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53.123Z\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n ]\n}\n```", "operationId": "Dataset_List", "x-ms-examples": { "List all the previously created datasets": { @@ -187,7 +187,7 @@ "/datasets/{datasetId}": { "get": { "summary": "Use to get the details of a dataset.", - "description": "\n### Submit Get Details Request\n\nTo get the details for a previously created dataset, you will issue a `GET` request with the `datasetId` in the path.\n\n### Get Details Response\n\nThe 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):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `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):\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:\n\n```json\n{\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Get Details Request\n\nTo get the details for a previously created dataset, you will issue a `GET` request with the `datasetId` in the path.\n\n### Get Details Response\n\nThe 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):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `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):\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:\n\n```json\n{\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n```", "operationId": "Dataset_Get", "x-ms-examples": { "Get details for a previously created dataset": { @@ -219,7 +219,7 @@ }, "delete": { "summary": "Use to delete the specified dataset.", - "description": "\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.", "operationId": "Dataset_Delete", "x-ms-examples": { "Delete previously created dataset": { @@ -250,7 +250,7 @@ "/datasets/operations/{operationId}": { "get": { "summary": "Use to check the status of the dataset creation process.", - "description": "\n\nThe `Get Operation` API is an HTTP `GET` request used to check the status of the dataset creation process and retrieve the `datasetId` value.\n\n### Submit Operations Request\n\nTo 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.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` http status code with Resource-Location header is returned.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Operation` API is an HTTP `GET` request used to check the status of the dataset creation process and retrieve the `datasetId` value.\n\n### Submit Operations Request\n\nTo 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.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` http status code with Resource-Location header is returned.", "operationId": "Dataset_GetOperation", "x-ms-examples": { "Get the status of an operation which is still running": { diff --git a/specification/maps/data-plane/Creator/preview/2.0/dwgconversion.json b/specification/maps/data-plane/Creator/preview/2.0/dwgconversion.json index 38fbbe7ab1c2..0e66a2d4e131 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/dwgconversion.json +++ b/specification/maps/data-plane/Creator/preview/2.0/dwgconversion.json @@ -125,7 +125,7 @@ "/conversions": { "post": { "summary": "Use to convert a previously imported [Drawing Package](https://aka.ms/am-drawing-package) into map data.", - "description": "\n\n The `Conversion` API is an HTTP `POST` request that allows the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The drawing package is referenced by the `udid` used when it was uploaded into the [Data Registry](/rest/api/maps/data). For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running operation](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n The `Conversion` API is an HTTP `POST` request that allows the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The drawing package is referenced by the `udid` used when it was uploaded into the [Data Registry](/rest/api/maps/data). For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running operation](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", "operationId": "Conversion_Convert", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -167,7 +167,7 @@ }, "get": { "summary": "Use to get a list of data conversions.", - "description": "\n\nThe `List` API is an HTTP `GET` request that allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](/rest/api/maps-creator/conversion).\n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `List` API is an HTTP `GET` request that allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](/rest/api/maps-creator/conversion).\n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
", "operationId": "Conversion_List", "x-ms-examples": { "Returns a list of all the data processed by the Conversion Service for the account": { @@ -202,7 +202,7 @@ "/conversions/{conversionId}": { "get": { "summary": "Use to fetch the specified data conversion.", - "description": "\n\n The `Get` API is an HTTP `GET` request that allows the caller to fetch a successful data conversion previously submitted using the [Conversion Service](/rest/api/maps-creator/conversion/convert).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n The `Get` API is an HTTP `GET` request that allows the caller to fetch a successful data conversion previously submitted using the [Conversion Service](/rest/api/maps-creator/conversion/convert).", "operationId": "Conversion_Get", "x-ms-examples": { "Get the details for one conversion operation": { @@ -234,7 +234,7 @@ }, "delete": { "summary": "Use to delete the specified data conversion.", - "description": "\n\nThe `Delete` API is an HTTP `DELETE` request that allows the caller to delete any data conversions previously created using the [Conversion API](/rest/api/maps-creator/conversion/convert).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Delete` API is an HTTP `DELETE` request that allows the caller to delete any data conversions previously created using the [Conversion API](/rest/api/maps-creator/conversion/convert).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", "operationId": "Conversion_Delete", "x-ms-examples": { "Delete previously converted content": { @@ -265,7 +265,7 @@ "/conversions/operations/{operationId}": { "get": { "summary": "Use to check the status of a conversion process.", - "description": "\n\nThe `Get Operation` API is an HTTP `GET` request that allows the caller to check the status of a [conversion](/rest/api/maps-creator/conversion/convert) process and retrieve the `conversionId` value.\n\nThis path will be obtained from a call to POST /conversions. While in progress, an HTTP 200 response code will be returned with no extra headers - followed by an HTTP 200 response code with a `Resource-Location` header once successfully completed.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Operation` API is an HTTP `GET` request that allows the caller to check the status of a [conversion](/rest/api/maps-creator/conversion/convert) process and retrieve the `conversionId` value.\n\nThis path will be obtained from a call to POST /conversions. While in progress, an HTTP 200 response code will be returned with no extra headers - followed by an HTTP 200 response code with a `Resource-Location` header once successfully completed.", "operationId": "Conversion_GetOperation", "x-ms-examples": { "Get the status of an operation which is still running": { diff --git a/specification/maps/data-plane/Creator/preview/2.0/featurestate.json b/specification/maps/data-plane/Creator/preview/2.0/featurestate.json index e2fdc5f83979..4b31d74653e2 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/featurestate.json +++ b/specification/maps/data-plane/Creator/preview/2.0/featurestate.json @@ -129,7 +129,7 @@ "/featureStateSets": { "post": { "summary": "Use to create a new stateset.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\nThe `Create Stateset` API is an HTTP `POST` request used to create a new stateset, defining the values and corresponding styles for its properties in the body of the request. For more information, see [Create a feature stateset](/azure/azure-maps/how-to-creator-feature-stateset).\n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the stateset. Like tileset, stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that `statesetId` to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. For more information, see the Render services [Get Map State Tile](/rest/api/maps/render/get-map-state-tile).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Create Stateset` API is an HTTP `POST` request used to create a new stateset, defining the values and corresponding styles for its properties in the body of the request. For more information, see [Create a feature stateset](/azure/azure-maps/how-to-creator-feature-stateset).\n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the stateset. Like tileset, stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that `statesetId` to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. For more information, see the Render services [Get Map State Tile](/rest/api/maps/render/get-map-state-tile).", "operationId": "FeatureState_CreateStateset", "x-ms-examples": { "Create a new stateset with a datasetId": { @@ -173,7 +173,7 @@ }, "get": { "summary": "Use to get a list of statesets.", - "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\nSubmit List Statesets Request \n\nThe `List Statesets` API is an HTTP `GET` request used to return a list of existing statesets.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nSubmit List Statesets Request \n\nThe `List Statesets` API is an HTTP `GET` request used to return a list of existing statesets.", "operationId": "FeatureState_ListStatesets", "x-ms-examples": { "List all the previously created statesets": { @@ -208,7 +208,7 @@ "/featureStateSets/{statesetId}": { "put": { "summary": "Use to update the stateset style rules.", - "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\nSubmit Update Stateset Request \n\nThe `Update Stateset` API is an HTTP `PUT` request used to update the stateset style rules of the specified stateset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nSubmit Update Stateset Request \n\nThe `Update Stateset` API is an HTTP `PUT` request used to update the stateset style rules of the specified stateset.", "operationId": "FeatureState_UpdateStateset", "x-ms-examples": { "Update stateset style rules with a statesetId": { @@ -246,7 +246,7 @@ }, "delete": { "summary": "Use to delete a stateset and its associated data.", - "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\nSubmit Delete Request \n\nThe `Delete Stateset` API is an HTTP `DELETE` request used to delete the specified stateset and its associated data.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nSubmit Delete Request \n\nThe `Delete Stateset` API is an HTTP `DELETE` request used to delete the specified stateset and its associated data.", "operationId": "FeatureState_DeleteStateset", "x-ms-examples": { "Delete an existing stateset": { @@ -275,7 +275,7 @@ }, "get": { "summary": "Use to retrieve stateset information.", - "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\nThe `Get Stateset` API is an HTTP `GET` request used to retrieve the specified stateset information, including the `datasetId` associated to the stateset, and its styles.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Stateset` API is an HTTP `GET` request used to retrieve the specified stateset information, including the `datasetId` associated to the stateset, and its styles.", "operationId": "FeatureState_GetStateset", "x-ms-examples": { "Get stateset information with a statesetId": { @@ -310,7 +310,7 @@ "put": { "operationId": "FeatureState_UpdateStates", "summary": "Use to update the state of a feature.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\n Submit Update States Request \n\n The `Update States` API is a `PUT` request that allows the user to update the state of the specified feature in a given stateset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n Submit Update States Request \n\n The `Update States` API is a `PUT` request that allows the user to update the state of the specified feature in a given stateset.", "x-ms-examples": { "Update the states of a feature": { "$ref": "./examples/featurestate/Featurestate_UpdateStates.json" @@ -351,7 +351,7 @@ "delete": { "operationId": "FeatureState_DeleteState", "summary": "Use to delete state information.", - "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\nThe `Delete State` API is an HTTP `DELETE` request is used to delete state information defined by the `stateKeyName` parameter for the specified feature as specified by the `featureId` parameter in the the stateset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Delete State` API is an HTTP `DELETE` request is used to delete state information defined by the `stateKeyName` parameter for the specified feature as specified by the `featureId` parameter in the the stateset.", "x-ms-examples": { "Delete the given feature state": { "$ref": "./examples/featurestate/Featurestate_DeleteFeatureState.json" @@ -386,7 +386,7 @@ "get": { "operationId": "FeatureState_ListStates", "summary": "Use to get the state information of a feature.", - "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator Feature State service retirement**\n>\n> The Azure Maps Creator [Feature State](/rest/api/maps-creator/feature-state) service is now deprecated and will be retired on 3/31/25. To avoid service disruptions, discontinue use of the Feature State services by 3/31/25. For information on real-time feature styling in Creator, see [Enhance your indoor maps with real-time map feature styling](https://techcommunity.microsoft.com/t5/azure-maps-blog/enhance-your-indoor-maps-with-real-time-map-feature-styling/ba-p/4048929).\n\n### Submit List States Request \n\n The `List States` API is an HTTP `GET` request used to return the current state information associated with the specified feature in a given stateset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit List States Request \n\n The `List States` API is an HTTP `GET` request used to return the current state information associated with the specified feature in a given stateset.", "x-ms-examples": { "Get the current states of a feature": { "$ref": "./examples/featurestate/Featurestate_ListStates.json" diff --git a/specification/maps/data-plane/Creator/preview/2.0/tileset.json b/specification/maps/data-plane/Creator/preview/2.0/tileset.json index b34a8d29410f..24207bf8838c 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2.0/tileset.json @@ -103,7 +103,7 @@ "/tilesets": { "post": { "summary": "Use to create a tileset.", - "description": "\n\n The `Create` API is an HTTP `POST` request is used to create a tileset from the specified dataset. For more information, see [Create a tileset](/azure/azure-maps/tutorial-creator-indoor-maps#create-a-tileset). A tileset contains a set of tiles that can be consumed using [Get Map Tile](/rest/api/maps/render/get-map-tile) to retrieve custom tiles. To create a dataset, use [Dataset Create](/rest/api/maps-creator/dataset/create). For an introduction to concepts and tools that apply to Azure Maps Creator, see [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps).\n\nThe Create Tileset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be used as the source of the tileset data.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n The `Create` API is an HTTP `POST` request is used to create a tileset from the specified dataset. For more information, see [Create a tileset](/azure/azure-maps/tutorial-creator-indoor-maps#create-a-tileset). A tileset contains a set of tiles that can be consumed using [Get Map Tile](/rest/api/maps/render/get-map-tile) to retrieve custom tiles. To create a dataset, use [Dataset Create](/rest/api/maps-creator/dataset/create). For an introduction to concepts and tools that apply to Azure Maps Creator, see [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps).\n\nThe Create Tileset API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be used as the source of the tileset data.", "operationId": "Tileset_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -142,7 +142,7 @@ }, "get": { "summary": "Use to get a list of tilesets.", - "description": "\n\n### Submit List Request\n\nThe `List` API is an HTTP `GET` request used to fetch a list of all existing tilesets.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit List Request\n\nThe `List` API is an HTTP `GET` request used to fetch a list of all existing tilesets.", "operationId": "Tileset_List", "x-ms-examples": { "Get a list of all tilesets": { @@ -177,6 +177,7 @@ "/tilesets/{tilesetId}": { "get": { "summary": "Use to fetch details of the specified tileset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).", "operationId": "Tileset_Get", "x-ms-examples": { "Gets the details for a single tileset": { @@ -208,7 +209,7 @@ }, "delete": { "summary": "Use to delete a tileset.", - "description": "\n\nn### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nn### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", "operationId": "Tileset_Delete", "x-ms-examples": { "Delete a created tileset": { @@ -239,7 +240,7 @@ "/tilesets/operations/{operationId}": { "get": { "summary": "Use to get the status of a tileset creation.", - "description": "\n\nThe `Get Operation` API is an HTTP `GET` request is used to check the status of the tileset creation process and retrieve the `tilesetId` value. The path is obtained from a call to [Tileset - Create](/rest/api/maps-creator/tilesets/create). While in progress, an HTTP 200 is returned with no extra headers. Once successfully completed an HTTP 200 is returned with a `Resource-Location` header. For more information, see [Check the status of tileset creation](/azure/azure-maps/tutorial-creator-indoor-maps#check-the-status-of-tileset-creation).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Operation` API is an HTTP `GET` request is used to check the status of the tileset creation process and retrieve the `tilesetId` value. The path is obtained from a call to [Tileset - Create](/rest/api/maps-creator/tilesets/create). While in progress, an HTTP 200 is returned with no extra headers. Once successfully completed an HTTP 200 is returned with a `Resource-Location` header. For more information, see [Check the status of tileset creation](/azure/azure-maps/tutorial-creator-indoor-maps#check-the-status-of-tileset-creation).", "operationId": "Tileset_GetOperation", "x-ms-examples": { "Get the status of an operation which is still running": { diff --git a/specification/maps/data-plane/Creator/preview/2.0/wfs.json b/specification/maps/data-plane/Creator/preview/2.0/wfs.json index 5f738e43f635..6791c89b61cb 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/wfs.json +++ b/specification/maps/data-plane/Creator/preview/2.0/wfs.json @@ -117,7 +117,7 @@ "/wfs/datasets/{datasetId}/": { "get": { "summary": "Use to get links to API definition, conformance statements and metadata about a feature collection.", - "description": "\n\nThe `Get Landing Page` API is an HTTP `GET` request that provides links to the API definition, conformance statements and metadata about the feature collections in the specified dataset. \n\nThe WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/azure/azure-maps/creator-indoor-maps#datasets). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\n### Submit Get Landing Page Request", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Landing Page` API is an HTTP `GET` request that provides links to the API definition, conformance statements and metadata about the feature collections in the specified dataset. \n\nThe WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/azure/azure-maps/creator-indoor-maps#datasets). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\n### Submit Get Landing Page Request", "operationId": "WFS_GetLandingPage", "x-ms-examples": { "GetLandingPage": { @@ -151,7 +151,7 @@ "/wfs/datasets/{datasetId}/conformance": { "get": { "summary": "Use to get a list of conformance requirements.", - "description": "\n\nThe `List Conformance` API provides a list of all requirements classes specified in the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) that the server conforms to. \n\nThe WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/azure/azure-maps/creator-indoor-maps#datasets). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\n### Submit List Conformance Request", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `List Conformance` API provides a list of all requirements classes specified in the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) that the server conforms to. \n\nThe WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/azure/azure-maps/creator-indoor-maps#datasets). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\n### Submit List Conformance Request", "operationId": "WFS_ListConformance", "x-ms-examples": { "GetConformance": { @@ -185,7 +185,7 @@ "/wfs/datasets/{datasetId}/collections": { "get": { "summary": "Use to get descriptions of all collections in a dataset.", - "description": "\n\nThe `Get Collections` API is an HTTP `GET` request that provides descriptions of all the collections in the specified dataset. \n\nThe WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/rest/api/maps-creator/dataset). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\nThe Collections Description API provides descriptions of all the collections in a given dataset. For more information, see [Web Feature service API](/azure/azure-maps/creator-indoor-maps#web-feature-service-api)\n\n### Submit Get Collections Request", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Collections` API is an HTTP `GET` request that provides descriptions of all the collections in the specified dataset. \n\nThe WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/rest/api/maps-creator/dataset). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\nThe Collections Description API provides descriptions of all the collections in a given dataset. For more information, see [Web Feature service API](/azure/azure-maps/creator-indoor-maps#web-feature-service-api)\n\n### Submit Get Collections Request", "operationId": "WFS_GetCollections", "x-ms-examples": { "GetCollections": { @@ -219,7 +219,7 @@ "/wfs/datasets/{datasetId}/collections/{collectionId}": { "get": { "summary": "Use to get the description of the specified collection.", - "description": "\n\nThe `Get Collection` API is an HTTP `GET` request that returns the description of the specified collection. It includes links to the operations that can be performed on the collection. \n\n The WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/azure/azure-maps/creator-indoor-maps#datasets). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\n The Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.\n\n### Submit Get Collection Request", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Collection` API is an HTTP `GET` request that returns the description of the specified collection. It includes links to the operations that can be performed on the collection. \n\n The WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/azure/azure-maps/creator-indoor-maps#datasets). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\n The Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.\n\n### Submit Get Collection Request", "operationId": "WFS_GetCollection", "x-ms-examples": { "GetCollection": { @@ -256,7 +256,7 @@ "/wfs/datasets/{datasetId}/collections/{collectionId}/definition": { "get": { "summary": "Use to get a detailed data model of a collection.", - "description": "\n\nThe `Get Collection Definition` API is an HTTP `GET` request that provides a detailed data model of the specified collection.\n\n The WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/rest/api/maps-creator/dataset). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\n###Submit Get Collection Definition Request", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Collection Definition` API is an HTTP `GET` request that provides a detailed data model of the specified collection.\n\n The WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/rest/api/maps-creator/dataset). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\n###Submit Get Collection Definition Request", "operationId": "WFS_GetCollectionDefinition", "x-ms-examples": { "GetCollectionDefinition": { @@ -293,7 +293,7 @@ "/wfs/datasets/{datasetId}/collections/{collectionId}/items": { "get": { "summary": "Use to get a detailed list of features of a collection.", - "description": "\n\nThe `Get Features` API is an HTTP `GET` request that returns a detailed list of features in the specified collection. \n\nThe WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/azure/azure-maps/creator-indoor-maps#datasets). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\n### Submit Get Features Request", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Features` API is an HTTP `GET` request that returns a detailed list of features in the specified collection. \n\nThe WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/azure/azure-maps/creator-indoor-maps#datasets). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\n### Submit Get Features Request", "operationId": "WFS_GetFeatures", "x-ms-examples": { "GetFeatures": { @@ -339,7 +339,7 @@ "/wfs/datasets/{datasetId}/collections/{collectionId}/items/{featureId}": { "get": { "summary": "Use to get details of a feature in a given collection.", - "description": "\n\nThe `Get Feature` API is an HTTP `GET` request that returns the details of the specified feature in a given collection. \n\nThe WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/azure/azure-maps/creator-indoor-maps#datasets). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\n### Submit Get Feature Request", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Feature` API is an HTTP `GET` request that returns the details of the specified feature in a given collection. \n\nThe WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/azure/azure-maps/creator-indoor-maps#datasets). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\n### Submit Get Feature Request", "operationId": "WFS_GetFeature", "x-ms-examples": { "GetFeature": { @@ -374,7 +374,7 @@ }, "delete": { "summary": "Use to delete a feature.", - "description": "\n\nThe `Delete Feature` API is an HTTP `DELETE` request used to delete a feature, along with all of its child features, in the specified feature collection. \n\n WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/azure/azure-maps/creator-indoor-maps#datasets). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features.\n\n### Submit Delete Feature Request", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Delete Feature` API is an HTTP `DELETE` request used to delete a feature, along with all of its child features, in the specified feature collection. \n\n WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](/azure/azure-maps/creator-indoor-maps#datasets). \n\nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features.\n\n### Submit Delete Feature Request", "operationId": "WFS_DeleteFeature", "x-ms-examples": { "DeleteFeature": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/alias.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/alias.json index c427b6b47b8b..e9ac5a963045 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/alias.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/alias.json @@ -94,7 +94,7 @@ "/aliases": { "post": { "summary": "Use to create an alias.", - "description": "\n\nThe `Create` API is an HTTP `POST` request that allows the caller to create an alias and optionally assign it to a resource. An alias can reference an ID generated by a creator service, but cannot reference another alias ID.\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response with the alias resource in the body.\n\nA sample response from creating an alias:\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Create` API is an HTTP `POST` request that allows the caller to create an alias and optionally assign it to a resource. An alias can reference an ID generated by a creator service, but cannot reference another alias ID.\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response with the alias resource in the body.\n\nA sample response from creating an alias:\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", "operationId": "Alias_Create", "x-ms-examples": { "Create an alias that does not reference any resource": { @@ -132,7 +132,7 @@ }, "get": { "summary": "Use to get a list of aliases.", - "description": "\n\nThe `List` API is an HTTP `GET` request that allows the caller to fetch a list of all existing aliases.\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ\n\nA sample response returning 2 alias resources:\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33.123Z\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"creatorDataItemId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33.123Z\"\n }\n ]\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `List` API is an HTTP `GET` request that allows the caller to fetch a list of all existing aliases.\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ\n\nA sample response returning 2 alias resources:\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33.123Z\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"creatorDataItemId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33.123Z\"\n }\n ]\n}\n```", "operationId": "Alias_List", "x-ms-examples": { "List all the previously created aliases": { @@ -167,7 +167,7 @@ "/aliases/{aliasId}": { "put": { "summary": "Use to assign an alias as a reference to a resource.", - "description": "\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter.\n\n### Assign Alias Response\n\nThe Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter.\n\n### Assign Alias Response\n\nThe Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", "operationId": "Alias_Assign", "x-ms-examples": { "Assign an alias to a resource": { @@ -202,7 +202,7 @@ }, "delete": { "summary": "Use to delete an alias.", - "description": "### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete. Note that only the alias is deleted, not the resource it references.\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete. Note that only the alias is deleted, not the resource it references.\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.", "operationId": "Alias_Delete", "x-ms-examples": { "Delete previously created alias": { @@ -231,7 +231,7 @@ }, "get": { "summary": "Use to get details of an alias.", - "description": "\n\n### Submit Get Details Request\n\nTo get the details of your alias, you will issue a `GET` request with the `aliasId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource:\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\nHere's a sample response:\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Get Details Request\n\nTo get the details of your alias, you will issue a `GET` request with the `aliasId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource:\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\nHere's a sample response:\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", "operationId": "Alias_Get", "x-ms-examples": { "Get a previously created alias": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dataset.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dataset.json index fbe1ec3d4233..fcc6db54e7b8 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dataset.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dataset.json @@ -132,7 +132,7 @@ "/datasets": { "post": { "summary": "Use to create a dataset.", - "description": "\n\nThe `Create` API is an HTTP `POST` request that allows the caller to create a dataset from data that was uploaded to the Azure Maps [Data Registry](/rest/api/maps/data) and converted using the Azure Maps [Conversion Service](/rest/api/maps-creator/conversion). You can also create a dataset directly using data uploaded to the Azure Maps [Data Registry](/rest/api/maps/data-registry), provided that the uploaded data is a zip of GeoJSON files conforming to the [facility ontology](/azure/azure-maps/creator-facility-ontology) format. For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\nFor more information, see [Create a dataset using a GeoJson package](https://aka.ms/howtofacilitygeojson)\n\n### Submit Create Request\n\nTo create your dataset, issue a `POST` request with the required parameters. The Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Create` API is an HTTP `POST` request that allows the caller to create a dataset from data that was uploaded to the Azure Maps [Data Registry](/rest/api/maps/data) and converted using the Azure Maps [Conversion Service](/rest/api/maps-creator/conversion). You can also create a dataset directly using data uploaded to the Azure Maps [Data Registry](/rest/api/maps/data-registry), provided that the uploaded data is a zip of GeoJSON files conforming to the [facility ontology](/azure/azure-maps/creator-facility-ontology) format. For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\nFor more information, see [Create a dataset using a GeoJson package](https://aka.ms/howtofacilitygeojson)\n\n### Submit Create Request\n\nTo create your dataset, issue a `POST` request with the required parameters. The Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).", "operationId": "Dataset_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -186,7 +186,7 @@ }, "get": { "summary": "Use to get a list of datasets.", - "description": "\n\n### Submit List Request\n\nTo list all your datasets, issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 2 dataset resources:\n\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"udids\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53.123Z\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"udids\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ]\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n ]\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit List Request\n\nTo list all your datasets, issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 2 dataset resources:\n\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"udids\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53.123Z\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"udids\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ]\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n ]\n}\n```", "operationId": "Dataset_List", "x-ms-examples": { "List all the previously created datasets": { @@ -221,7 +221,7 @@ "/datasets/{datasetId}": { "get": { "summary": "Use to get the details of a dataset.", - "description": "\n\n### Submit Get Details Request\n\nTo get the details for a previously created dataset, issue a `GET` request with the `datasetId` in the path.\n\n### Get Details Response\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:\n\n```json\n{\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"udids\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ]\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Get Details Request\n\nTo get the details for a previously created dataset, issue a `GET` request with the `datasetId` in the path.\n\n### Get Details Response\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:\n\n```json\n{\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"udids\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ]\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n```", "operationId": "Dataset_Get", "x-ms-examples": { "Get details for a previously created dataset": { @@ -253,7 +253,7 @@ }, "delete": { "summary": "Use to delete the specified dataset.", - "description": "\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.", "operationId": "Dataset_Delete", "x-ms-examples": { "Delete previously created dataset": { @@ -284,7 +284,7 @@ "/datasets/operations/{operationId}": { "get": { "summary": "Use to check the status of the dataset creation process.", - "description": "\n\n### Submit Operations Request\n\nTo 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.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` http status code with Resource-Location header is returned.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Operations Request\n\nTo 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.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` http status code with Resource-Location header is returned.", "operationId": "Dataset_GetOperation", "x-ms-examples": { "Get the status of an operation which is still running": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dwgconversion.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dwgconversion.json index f17189ec5c11..48e242e66022 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dwgconversion.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/dwgconversion.json @@ -129,7 +129,7 @@ "/conversions": { "post": { "summary": "Use to convert a previously imported [Drawing Package](https://aka.ms/am-drawing-package) into map data.", - "description": "\n\n The `Conversion` API is an HTTP `POST` request that allows the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The drawing package is referenced by the `udid` used when it was uploaded into the [Data Registry](/rest/api/maps/data). For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running operation](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n The `Conversion` API is an HTTP `POST` request that allows the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The drawing package is referenced by the `udid` used when it was uploaded into the [Data Registry](/rest/api/maps/data). For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running operation](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", "operationId": "Conversion_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -168,7 +168,7 @@ }, "get": { "summary": "Use to get a list of data conversions.", - "description": "\n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
", "operationId": "Conversion_List", "x-ms-examples": { "Returns a list of all the data processed by the Conversion Service for the account": { @@ -203,7 +203,7 @@ "/conversions/{conversionId}": { "get": { "summary": "Use to fetch the specified data conversion.", - "description": "\n\n ### Submit Get Request \n\n The `Get` API is an HTTP `GET` request that allows the caller to fetch a successful data conversion previously submitted using the [Conversion Service](/rest/api/maps-creator/conversion/convert).", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n ### Submit Get Request \n\n The `Get` API is an HTTP `GET` request that allows the caller to fetch a successful data conversion previously submitted using the [Conversion Service](/rest/api/maps-creator/conversion/convert).", "operationId": "Conversion_Get", "x-ms-examples": { "Get the details for one conversion operation": { @@ -235,7 +235,7 @@ }, "delete": { "summary": "Use to delete the specified data conversion.", - "description": "\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path contains the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path contains the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", "operationId": "Conversion_Delete", "x-ms-examples": { "Delete previously converted content": { @@ -266,7 +266,7 @@ "/conversions/operations/{operationId}": { "get": { "summary": "Use to check the status of a conversion process", - "description": "\n\n ### Submit Get Operation Request \n\nThe `Get Operation` API is an HTTP `GET` request that allows the caller to check the status of a [conversion](/rest/api/maps-creator/conversion/convert) process and retrieve the `conversionId` value.\n\nThis path will be obtained from a call to POST /conversions. While in progress, an HTTP 200 response code will be returned with no extra headers - followed by an HTTP 200 response code with a `Resource-Location` header once successfully completed.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n ### Submit Get Operation Request \n\nThe `Get Operation` API is an HTTP `GET` request that allows the caller to check the status of a [conversion](/rest/api/maps-creator/conversion/convert) process and retrieve the `conversionId` value.\n\nThis path will be obtained from a call to POST /conversions. While in progress, an HTTP 200 response code will be returned with no extra headers - followed by an HTTP 200 response code with a `Resource-Location` header once successfully completed.", "operationId": "Conversion_GetOperation", "x-ms-examples": { "Get the status of an operation which is still running": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/features.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/features.json index 6b34ccc1db04..f3cadb0e97ee 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/features.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/features.json @@ -145,7 +145,7 @@ "/features/datasets/{datasetId}": { "get": { "summary": "Use to get links to the API definition, conformance statements and metadata for a given feature collection.", - "description": "\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Get Landing Page Request \n\nThe `Get Landing Page` API is an HTTP `GET` request that provides links to the API definition, conformance statements and metadata about the features in the specified dataset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Get Landing Page Request \n\nThe `Get Landing Page` API is an HTTP `GET` request that provides links to the API definition, conformance statements and metadata about the features in the specified dataset.", "operationId": "Features_GetLandingPage", "x-ms-examples": { "GetLandingPage": { @@ -179,7 +179,7 @@ "/features/datasets/{datasetId}/api": { "get": { "summary": "Use to get a description of the capabilities of the Features service.", - "description": "\n\nThe `Get API Definition` API is an HTTP `GET` request that returns details of the capabilities of each API in the Features service, including the request type (`GET` or `POST`) a `description`, `operationId`, `parameters`, and `responses`. It can be used by developers to understand the API or by development tools to support the implementation of servers and clients.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get API Definition` API is an HTTP `GET` request that returns details of the capabilities of each API in the Features service, including the request type (`GET` or `POST`) a `description`, `operationId`, `parameters`, and `responses`. It can be used by developers to understand the API or by development tools to support the implementation of servers and clients.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.", "operationId": "Features_GetApiDefinition", "x-ms-examples": { "GetApiDefinition": { @@ -213,7 +213,7 @@ "/features/datasets/{datasetId}/conformance": { "get": { "summary": "Use to get a list of the Open Geospatial Consortium (OGC) conformance classes that the server conforms to.", - "description": "\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n \n\n### Submit List Conformance Request\n\nThe `List Conformance` API is an HTTP `GET` request that returns a list of all requirements classes specified in the OGC standard that the server conforms to.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n \n\n### Submit List Conformance Request\n\nThe `List Conformance` API is an HTTP `GET` request that returns a list of all requirements classes specified in the OGC standard that the server conforms to.", "operationId": "Features_ListConformance", "x-ms-examples": { "GetConformance": { @@ -247,7 +247,7 @@ "/features/datasets/{datasetId}/collections": { "get": { "summary": "Use to get a list of feature collections.", - "description": "\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n\n\n### Submit Get Collections Request\n\nThe `Get Collections` API is an HTTP `GET` request that returns a list of all feature collections in a dataset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n\n\n### Submit Get Collections Request\n\nThe `Get Collections` API is an HTTP `GET` request that returns a list of all feature collections in a dataset.", "operationId": "Features_GetCollections", "x-ms-examples": { "GetCollections": { @@ -281,7 +281,7 @@ "/features/datasets/{datasetId}/collections/{collectionId}": { "get": { "summary": "Use to get details of a feature collection.", - "description": "\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n ### Submit Get Collection Request\n\nThe `Get Collection` API is an HTTP `GET` request that returns the details of a specific feature collection as defined by the provided `collectionId` in the specified dataset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n ### Submit Get Collection Request\n\nThe `Get Collection` API is an HTTP `GET` request that returns the details of a specific feature collection as defined by the provided `collectionId` in the specified dataset.", "operationId": "Features_GetCollection", "x-ms-examples": { "GetCollection": { @@ -318,7 +318,7 @@ "/features/datasets/{datasetId}/collections/{collectionId}/definition": { "get": { "summary": "Use to get a detailed data model of the specified feature collection.", - "description": "\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Get Collection Definition Request\n\nThe `Get Collection Definition` API is an HTTP `GET` request that returns a detailed data model of a feature collection as defined by the provided `collectionId`.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Get Collection Definition Request\n\nThe `Get Collection Definition` API is an HTTP `GET` request that returns a detailed data model of a feature collection as defined by the provided `collectionId`.", "operationId": "Features_GetCollectionDefinition", "x-ms-examples": { "GetCollectionDefinition": { @@ -355,7 +355,7 @@ "/features/datasets/{datasetId}/collections/{collectionId}/items": { "get": { "summary": "Use to get a detailed list of features in the specified feature collection.", - "description": "\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Get Items Request\n\nThe `Get Items` API is an HTTP `GET` request that returns the features in a feature collection as defined by the provided `collectionId` in the specified dataset.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Get Items Request\n\nThe `Get Items` API is an HTTP `GET` request that returns the features in a feature collection as defined by the provided `collectionId` in the specified dataset.", "operationId": "Features_GetItems", "x-ms-examples": { "GetFeatures": { @@ -399,7 +399,7 @@ }, "post": { "summary": "Use to create a [feature](https://tools.ietf.org/html/rfc7946#section-3.2).", - "description": "\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Create Request\n\n The `Feature` API is an HTTP `POST` request that allows the caller to create a new feature that conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) specification. This API creates a feature with the provided attributes in the given collection.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Create Request\n\n The `Feature` API is an HTTP `POST` request that allows the caller to create a new feature that conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) specification. This API creates a feature with the provided attributes in the given collection.", "operationId": "Features_Create", "x-ms-examples": { "PostFeature": { @@ -439,7 +439,7 @@ "/features/datasets/{datasetId}/collections/{collectionId}/items/{featureId}": { "get": { "summary": "Use to get the details of a [feature](https://tools.ietf.org/html/rfc7946#section-3.2).", - "description": "\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Get Request\n\nThe `Get` API is an HTTP `GET` request that returns the feature identified by the provided `featureId` in the specified dataset and collection.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Get Request\n\nThe `Get` API is an HTTP `GET` request that returns the feature identified by the provided `featureId` in the specified dataset and collection.", "operationId": "Features_Get", "x-ms-examples": { "GetFeature": { @@ -474,7 +474,7 @@ }, "put": { "summary": "Use to overwrite all existing attributes of a [feature](https://tools.ietf.org/html/rfc7946#section-3.2).", - "description": "\n\nThe `Replace` API conforms to the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) specification.\n\nThis is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Replace Request\n\nThe `Replace` API is an HTTP `PUT` request that **replaces** the feature identified by the provided `featureId` in the specified collection, meaning the data supplied in the request body overwrites all attributes of the feature.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Replace` API conforms to the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) specification.\n\nThis is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Replace Request\n\nThe `Replace` API is an HTTP `PUT` request that **replaces** the feature identified by the provided `featureId` in the specified collection, meaning the data supplied in the request body overwrites all attributes of the feature.", "operationId": "Features_Replace", "x-ms-examples": { "PutFeature": { @@ -512,7 +512,7 @@ }, "patch": { "summary": "Use to modify individual attributes of a [feature](https://tools.ietf.org/html/rfc7946#section-3.2).", - "description": "\n\nThe `Update` API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) specification.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Update Request\n\nThe `Update` API is an HTTP `PATCH` request that is used to change individual attributes of a feature as specified by the `featureId`. The only attributes that will be updated are those explicitly included in the request body.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Update` API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) specification.\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Update Request\n\nThe `Update` API is an HTTP `PATCH` request that is used to change individual attributes of a feature as specified by the `featureId`. The only attributes that will be updated are those explicitly included in the request body.", "operationId": "Features_Update", "x-ms-examples": { "PatchFeature": { @@ -550,7 +550,7 @@ }, "delete": { "summary": "Use to delete a [feature](https://tools.ietf.org/html/rfc7946#section-3.2).", - "description": "\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Delete Request \n\nThe `Delete` API is an HTTP `DELETE` request that is used to delete a feature specified by its `featureId`. The delete request will fail if the feature has any dependent features, so be sure and delete them first. The features `Delete` API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) specification.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Features API is a part of [Creator](/azure/azure-maps/creator-indoor-maps), which makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. Features GET APIs follow the [Open Geospatial Consortium API - Features - Part 1: Core corrigendum](http://www.opengis.net/doc/IS/ogcapi-features-1/1.0.1) standard to query [Datasets](/rest/api/maps-creator/dataset). Datasets consist of multiple feature collections, which are a grouping of [features](https://tools.ietf.org/html/rfc7946#section-3.2) defined by a common schema.\n\n### Submit Delete Request \n\nThe `Delete` API is an HTTP `DELETE` request that is used to delete a feature specified by its `featureId`. The delete request will fail if the feature has any dependent features, so be sure and delete them first. The features `Delete` API conforms with the **drafted** [Open Geospatial Consortium API - Features - Part 4: Create, Replace, Update and Delete](http://docs.opengeospatial.org/DRAFTS/20-002.html) specification.", "operationId": "Features_Delete", "x-ms-examples": { "DeleteFeature": { diff --git a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/mapconfiguration.json b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/mapconfiguration.json index 14a3ca747f4b..5ad611e172d5 100644 --- a/specification/maps/data-plane/Creator/preview/2023-03-01-preview/mapconfiguration.json +++ b/specification/maps/data-plane/Creator/preview/2023-03-01-preview/mapconfiguration.json @@ -102,7 +102,7 @@ "/styles/mapconfigurations": { "post": { "summary": "Use to create a map configuration.", - "description": "\n\nFor more information on what a map configuration is, see the [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps#map-configuration) concepts article.\n\n### Submit Create Request \n\nThe Map Configuration `Create` API is an HTTP `POST` request used to create a new map configuration.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nFor more information on what a map configuration is, see the [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps#map-configuration) concepts article.\n\n### Submit Create Request \n\nThe Map Configuration `Create` API is an HTTP `POST` request used to create a new map configuration.", "operationId": "MapConfiguration_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -151,7 +151,7 @@ }, "get": { "summary": "Use to get a list of all map configurations.", - "description": "\n\n### Submit List Request \n\nThe Map Configuration `List` API is an HTTP `GET` request used to get a list of all map configurations.\n\n", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit List Request \n\nThe Map Configuration `List` API is an HTTP `GET` request used to get a list of all map configurations.\n\n", "operationId": "MapConfiguration_List", "x-ms-examples": { "Get a list of all map configurations": { @@ -186,7 +186,7 @@ "/styles/mapconfigurations/{mapConfigurationId}": { "get": { "summary": "Use to get a map configuration.", - "description": "\n\n### Submit Get Request \n\nThe Map Configuration `Get` API is an HTTP `GET` request used to get a map configuration. The response contains a zip file with the map configuration JSON and any image files it references. You can always get the default map configuration using predefined alias `defaultIndoor_{tilesetId}` for a given tileset if you deleted the auto-generated map configuration. The two predefined styles used in default map configuration are `microsoft-maps:indoor_2022-01-01` and `microsoft-maps:indoor_dark_2022-01-01`.\n\n", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\n### Submit Get Request \n\nThe Map Configuration `Get` API is an HTTP `GET` request used to get a map configuration. The response contains a zip file with the map configuration JSON and any image files it references. You can always get the default map configuration using predefined alias `defaultIndoor_{tilesetId}` for a given tileset if you deleted the auto-generated map configuration. The two predefined styles used in default map configuration are `microsoft-maps:indoor_2022-01-01` and `microsoft-maps:indoor_dark_2022-01-01`.\n\n", "operationId": "MapConfiguration_Get", "x-ms-examples": { "Gets the details for a single map configuration": { @@ -229,7 +229,7 @@ }, "delete": { "summary": "Use to delete a map configuration.", - "description": "\n\nThe Map Configuration `Delete` API is an HTTP `DELETE` request used to delete a map configuration. For more information on what a map configuration is, see the [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps#map-configuration) concepts article.\n\n### Submit Delete Request\n\nAn `HTTP DELETE` request with the `mapConfigurationId` in the path of the request is required to remove an existing map configuration from your Azure Maps account.
\n\n#### Delete request \"Successful\"\n\nThe Map Configuration Delete API returns a HTTP `204 No Content` response with an empty body, if the map configuration was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the map configuration with the passed-in `mapConfigurationId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - MapConfiguration Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe Map Configuration `Delete` API is an HTTP `DELETE` request used to delete a map configuration. For more information on what a map configuration is, see the [Creator for indoor maps](/azure/azure-maps/creator-indoor-maps#map-configuration) concepts article.\n\n### Submit Delete Request\n\nAn `HTTP DELETE` request with the `mapConfigurationId` in the path of the request is required to remove an existing map configuration from your Azure Maps account.
\n\n#### Delete request \"Successful\"\n\nThe Map Configuration Delete API returns a HTTP `204 No Content` response with an empty body, if the map configuration was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the map configuration with the passed-in `mapConfigurationId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - MapConfiguration Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", "operationId": "MapConfiguration_Delete", "x-ms-examples": { "Delete a created map configuration": { @@ -260,7 +260,7 @@ "/styles/mapconfigurations/operations/{operationId}": { "get": { "summary": "Use to check the status of the map configuration creation process.", - "description": "\n\nThe `Get Operation` API is an HTTP `GET` request used to check the status of the map configuration creation process.\n\n### Submit Operations Request\n\nTo view the current progress of a map configuration operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` http status code is returned with the `Resource-Location` in the header.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Creator retirement**\n>\n> The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation).\n\nThe `Get Operation` API is an HTTP `GET` request used to check the status of the map configuration creation process.\n\n### Submit Operations Request\n\nTo view the current progress of a map configuration operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code is returned with no extra headers. If the operation succeeds, a `200-OK` http status code is returned with the `Resource-Location` in the header.", "operationId": "MapConfiguration_GetOperation", "x-ms-examples": { "Get the status of an operation which is still running": { diff --git a/specification/maps/data-plane/DataRegistry/stable/2023-06-01/dataregistry.json b/specification/maps/data-plane/DataRegistry/stable/2023-06-01/dataregistry.json index 407c244c8fd2..1b0e10d31ad2 100644 --- a/specification/maps/data-plane/DataRegistry/stable/2023-06-01/dataregistry.json +++ b/specification/maps/data-plane/DataRegistry/stable/2023-06-01/dataregistry.json @@ -100,7 +100,7 @@ "/dataRegistries": { "get": { "summary": "Use to get a list of all data registries in the Azure Maps account.", - "description": "\n\nThe `List` API is an HTTP `GET` request that returns an array containing all data registries previously registered using the [Register or Replace API](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit List Request\n\nTo list all your data registries, issue a `GET` request with no additional parameters.\n\n## List Response\n\nThe `List` request returns an array of data registries in `JSON` format in the body of the response.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Data registry service retirement**\n>\n> The Azure Maps Data registry service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Data Registry](https://aka.ms/AzureMapsDataRegistryDeprecation).\n\nThe `List` API is an HTTP `GET` request that returns an array containing all data registries previously registered using the [Register or Replace API](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit List Request\n\nTo list all your data registries, issue a `GET` request with no additional parameters.\n\n## List Response\n\nThe `List` request returns an array of data registries in `JSON` format in the body of the response.", "operationId": "DataRegistry_List", "x-ms-examples": { "List all previously registered data registries": { @@ -141,7 +141,7 @@ "/dataRegistries/{udid}": { "get": { "summary": "Use to get the specified data registry information.", - "description": "\n\nThe `Get Data Registry` API is an HTTP `GET` request that returns data registry information, as an [AzureBlob](#azureblob) object in JSON format, in the body of the response, along with the HTTP status code 200, when successful. If Azure Maps cannot access the underlying content or the integrity check fails, the `status` is set to `Failed` and an error is returned.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Get Data Registry Request\n\nA data registry `GET` request returns details of the requested data registry, as determined by the specified `udid`. The details are returned in the body of the response in JSON format.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Data registry service retirement**\n>\n> The Azure Maps Data registry service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Data Registry](https://aka.ms/AzureMapsDataRegistryDeprecation).\n\nThe `Get Data Registry` API is an HTTP `GET` request that returns data registry information, as an [AzureBlob](#azureblob) object in JSON format, in the body of the response, along with the HTTP status code 200, when successful. If Azure Maps cannot access the underlying content or the integrity check fails, the `status` is set to `Failed` and an error is returned.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Get Data Registry Request\n\nA data registry `GET` request returns details of the requested data registry, as determined by the specified `udid`. The details are returned in the body of the response in JSON format.", "operationId": "DataRegistry_GetDataRegistry", "x-ms-examples": { "Get the data registry of a completed udid": { @@ -186,7 +186,7 @@ }, "put": { "summary": "Use to register data stored in an Azure Storage Account with an Azure Maps account.", - "description": "\n\nThe `Register` API is an HTTP `PUT` request used to register the data in an Azure Storage Account with an Azure Maps account. The maximum file size that can be registered is one gigabyte.\n\nThis is useful in scenarios like registering a collection of Geofences in `GeoJSON` format for use in [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or registering a set of DWG design files as a zipped [Drawing Package](https://docs.microsoft.com/azure/azure-maps/drawing-requirements) for use in the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Register or Replace Request\n\nThe `Register` and `Replace` requests are both long-running operations that contain an [AzureBlob](#azureblob) JSON object in the body of the request that defines the data registry details.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Data registry service retirement**\n>\n> The Azure Maps Data registry service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Data Registry](https://aka.ms/AzureMapsDataRegistryDeprecation).\n\nThe `Register` API is an HTTP `PUT` request used to register the data in an Azure Storage Account with an Azure Maps account. The maximum file size that can be registered is one gigabyte.\n\nThis is useful in scenarios like registering a collection of Geofences in `GeoJSON` format for use in [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or registering a set of DWG design files as a zipped [Drawing Package](https://docs.microsoft.com/azure/azure-maps/drawing-requirements) for use in the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Register or Replace Request\n\nThe `Register` and `Replace` requests are both long-running operations that contain an [AzureBlob](#azureblob) JSON object in the body of the request that defines the data registry details.", "operationId": "DataRegistry_RegisterOrReplace", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -270,7 +270,7 @@ }, "delete": { "summary": "Use to unregister data stored in an Azure Storage Account that is registered with an Azure Maps account.", - "description": "\n\nThe `Unregister` API is an HTTP `DELETE` request that removes a data registry without deleting the underlying content from the Azure storage account.\n\nUseful in scenarios like unregistering geofence files previously registered using the [Register or Replace](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace) API for use in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or unregistering a compressed (ZIP) file containing DWG design files used by the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Unregister Request\n\nUse an HTTP `DELETE` request with the `udid` of the data registry to unregister.\n\n## Unregister Response\n\nThe `Unregister` request returns a HTTP '204 No Content' response with an empty body, if the data registry was deleted successfully.", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Data registry service retirement**\n>\n> The Azure Maps Data registry service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Data Registry](https://aka.ms/AzureMapsDataRegistryDeprecation).\n\nThe `Unregister` API is an HTTP `DELETE` request that removes a data registry without deleting the underlying content from the Azure storage account.\n\nUseful in scenarios like unregistering geofence files previously registered using the [Register or Replace](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace) API for use in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or unregistering a compressed (ZIP) file containing DWG design files used by the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Unregister Request\n\nUse an HTTP `DELETE` request with the `udid` of the data registry to unregister.\n\n## Unregister Response\n\nThe `Unregister` request returns a HTTP '204 No Content' response with an empty body, if the data registry was deleted successfully.", "operationId": "DataRegistry_Unregister", "x-ms-examples": { "Unregister a data registry without deleting the underlying contents": { @@ -311,7 +311,7 @@ "/dataRegistries/operations/{operationId}": { "get": { "summary": "Use to check the status of the [data register or replace](/rest/api/maps/data-registry/register-or-replace) request.", - "description": "The `Get Operation` API is an HTTP `GET` request used to get the status of a [data register or replace](/rest/api/maps/data-registry/register-or-replace) request is returned in the header of the register or replace response as the value of the `Operation-Location` key. While in progress, a HTTP `200 OK` response will be returned with `Retry-After` header - followed by a HTTP `200 OK` with no extra header once completed.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n", + "description": "\n\n> [!NOTE]\n>\n> **Azure Maps Data registry service retirement**\n>\n> The Azure Maps Data registry service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Data Registry](https://aka.ms/AzureMapsDataRegistryDeprecation).\n\nThe `Get Operation` API is an HTTP `GET` request used to get the status of a [data register or replace](/rest/api/maps/data-registry/register-or-replace) request is returned in the header of the register or replace response as the value of the `Operation-Location` key. While in progress, a HTTP `200 OK` response will be returned with `Retry-After` header - followed by a HTTP `200 OK` with no extra header once completed.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n", "operationId": "DataRegistry_GetOperation", "x-ms-examples": { "Get the status of an operation that is still running": { diff --git a/specification/maps/data-plane/Spatial/stable/2022-08-01/spatial.json b/specification/maps/data-plane/Spatial/stable/2022-08-01/spatial.json index 39ddfa41e878..22e12870a091 100644 --- a/specification/maps/data-plane/Spatial/stable/2022-08-01/spatial.json +++ b/specification/maps/data-plane/Spatial/stable/2022-08-01/spatial.json @@ -181,7 +181,7 @@ "/spatial/geofence/{format}": { "get": { "summary": "Use to get the proximity of a coordinate to a geofence.", - "description": "\n\nThe `Get Geofence` API is an HTTP `GET` request that retrieves the proximity of a coordinate to a geofence that has been uploaded to the Data registry. You upload a geofence or set of fences into an Azure Storage Account, then register it with your Azure Maps Account using the [Data registry](/rest/api/maps/data-registry/register-or-replace), for more information see [How to create data registry](/azure/azure-maps/how-to-create-data-registries). For more information on on the geofence data format, see [Geofencing GeoJSON data](/azure/azure-maps/geofence-geojson). To query the proximity of a coordinate, you supply the location of the object you are tracking as well as the ID for the fence or set of fences, and the response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.\n\nThis API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default). To test this API, you can upload the sample data from Post Geofence API examples (Request Body) using the Data registry service and replace the `{udid}` from the sample request below with the `udid` used to create the Data registry. For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n\n### Geofencing InnerError code\n\nIn geofencing response error contract, `innererror` is an object containing service specific information about the error. `code` is a property in `innererror` which can map to a specific geofencing error type. The table belows shows the code mapping between all the known client error type to the corresponding geofencing error `message`.\n\ninnererror.code | error.message\n---------------------------- | -------------------------------------- \nNullDeviceId | Device Id should not be null.\nNullUdid\t | Udid should not be null.\nUdidWrongFormat| Udid should be acquired from user data ingestion API.\nInvalidUserTime| Usertime is invalid.\nInvalidSearchBuffer| Searchbuffer is invalid.\nInvalidSearchRange| The value range of searchbuffer should be from 0 to 500 meters.\nInvalidLatLon| Lat and/or lon parameters are invalid.\nInvalidIsAsyncValue| The IsAsync parameter is invalid.\nInvalidModeValue| The mode parameter invalid.\nInvalidJson| Geofencing data is not a valid json file.\nNotSupportedGeoJson| Geofencing data can't be read as a Feature or FeatureCollections.\nInvalidGeoJson| Geofencing data is invalid.\nNoUserDataWithAccountOrSubscription| Can't find user geofencing data with provided account-id and/or subscription-id.\nNoUserDataWithUdid|\tCan't find user geofencing data with provided udid.", + "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Spatial service retirement**\n>\n> The Azure Maps Spatial service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Spatial](https://aka.ms/AzureMapsSpatialDeprecation).\n\nThe `Get Geofence` API is an HTTP `GET` request that retrieves the proximity of a coordinate to a geofence that has been uploaded to the Data registry. You upload a geofence or set of fences into an Azure Storage Account, then register it with your Azure Maps Account using the [Data registry](/rest/api/maps/data-registry/register-or-replace), for more information see [How to create data registry](/azure/azure-maps/how-to-create-data-registries). For more information on on the geofence data format, see [Geofencing GeoJSON data](/azure/azure-maps/geofence-geojson). To query the proximity of a coordinate, you supply the location of the object you are tracking as well as the ID for the fence or set of fences, and the response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.\n\nThis API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default). To test this API, you can upload the sample data from Post Geofence API examples (Request Body) using the Data registry service and replace the `{udid}` from the sample request below with the `udid` used to create the Data registry. For more information on the data registry service, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).\n\n\n### Geofencing InnerError code\n\nIn geofencing response error contract, `innererror` is an object containing service specific information about the error. `code` is a property in `innererror` which can map to a specific geofencing error type. The table belows shows the code mapping between all the known client error type to the corresponding geofencing error `message`.\n\ninnererror.code | error.message\n---------------------------- | -------------------------------------- \nNullDeviceId | Device Id should not be null.\nNullUdid\t | Udid should not be null.\nUdidWrongFormat| Udid should be acquired from user data ingestion API.\nInvalidUserTime| Usertime is invalid.\nInvalidSearchBuffer| Searchbuffer is invalid.\nInvalidSearchRange| The value range of searchbuffer should be from 0 to 500 meters.\nInvalidLatLon| Lat and/or lon parameters are invalid.\nInvalidIsAsyncValue| The IsAsync parameter is invalid.\nInvalidModeValue| The mode parameter invalid.\nInvalidJson| Geofencing data is not a valid json file.\nNotSupportedGeoJson| Geofencing data can't be read as a Feature or FeatureCollections.\nInvalidGeoJson| Geofencing data is invalid.\nNoUserDataWithAccountOrSubscription| Can't find user geofencing data with provided account-id and/or subscription-id.\nNoUserDataWithUdid|\tCan't find user geofencing data with provided udid.", "operationId": "Spatial_GetGeofence", "x-ms-examples": { "GetGeofence": { @@ -267,7 +267,7 @@ }, "post": { "summary": "Use to get the proximity of a coordinate to a geofence.", - "description": "\n\nThe `Post Geofence` API is an HTTP `POST` request that retrieveS the proximity of a coordinate to a provided geofence or set of fences. With `POST` requests, you do not have to upload the fence data in advance, instead you supply the location of the object you are tracking in query parameters as well as the fence or set of fences data in post request body. For more information on on the geofence data format, see [Geofencing GeoJSON data](/azure/azure-maps/geofence-geojson). The response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.\n\nThis API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).", + "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Spatial service retirement**\n>\n> The Azure Maps Spatial service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Spatial](https://aka.ms/AzureMapsSpatialDeprecation).\n\nThe `Post Geofence` API is an HTTP `POST` request that retrieveS the proximity of a coordinate to a provided geofence or set of fences. With `POST` requests, you do not have to upload the fence data in advance, instead you supply the location of the object you are tracking in query parameters as well as the fence or set of fences data in post request body. For more information on on the geofence data format, see [Geofencing GeoJSON data](/azure/azure-maps/geofence-geojson). The response will contain information about the distance from the outer edge of the geofence. A negative value signifies that the coordinate is inside of the fence while a positive value means that it is outside of the fence.\n\nThis API can be used for a variety of scenarios that include things like asset tracking, fleet management, or setting up alerts for moving objects.\n\nThe API supports [integration with Event Grid](/azure/azure-maps/azure-maps-event-grid-integration). The isAsync parameter is used to enable integration with Event Grid (disabled by default).", "operationId": "Spatial_PostGeofence", "x-ms-examples": { "PostGeofence": { @@ -354,7 +354,7 @@ "/spatial/buffer/{format}": { "post": { "summary": "Use to get a `FeatureCollection` where each feature is a buffer around the corresponding indexed feature of the input.", - "description": "\n\nThe `Post Buffer` API is an HTTP `POST` request that returns a `FeatureCollection` where each feature is a buffer around the corresponding indexed feature of the input. The buffer could be either on the outside or the inside of the provided feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the `FeatureCollection` input, or if only one distance is provided, then that distance is applied to every feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided.", + "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Spatial service retirement**\n>\n> The Azure Maps Spatial service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Spatial](https://aka.ms/AzureMapsSpatialDeprecation).\n\nThe `Post Buffer` API is an HTTP `POST` request that returns a `FeatureCollection` where each feature is a buffer around the corresponding indexed feature of the input. The buffer could be either on the outside or the inside of the provided feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the `FeatureCollection` input, or if only one distance is provided, then that distance is applied to every feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided.", "operationId": "Spatial_PostBuffer", "x-ms-examples": { "PostBuffer": { @@ -395,7 +395,7 @@ }, "get": { "summary": "Use to get a `FeatureCollection` where each feature is a buffer around the corresponding indexed feature of the input.", - "description": "\n\nThe `Get Buffer` API is an HTTP `GET` request that returns a `FeatureCollection` where each feature is a buffer around the corresponding indexed feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input features are provided by a GeoJSON file which is uploaded using the [Data registry API](/rest/api/maps/data-registry/register-or-replace) and referenced by a unique udid. The GeoJSON file may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided. \n\nTo test this API, you can upload the sample data from [Post Buffer API](/rest/api/maps/spatial/postbuffer#examples) examples (Request Body without distances array) using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and replace the `{udid}` in the following [sample request](/rest/api/maps/spatial/getbuffer#examples) with the `udid` used when creating the data registry. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", + "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Spatial service retirement**\n>\n> The Azure Maps Spatial service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Spatial](https://aka.ms/AzureMapsSpatialDeprecation).\n\nThe `Get Buffer` API is an HTTP `GET` request that returns a `FeatureCollection` where each feature is a buffer around the corresponding indexed feature of the input. The buffer could be either on the outside or the inside of the provided Feature, depending on the distance provided in the input. There must be either one distance provided per Feature in the FeatureCollection input, or if only one distance is provided, then that distance is applied to every Feature in the collection. The positive (or negative) buffer of a geometry is defined as the Minkowski sum (or difference) of the geometry with a circle of radius equal to the absolute value of the buffer distance. The buffer API always returns a polygonal result. The negative or zero-distance buffer of lines and points is always an empty polygon. The input features are provided by a GeoJSON file which is uploaded using the [Data registry API](/rest/api/maps/data-registry/register-or-replace) and referenced by a unique udid. The GeoJSON file may contain a collection of Point, MultiPoint, Polygon, MultiPolygon, LineString and MultiLineString. GeometryCollection will be ignored if provided. \n\nTo test this API, you can upload the sample data from [Post Buffer API](/rest/api/maps/spatial/postbuffer#examples) examples (Request Body without distances array) using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and replace the `{udid}` in the following [sample request](/rest/api/maps/spatial/getbuffer#examples) with the `udid` used when creating the data registry. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", "operationId": "Spatial_GetBuffer", "x-ms-examples": { "GetBuffer": { @@ -439,7 +439,7 @@ "/spatial/closestPoint/{format}": { "post": { "summary": "Use to get the closest point between a base point and a given set of target points.", - "description": "\n\nThe `Post Closest Point` API is an HTTP `POST` request that returns the closest point between a base point and a given set of target points. The set of target points is provided by user data in post request body. The user data may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The algorithm does not take into account routing or traffic. The maximum number of points accepted is 100,000. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.", + "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Spatial service retirement**\n>\n> The Azure Maps Spatial service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Spatial](https://aka.ms/AzureMapsSpatialDeprecation).\n\nThe `Post Closest Point` API is an HTTP `POST` request that returns the closest point between a base point and a given set of target points. The set of target points is provided by user data in post request body. The user data may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The algorithm does not take into account routing or traffic. The maximum number of points accepted is 100,000. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.", "operationId": "Spatial_PostClosestPoint", "x-ms-examples": { "PostClosestPoint": { @@ -486,7 +486,7 @@ }, "get": { "summary": "Use to get the closest point between a base point and a given set of target points.", - "description": "\n\nThe `Get Closest Point` API is an HTTP `GET` request the closest point between a base point and a given set of points in the user uploaded data set identified by `udid`. The set of target points is provided by a GeoJSON file which is uploaded using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and referenced by a unique udid. The GeoJSON file may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The maximum number of points accepted is 100,000. The algorithm does not take into account routing or traffic. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.\n\nTo test this API, you can upload the sample data from [Post Closest Point API](/rest/api/maps/spatial/postclosestpoint#examples) examples (Request Body) using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and replace the `{udid}` from the [sample request below](/rest/api/maps/spatial/getclosestpoint#examples) with the `udid` used when creating the data registry. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", + "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Spatial service retirement**\n>\n> The Azure Maps Spatial service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Spatial](https://aka.ms/AzureMapsSpatialDeprecation).\n\nThe `Get Closest Point` API is an HTTP `GET` request the closest point between a base point and a given set of points in the user uploaded data set identified by `udid`. The set of target points is provided by a GeoJSON file which is uploaded using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and referenced by a unique udid. The GeoJSON file may only contain a collection of Point geometry. MultiPoint or other geometries will be ignored if provided. The maximum number of points accepted is 100,000. The algorithm does not take into account routing or traffic. Information returned includes closest point latitude, longitude, and distance in meters from the closest point.\n\nTo test this API, you can upload the sample data from [Post Closest Point API](/rest/api/maps/spatial/postclosestpoint#examples) examples (Request Body) using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and replace the `{udid}` from the [sample request below](/rest/api/maps/spatial/getclosestpoint#examples) with the `udid` used when creating the data registry. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", "operationId": "Spatial_GetClosestPoint", "x-ms-examples": { "GetClosestPoint": { @@ -535,7 +535,7 @@ "/spatial/pointInPolygon/{format}": { "post": { "summary": "Use to determine if a given a point is inside a set of polygons.", - "description": "\n\nThe `Post Point In Polygon` API is an HTTP `POST` request that returns a boolean value indicating whether a point is inside a set of polygons. The user data may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries (referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.", + "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Spatial service retirement**\n>\n> The Azure Maps Spatial service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Spatial](https://aka.ms/AzureMapsSpatialDeprecation).\n\nThe `Post Point In Polygon` API is an HTTP `POST` request that returns a boolean value indicating whether a point is inside a set of polygons. The user data may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries (referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.", "operationId": "Spatial_PostPointInPolygon", "x-ms-examples": { "PostPointInPolygon": { @@ -576,7 +576,7 @@ }, "get": { "summary": "Use to determine if a given a point is inside a set of polygons.", - "description": "\n\nThe `Get Point In Polygon` API is an HTTP `GET` request that returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons is provided by a GeoJSON file which is uploaded using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and referenced by a unique udid. The GeoJSON file may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries(referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.\n\n \nTo test this API, you can upload the sample data from [Post Point In Polygon API](/rest/api/maps/spatial/postpointinpolygon#examples) examples (Request Body) using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and replace the `{udid}` from the [sample request below](/rest/api/maps/spatial/getpointinpolygon#examples) with the `udid` used when creating the data registry. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", + "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Spatial service retirement**\n>\n> The Azure Maps Spatial service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Spatial](https://aka.ms/AzureMapsSpatialDeprecation).\n\nThe `Get Point In Polygon` API is an HTTP `GET` request that returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons is provided by a GeoJSON file which is uploaded using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and referenced by a unique udid. The GeoJSON file may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries(referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.\n\n \nTo test this API, you can upload the sample data from [Post Point In Polygon API](/rest/api/maps/spatial/postpointinpolygon#examples) examples (Request Body) using the [Data registry](/rest/api/maps/data-registry/register-or-replace) service and replace the `{udid}` from the [sample request below](/rest/api/maps/spatial/getpointinpolygon#examples) with the `udid` used when creating the data registry. For more information, see [How to create data registry](/azure/azure-maps/how-to-create-data-registries).", "operationId": "Spatial_GetPointInPolygon", "x-ms-examples": { "GetPointInPolygon": { @@ -619,7 +619,7 @@ "/spatial/greatCircleDistance/{format}": { "get": { "summary": "Use to determine shortest distance between two points on the surface of a sphere.", - "description": "\n\nThe `Get Great Circle Distance` API is an HTTP `GET` request that returns the great-circle or shortest distance between two points on the surface of a sphere, measured along the surface of the sphere. This differs from calculating a straight line through the sphere's interior. This method is helpful for estimating travel distances for airplanes by calculating the shortest distance between airports.", + "description": "\n\n > [!NOTE]\n>\n> **Azure Maps Spatial service retirement**\n>\n> The Azure Maps Spatial service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Spatial](https://aka.ms/AzureMapsSpatialDeprecation).\n\nThe `Get Great Circle Distance` API is an HTTP `GET` request that returns the great-circle or shortest distance between two points on the surface of a sphere, measured along the surface of the sphere. This differs from calculating a straight line through the sphere's interior. This method is helpful for estimating travel distances for airplanes by calculating the shortest distance between airports.", "operationId": "Spatial_GetGreatCircleDistance", "x-ms-examples": { "GetGreatCircleDistance": {