gatewayConfig-2023-09-01/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-09-01-preview/apimgatewayConfigConnections.json at 0771289dd575e62a13d3f57044bc052eaefa27d6 · vidishamsft/gatewayConfig-2023-09-01 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
{
  "swagger": "2.0",
  "info": {
    "title": "ApiManagementClient",
    "description": "Use these REST APIs to manage Azure API Management gateway config connections deployments.",
    "version": "2023-09-01-preview"
  },
  "host": "management.azure.com",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "security": [
    {
      "azure_auth": [
        "user_impersonation"
      ]
    }
  ],
  "securityDefinitions": {
    "azure_auth": {
      "type": "oauth2",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "flow": "implicit",
      "description": "Azure Active Directory OAuth2 Flow.",
      "scopes": {
        "user_impersonation": "impersonate your user account"
      }
    }
  },
  "paths": {
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections": {
      "get": {
        "tags": [
          "ApiManagementGatewayConfigConnection"
        ],
        "operationId": "ApiManagementGatewayConfigConnection_ListByGateway",
        "description": "List all API Management gateway config connections within a gateway.",
        "x-ms-examples": {
          "ApiManagementListGatewayConfigConnection": {
            "$ref": "./examples/ApiManagementListGatewayConfigConnection.json"
          }
        },
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "$ref": "./apimanagement.json#/parameters/GatewayNameParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The API Management gateway config connection list.",
            "schema": {
              "$ref": "./definitions.json#/definitions/ApiManagementGatewayConfigConnectionListResult"

            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}/configConnections/{configConnectionId}": {
      "get": {
        "tags": [
          "ApiManagementGatewayConfigConnection"
        ],
        "operationId": "ApiManagementGatewayConfigConnection_Get",
        "description": "Gets an API Management gateway config connection resource description.",
        "x-ms-examples": {
          "ApiManagementGetGatewayConfigConnection": {
            "$ref": "./examples/ApiManagementGetGatewayConfigConnection.json"
          }
        },
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
          },
          {
            "$ref": "./apimanagement.json#/parameters/GatewayNameParameter"
          },
          {
            "$ref": "./apimanagement.json#/parameters/ConfigConnectionIdParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully got the API Management gateway config connection resource.",
            "schema": {
              "$ref": "./definitions.json#/definitions/ApiManagementGatewayConfigConnectionResource"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
            }
          }
        }
      },
      "put": {
        "tags": [
          "ApiManagementGatewayConfigConnection"
        ],
        "operationId": "ApiManagementGatewayConfigConnection_CreateOrUpdate",
        "description": "Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete.",
        "x-ms-examples": {
          "ApiManagementCreateGatewayConfigConnection": {
            "$ref": "./examples/ApiManagementCreateGatewayConfigConnection.json"
          }
        },
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
          },
          {
            "$ref": "./apimanagement.json#/parameters/GatewayNameParameter"
          },
          {
            "$ref": "./apimanagement.json#/parameters/ConfigConnectionIdParameter"
          },
          {
            "name": "parameters",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "./definitions.json#/definitions/ApiManagementGatewayConfigConnectionResource"
            },
            "description": "Parameters supplied to the CreateOrUpdate API Management gateway config connection operation."
          },
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The gateway config connection was successfully updated.",
            "schema": {
              "$ref": "./definitions.json#/definitions/ApiManagementGatewayConfigConnectionResource"
            }
          },
          "201": {
            "description": "The gateway config connection was successfully created.",
            "schema": {
              "$ref": "./definitions.json#/definitions/ApiManagementGatewayConfigConnectionResource"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-long-running-operation-options": {
          "final-state-via": "location"
        }
      },
      "delete": {
        "tags": [
          "ApiManagementGatewayConfigConnection"
        ],
        "operationId": "ApiManagementGatewayConfigConnection_Delete",
        "description": "Deletes an existing API Management gateway config connection.",
        "x-ms-examples": {
          "ApiManagementGatewayDeleteGateway": {
            "$ref": "./examples/ApiManagementDeleteGatewayConfigConnection.json"
          }
        },
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
          },
          {
            "$ref": "./apimanagement.json#/parameters/GatewayNameParameter"
          },
          {
            "$ref": "./apimanagement.json#/parameters/ConfigConnectionIdParameter"
          },
          {
            "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "The gateway config connection delete request was accepted.",
            "schema": {
              "$ref": "./definitions.json#/definitions/ApiManagementGatewayConfigConnectionResource"
            },
            "headers": {
              "location": {
                "description": "Location header",
                "type": "string"
              }
            }
          },
          "204": {
            "description": "The gateway config connection does not exist."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
            }
          }
        },
        "x-ms-long-running-operation": true
      }
    }
  },
  "parameters": {}
}