[Hub Generated] Review request for Microsoft.Maps/Microsoft.Maps to a…

…dd version preview/1.0 (#14524) * Update geo urls, pricing tier, and description for GA * updated to parameterized URLs for v1 * undo some header changes for linting Co-authored-by: Jeff Couckuyt <[email protected]>
Azure · May 25, 2021 · 7c4038f · 7c4038f
1 parent cb635c4
commit 7c4038f
Show file tree

Hide file tree

Showing 44 changed files with 364 additions and 91 deletions.
diff --git a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/alias.json
@@ -5,7 +5,14 @@
     "version": "1.0",
     "description": "APIs for managing aliases in Azure Maps."
   },
-  "host": "atlas.microsoft.com",
+  "x-ms-parameterized-host": {
+    "hostTemplate": "{geography}.atlas.microsoft.com",
+    "parameters": [
+      {
+        "$ref": "#/parameters/GeographicResourceLocation"
+      }
+    ]
+  },
   "schemes": [
     "https"
   ],
@@ -87,6 +94,33 @@
     }
   },
   "parameters": {
+    "GeographicResourceLocation": {
+      "name": "geography",
+      "description": "This parameter specifies where the Azure Maps Creator resource is located.  Valid values are us and eu.",
+      "in": "path",
+      "required": true,
+      "type": "string",
+      "default": "us",
+      "enum": [
+        "us",
+        "eu"
+      ],
+      "x-ms-enum": {
+        "name": "GeographicResourceLocation",
+        "modelAsString": true,
+        "values": [
+          {
+            "value": "us",
+            "description": "Used to access an Azure Maps Creator resource in the United States"
+          },
+          {
+            "value": "eu",
+            "description": "Used to access an Azure Maps Creator resource in Europe"
+          }
+        ]
+      },
+      "x-ms-parameter-location": "client"
+    },
     "SubscriptionKey": {
       "name": "subscription-key",
       "description": "One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.",
@@ -133,7 +167,7 @@
     "/alias": {
       "post": {
         "x-publish": true,
-        "description": "**Alias - Create API**\n\n**Applies to:** S1 pricing tier.\n<br>\n\nThis API allows the caller to create an alias.<br>\nYou can also assign the alias during the create request as well.\n\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.<br> \n\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response the id of the alias, `aliasId`, in the body.\nThe response will look something like:\n\n```json\n{\n    \"aliasId\" : \"d7e5efc8-2239-4387-a286-5bb51aa804e3\"\n}\n```\n\n<br>",
+        "description": "**Alias - Create API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n<br>\n\nThis API allows the caller to create an alias.<br>\nYou can also assign the alias during the create request as well.\n\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.<br> \n\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response the id of the alias, `aliasId`, in the body.\nThe response will look something like:\n\n```json\n{\n    \"aliasId\" : \"d7e5efc8-2239-4387-a286-5bb51aa804e3\"\n}\n```\n\n<br>",
         "operationId": "Alias_CreatePreview",
         "x-ms-examples": {
           "Create an alias that does not reference any resource": {
@@ -180,7 +214,7 @@
       },
       "get": {
         "x-publish": true,
-        "description": "**Alias - List API**\n\n**Applies to:** S1 pricing tier.\n<br>\n\nThis API allows the caller to fetch a list of all previously successfully created aliases.\n\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.<br>\n\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\n  > createdTimestamp - The timestamp that the alias was created.\n  > aliasId - The id for the alias.\n  > resourceId - The id for the resource 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\n\nHere's a sample response returning 2 alias resources:  \n\n<br>\n\n```json\n{\n  \"aliases\": [\n    {\n      \"createdTimestamp\": \"2020-02-13T21:19:11+00:00\",\n      \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n      \"resourceId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n      \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22+00:00\"\n    },\n    {\n      \"createdTimestamp\": \"2020-02-18T19:53:33+00:00\",\n      \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n      \"resourceId\": null,\n      \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33+00:00\"\n    }\n  ]\n}\n```\n\n<br>",
+        "description": "**Alias - List API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n<br>\n\nThis API allows the caller to fetch a list of all previously successfully created aliases.\n\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.<br>\n\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\n  > createdTimestamp - The timestamp that the alias was created.\n  > aliasId - The id for the alias.\n  > resourceId - The id for the resource 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\n\nHere's a sample response returning 2 alias resources:  \n\n<br>\n\n```json\n{\n  \"aliases\": [\n    {\n      \"createdTimestamp\": \"2020-02-13T21:19:11+00:00\",\n      \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n      \"resourceId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n      \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22+00:00\"\n    },\n    {\n      \"createdTimestamp\": \"2020-02-18T19:53:33+00:00\",\n      \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n      \"resourceId\": null,\n      \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33+00:00\"\n    }\n  ]\n}\n```\n\n<br>",
         "operationId": "Alias_ListPreview",
         "x-ms-examples": {
           "List all the previously created aliases": {
@@ -223,7 +257,7 @@
     "/alias/assign/{aliasId}": {
       "patch": {
         "x-publish": true,
-        "description": "**Alias - Assign API**\n\n**Applies to:** S1 pricing tier.\n<br>\n\nThis API allows the caller to assign an alias to reference a resource.<br>\n\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PATCH` request with the `aliasId` in the path and the `resourceId` passed as a query parameter.<br> \n\n\n### Create Alias Response\n\nThe Assign API returns a HTTP `204 No Content` response with an empty body, if the alias was assigned successfully.<br>",
+        "description": "**Alias - Assign API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n<br>\n\nThis API allows the caller to assign an alias to reference a resource.<br>\n\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PATCH` request with the `aliasId` in the path and the `resourceId` passed as a query parameter.<br> \n\n\n### Create Alias Response\n\nThe Assign API returns a HTTP `204 No Content` response with an empty body, if the alias was assigned successfully.<br>",
         "operationId": "Alias_AssignPreview",
         "x-ms-examples": {
           "Assign an alias to a resource": {
@@ -272,7 +306,7 @@
     "/alias/{aliasId}": {
       "delete": {
         "x-publish": true,
-        "description": "**Alias - Delete API**\n\n**Applies to:** S1 pricing tier.\n<br>\n\nThis API allows the caller to delete a previously created alias.<br>    \nYou can also use this API to delete old/unused aliases to create space for new content.\nThis API does not delete the references resource, only the alias referencing the resource.\n\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.<br> \n\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.<br>    \nA HTTP `400 Bad Request` error response will be returned if the alias with the passed-in `aliasId` is not found.    ",
+        "description": "**Alias - Delete API**\n\n**Applies to**: see pricing [tiers](https://azure.microsoft.com/en-us/pricing/details/azure-maps/).\n<br>\n\nThis API allows the caller to delete a previously created alias.<br>    \nYou can also use this API to delete old/unused aliases to create space for new content.\nThis API does not delete the references resource, only the alias referencing the resource.\n\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.<br> \n\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.<br>    \nA HTTP `400 Bad Request` error response will be returned if the alias with the passed-in `aliasId` is not found.    ",
         "operationId": "Alias_DeletePreview",
         "x-ms-examples": {
           "Delete previously created alias": {

diff --git a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Assign.json b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Assign.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "geography": "us",
     "api-version": "1.0",
     "subscription-key": "[subscription-key]",
     "aliasId": "[aliasId]",

diff --git a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Create.json b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Create.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "geography": "us",
     "api-version": "1.0",
     "subscription-key": "[subscription-key]"
   },

diff --git a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Delete.json b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_Delete.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "geography": "us",
     "api-version": "1.0",
     "subscription-key": "[subscription-key]",
     "aliasId": "[aliasId]"

diff --git a/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_List.json b/specification/maps/data-plane/Microsoft.Maps/Alias/preview/1.0/examples/Alias_List.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "geography": "us",
     "api-version": "1.0",
     "subscription-key": "[subscription-key]"
   },

diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/data.json
@@ -5,7 +5,14 @@
     "version": "1.0",
     "description": "APIs for uploading map data to Azure Maps."
   },
-  "host": "atlas.microsoft.com",
+  "x-ms-parameterized-host": {
+    "hostTemplate": "{geography}.atlas.microsoft.com",
+    "parameters": [
+      {
+        "$ref": "#/parameters/GeographicResourceLocation"
+      }
+    ]
+  },
   "schemes": [
     "https"
   ],
@@ -98,6 +105,33 @@
     }
   },
   "parameters": {
+    "GeographicResourceLocation": {
+      "name": "geography",
+      "description": "This parameter specifies where the Azure Maps Creator resource is located.  Valid values are us and eu.",
+      "in": "path",
+      "required": true,
+      "type": "string",
+      "default": "us",
+      "enum": [
+        "us",
+        "eu"
+      ],
+      "x-ms-enum": {
+        "name": "GeographicResourceLocation",
+        "modelAsString": true,
+        "values": [
+          {
+            "value": "us",
+            "description": "Used to access an Azure Maps Creator resource in the United States"
+          },
+          {
+            "value": "eu",
+            "description": "Used to access an Azure Maps Creator resource in Europe"
+          }
+        ]
+      },
+      "x-ms-parameter-location": "client"
+    },
     "ClientId": {
       "name": "x-ms-client-id",
       "description": "Specifies which account is intended for usage in conjunction with the Azure AD security model.  It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management  plane Account API. To use Azure AD security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.",

diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Delete.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Delete.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "geography": "us",
     "api-version": "1.0",
     "subscription-key": "[subscription-key]",
     "udid": "25084fb7-307a-4720-8f91-7952a0b91012"

diff --git a/...fication/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Download.json b/...fication/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Download.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "geography": "us",
     "api-version": "1.0",
     "subscription-key": "[subscription-key]",
     "udid": "25084fb7-307a-4720-8f91-7952a0b91012"

diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/List.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/List.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "geography": "us",
     "api-version": "1.0",
     "subscription-key": "[subscription-key]"
   },

diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Update.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Update.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "geography": "us",
     "api-version": "1.0",
     "subscription-key": "[subscription-key]",
     "udid": "25084fb7-307a-4720-8f91-7952a0b91012",

diff --git a/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Upload.json b/specification/maps/data-plane/Microsoft.Maps/Data/preview/1.0/examples/Upload.json
@@ -1,5 +1,6 @@
 {
   "parameters": {
+    "geography": "us",
     "api-version": "1.0",
     "subscription-key": "[subscription-key]",
     "dataFormat": "geojson",