feat(apim): Add new tracing API

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/apimgateways.json

@@ -1318,6 +1318,154 @@
           }
         }
       }
+    },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/invalidateDebugCredentials": {
+      "post": {
+        "tags": [
+          "GatewayInvalidateDebugCredentials"
+        ],
+        "operationId": "Gateway_InvalidateDebugCredentials",
+        "description": "Action is invalidating all debug credentials issued for gateway.",
+        "x-ms-examples": {
+          "ApiManagementGatewayInvalidateDebugCredentials": {
+            "$ref": "./examples/ApiManagementGatewayInvalidateDebugCredentials.json"
+          }
+        },
+        "parameters": [
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+          },
+          {
+            "$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
+          },
+          {
+            "$ref": "./apimanagement.json#/parameters/GatewayIdParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "All debug credentials for gateway are now invalidated."
+          },
+          "default": {
+            "description": "Error response describing why the operation failed.",
+            "schema": {
+              "$ref": "./apimanagement.json#/definitions/ErrorResponse"
+            }
+          }
+        }
+      }
+    },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/getDebugCredentials": {
+      "post": {
+        "tags": [
+          "GatewayGetDebugCredentials"
+        ],
+        "operationId": "Gateway_GetDebugCredentials",
+        "description": "Create new debug credentials for gateway.",
+        "x-ms-examples": {
+          "ApiManagementGatewayGetDebugCredentials": {
+            "$ref": "./examples/ApiManagementGatewayGetDebugCredentials.json"
+          }
+        },
+        "parameters": [
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+          },
+          {
+            "$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
+          },
+          {
+            "$ref": "./apimanagement.json#/parameters/GatewayIdParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+          },
+          {
+            "name": "parameters",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "./definitions.json#/definitions/GatewayGetDebugCredentialsContract"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The response body contains debug credentials to use in gateway.",
+            "schema": {
+              "$ref": "./definitions.json#/definitions/GatewayDebugCredentialsContract"
+            }
+          },
+          "default": {
+            "description": "Error response describing why the operation failed.",
+            "schema": {
+              "$ref": "./apimanagement.json#/definitions/ErrorResponse"
+            }
+          }
+        }
+      }
+    },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/getTrace": {
+      "post": {
+        "tags": [
+          "GatewayGetTrace"
+        ],
+        "operationId": "Gateway_GetTrace",
+        "description": "Fetches trace collected by gateway.",
+        "x-ms-examples": {
+          "ApiManagementGatewayGetTrace": {
+            "$ref": "./examples/ApiManagementGatewayGetTrace.json"
+          }
+        },
+        "parameters": [
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
+          },
+          {
+            "$ref": "./apimanagement.json#/parameters/ServiceNameParameter"
+          },
+          {
+            "$ref": "./apimanagement.json#/parameters/GatewayIdParameter"
+          },
+          {
+            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
+          },
+          {
+            "name": "parameters",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "./definitions.json#/definitions/GatewayGetTraceContract"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The response body contains trace collected by gateway.",
+            "schema": {
+              "$ref": "./definitions.json#/definitions/GatewayTraceContract"
+            }
+          },
+          "default": {
+            "description": "Error response describing why the operation failed.",
+            "schema": {
+              "$ref": "./apimanagement.json#/definitions/ErrorResponse"
+            }
+          }
+        }
+      }
     }
   },
   "definitions": {},

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json

@@ -8761,6 +8761,73 @@
         "productId"
       ],
       "description": "Tag-product link entity properties."
+    },
+    "GatewayGetDebugCredentialsContract": {
+      "type": "object",
+      "properties": {
+        "credentialsExpireAfter": {
+          "type": "string",
+          "format": "duration",
+          "description": "After what period of time to make credentials expire."
+        },
+        "purposes": {
+          "type": "array",
+          "description": "Purposes of debug credential.",
+          "items": {
+            "type": "string",
+            "description": "Purpose of debug credential.",
+            "enum": [
+              "tracing"
+            ],
+            "x-ms-enum": {
+              "name": "GatewayGetDebugCredentialsContractPurpose",
+              "modelAsString": true,
+              "values": [
+                {
+                  "value": "tracing",
+                  "description": "The tracing purpose."
+                }
+              ]
+            }
+          }
+        },
+        "apiId": {
+          "type": "string",
+          "description": "Full resource Id of an API."
+        }
+      },
+      "required": [
+        "credentialsExpireAfter",
+        "purposes",
+        "apiId"
+      ],
+      "description": "Get debug credentials properties."
+    },
+    "GatewayDebugCredentialsContract": {
+      "type": "object",
+      "properties": {
+        "token": {
+          "type": "string",
+          "description": "Gateway debug token."
+        }
+      },
+      "description": "Gateway debug credentials."
+    },
+    "GatewayGetTraceContract": {
+      "type": "object",
+      "properties": {
+        "traceId": {
+          "type": "string",
+          "description": "Trace id."
+        }
+      },
+      "description": "Get trace properties."
+    },
+    "GatewayTraceContract": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": true,
+      "description": "Trace collected in gateway."
     }
   },
   "parameters": {}

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/examples/ApiManagementGatewayGetDebugCredentials.json

@@ -0,0 +1,23 @@
+{
+  "parameters": {
+    "serviceName": "apimService1",
+    "resourceGroupName": "rg1",
+    "api-version": "2023-03-01-preview",
+    "subscriptionId": "subid",
+    "gatewayId": "gw1",
+    "parameters": {
+      "credentialsExpireAfter": "PT1H",
+      "apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1",
+      "purposes": [
+        "tracing"
+      ]
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "token": "p=tracing&aid=a1&ex=20230504000000&sn=ZdfxSJoCsOJE0/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/8LchGl7gu/Q=="
+      }
+    }
+  }
+}

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/examples/ApiManagementGatewayGetTrace.json

@@ -0,0 +1,112 @@
+{
+  "parameters": {
+    "serviceName": "apimService1",
+    "resourceGroupName": "rg1",
+    "api-version": "2023-03-01-preview",
+    "subscriptionId": "subid",
+    "gatewayId": "gw1",
+    "parameters": {
+      "traceId": "CrDvXXXXXXXXXXXXXVU3ZA2-1"
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "serviceName": "apimService1",
+        "traceId": "1e0447d4-XXXX-XXXX-XXXX-dbdb8098a0d3",
+        "traceEntries": {
+          "inbound": [
+            {
+              "source": "api-inspector",
+              "timestamp": "2023-05-03T12:03:04.6899436Z",
+              "elapsed": "00:00:00.2983315",
+              "data": {
+                "request": {
+                  "method": "GET",
+                  "url": "https://proxy.msitesting.net/6452XXXXXXXXXXXX9c2facb1/64524dXXXXXXXXXXXX2facb3?subscription-key=117313e70XXXXXXXXXXXX38ba4658ca3",
+                  "headers": [
+                    {
+                      "name": "Host",
+                      "value": "proxy.msitesting.net"
+                    }
+                  ]
+                }
+              }
+            },
+            {
+              "source": "api-inspector",
+              "timestamp": "2023-05-03T12:03:04.6969650Z",
+              "elapsed": "00:00:00.3046329",
+              "data": {
+                "configuration": {
+                  "api": {
+                    "from": "/6452XXXXXXXXXXXX9c2facb1",
+                    "to": {
+                      "scheme": "http",
+                      "host": "msitesting.net",
+                      "port": 80,
+                      "path": "/",
+                      "queryString": "",
+                      "query": {},
+                      "isDefaultPort": true
+                    },
+                    "version": null,
+                    "revision": "1"
+                  },
+                  "operation": {
+                    "method": "GET",
+                    "uriTemplate": "/64524dXXXXXXXXXXXX2facb3"
+                  },
+                  "user": "-",
+                  "product": "-"
+                }
+              }
+            },
+            {
+              "source": "cors",
+              "timestamp": "2023-05-03T12:03:04.9901631Z",
+              "elapsed": "00:00:00.5972352",
+              "data": "Origin header was missing or empty and the request was classified as not cross-domain. CORS policy was not applied."
+            },
+            {
+              "source": "set-status",
+              "timestamp": "2023-05-03T12:03:05.0031202Z",
+              "elapsed": "00:00:00.6107970",
+              "data": {
+                "message": [
+                  "Response status code was set to 200",
+                  "Response status reason was set to 'OK'"
+                ]
+              }
+            },
+            {
+              "source": "return-response",
+              "timestamp": "2023-05-03T12:03:05.0086543Z",
+              "elapsed": "00:00:00.6164228",
+              "data": {
+                "message": "Return response was applied",
+                "response": {
+                  "status": {
+                    "code": "OK",
+                    "reason": "OK"
+                  },
+                  "headers": []
+                }
+              }
+            }
+          ],
+          "outbound": [
+            {
+              "source": "transfer-response",
+              "timestamp": "2023-05-03T12:03:05.0438287Z",
+              "elapsed": "00:00:00.6510195",
+              "data": {
+                "message": "Response has been sent to the caller in full"
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+}

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/examples/ApiManagementGatewayInvalidateDebugCredentials.json

@@ -0,0 +1,12 @@
+{
+  "parameters": {
+    "serviceName": "apimService1",
+    "resourceGroupName": "rg1",
+    "api-version": "2023-03-01-preview",
+    "subscriptionId": "subid",
+    "gatewayId": "gw1"
+  },
+  "responses": {
+    "204": {}
+  }
+}