|
| 1 | +{ |
| 2 | + "swagger": "2.0", |
| 3 | + "info": { |
| 4 | + "version": "2024-11-01", |
| 5 | + "title": "Certificates API Client" |
| 6 | + }, |
| 7 | + "host": "management.azure.com", |
| 8 | + "schemes": [ |
| 9 | + "https" |
| 10 | + ], |
| 11 | + "consumes": [ |
| 12 | + "application/json" |
| 13 | + ], |
| 14 | + "produces": [ |
| 15 | + "application/json" |
| 16 | + ], |
| 17 | + "paths": { |
| 18 | + "/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates": { |
| 19 | + "get": { |
| 20 | + "tags": [ |
| 21 | + "Certificates" |
| 22 | + ], |
| 23 | + "summary": "Get all certificates for a subscription.", |
| 24 | + "description": "Description for Get all certificates for a subscription.", |
| 25 | + "operationId": "Certificates_List", |
| 26 | + "parameters": [ |
| 27 | + { |
| 28 | + "$ref": "#/parameters/subscriptionIdParameter" |
| 29 | + }, |
| 30 | + { |
| 31 | + "$ref": "#/parameters/apiVersionParameter" |
| 32 | + }, |
| 33 | + { |
| 34 | + "name": "$filter", |
| 35 | + "in": "query", |
| 36 | + "description": "Return only information specified in the filter (using OData syntax). For example: $filter=KeyVaultId eq 'KeyVaultId'", |
| 37 | + "type": "string", |
| 38 | + "x-ms-skip-url-encoding": true |
| 39 | + } |
| 40 | + ], |
| 41 | + "responses": { |
| 42 | + "200": { |
| 43 | + "description": "OK", |
| 44 | + "schema": { |
| 45 | + "$ref": "./CommonDefinitions.json#/definitions/CertificateCollection" |
| 46 | + } |
| 47 | + }, |
| 48 | + "default": { |
| 49 | + "description": "App Service error response.", |
| 50 | + "schema": { |
| 51 | + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" |
| 52 | + } |
| 53 | + } |
| 54 | + }, |
| 55 | + "x-ms-examples": { |
| 56 | + "List Certificates for subscription": { |
| 57 | + "$ref": "./examples/ListCertificates.json" |
| 58 | + } |
| 59 | + }, |
| 60 | + "x-ms-pageable": { |
| 61 | + "nextLinkName": "nextLink" |
| 62 | + } |
| 63 | + } |
| 64 | + }, |
| 65 | + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates": { |
| 66 | + "get": { |
| 67 | + "tags": [ |
| 68 | + "Certificates" |
| 69 | + ], |
| 70 | + "summary": "Get all certificates in a resource group.", |
| 71 | + "description": "Description for Get all certificates in a resource group.", |
| 72 | + "operationId": "Certificates_ListByResourceGroup", |
| 73 | + "parameters": [ |
| 74 | + { |
| 75 | + "$ref": "#/parameters/resourceGroupNameParameter" |
| 76 | + }, |
| 77 | + { |
| 78 | + "$ref": "#/parameters/subscriptionIdParameter" |
| 79 | + }, |
| 80 | + { |
| 81 | + "$ref": "#/parameters/apiVersionParameter" |
| 82 | + } |
| 83 | + ], |
| 84 | + "responses": { |
| 85 | + "200": { |
| 86 | + "description": "OK.", |
| 87 | + "schema": { |
| 88 | + "$ref": "./CommonDefinitions.json#/definitions/CertificateCollection" |
| 89 | + } |
| 90 | + }, |
| 91 | + "default": { |
| 92 | + "description": "App Service error response.", |
| 93 | + "schema": { |
| 94 | + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" |
| 95 | + } |
| 96 | + } |
| 97 | + }, |
| 98 | + "x-ms-examples": { |
| 99 | + "List Certificates by resource group": { |
| 100 | + "$ref": "./examples/ListCertificatesByResourceGroup.json" |
| 101 | + } |
| 102 | + }, |
| 103 | + "x-ms-pageable": { |
| 104 | + "nextLinkName": "nextLink" |
| 105 | + } |
| 106 | + } |
| 107 | + }, |
| 108 | + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}": { |
| 109 | + "get": { |
| 110 | + "tags": [ |
| 111 | + "Certificates" |
| 112 | + ], |
| 113 | + "summary": "Get a certificate.", |
| 114 | + "description": "Description for Get a certificate.", |
| 115 | + "operationId": "Certificates_Get", |
| 116 | + "parameters": [ |
| 117 | + { |
| 118 | + "$ref": "#/parameters/resourceGroupNameParameter" |
| 119 | + }, |
| 120 | + { |
| 121 | + "name": "name", |
| 122 | + "in": "path", |
| 123 | + "description": "Name of the certificate.", |
| 124 | + "required": true, |
| 125 | + "type": "string" |
| 126 | + }, |
| 127 | + { |
| 128 | + "$ref": "#/parameters/subscriptionIdParameter" |
| 129 | + }, |
| 130 | + { |
| 131 | + "$ref": "#/parameters/apiVersionParameter" |
| 132 | + } |
| 133 | + ], |
| 134 | + "responses": { |
| 135 | + "200": { |
| 136 | + "description": "OK", |
| 137 | + "schema": { |
| 138 | + "$ref": "./CommonDefinitions.json#/definitions/Certificate" |
| 139 | + } |
| 140 | + }, |
| 141 | + "default": { |
| 142 | + "description": "App Service error response.", |
| 143 | + "schema": { |
| 144 | + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" |
| 145 | + } |
| 146 | + } |
| 147 | + }, |
| 148 | + "x-ms-examples": { |
| 149 | + "Get Certificate": { |
| 150 | + "$ref": "./examples/GetCertificate.json" |
| 151 | + } |
| 152 | + } |
| 153 | + }, |
| 154 | + "put": { |
| 155 | + "tags": [ |
| 156 | + "Certificates" |
| 157 | + ], |
| 158 | + "summary": "Create or update a certificate.", |
| 159 | + "description": "Description for Create or update a certificate.", |
| 160 | + "operationId": "Certificates_CreateOrUpdate", |
| 161 | + "parameters": [ |
| 162 | + { |
| 163 | + "$ref": "#/parameters/resourceGroupNameParameter" |
| 164 | + }, |
| 165 | + { |
| 166 | + "name": "name", |
| 167 | + "in": "path", |
| 168 | + "description": "Name of the certificate.", |
| 169 | + "required": true, |
| 170 | + "type": "string" |
| 171 | + }, |
| 172 | + { |
| 173 | + "name": "certificateEnvelope", |
| 174 | + "in": "body", |
| 175 | + "description": "Details of certificate, if it exists already.", |
| 176 | + "required": true, |
| 177 | + "schema": { |
| 178 | + "$ref": "./CommonDefinitions.json#/definitions/Certificate" |
| 179 | + } |
| 180 | + }, |
| 181 | + { |
| 182 | + "$ref": "#/parameters/subscriptionIdParameter" |
| 183 | + }, |
| 184 | + { |
| 185 | + "$ref": "#/parameters/apiVersionParameter" |
| 186 | + } |
| 187 | + ], |
| 188 | + "responses": { |
| 189 | + "200": { |
| 190 | + "description": "OK.", |
| 191 | + "schema": { |
| 192 | + "$ref": "./CommonDefinitions.json#/definitions/Certificate" |
| 193 | + } |
| 194 | + }, |
| 195 | + "default": { |
| 196 | + "description": "App Service error response.", |
| 197 | + "schema": { |
| 198 | + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" |
| 199 | + } |
| 200 | + } |
| 201 | + }, |
| 202 | + "x-ms-examples": { |
| 203 | + "Create Or Update Certificate": { |
| 204 | + "$ref": "./examples/CreateOrUpdateCertificate.json" |
| 205 | + } |
| 206 | + } |
| 207 | + }, |
| 208 | + "delete": { |
| 209 | + "tags": [ |
| 210 | + "Certificates" |
| 211 | + ], |
| 212 | + "summary": "Delete a certificate.", |
| 213 | + "description": "Description for Delete a certificate.", |
| 214 | + "operationId": "Certificates_Delete", |
| 215 | + "parameters": [ |
| 216 | + { |
| 217 | + "$ref": "#/parameters/resourceGroupNameParameter" |
| 218 | + }, |
| 219 | + { |
| 220 | + "name": "name", |
| 221 | + "in": "path", |
| 222 | + "description": "Name of the certificate.", |
| 223 | + "required": true, |
| 224 | + "type": "string" |
| 225 | + }, |
| 226 | + { |
| 227 | + "$ref": "#/parameters/subscriptionIdParameter" |
| 228 | + }, |
| 229 | + { |
| 230 | + "$ref": "#/parameters/apiVersionParameter" |
| 231 | + } |
| 232 | + ], |
| 233 | + "responses": { |
| 234 | + "200": { |
| 235 | + "description": "Successfully deleted certificate." |
| 236 | + }, |
| 237 | + "204": { |
| 238 | + "description": "Certificate does not exist." |
| 239 | + }, |
| 240 | + "default": { |
| 241 | + "description": "App Service error response.", |
| 242 | + "schema": { |
| 243 | + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" |
| 244 | + } |
| 245 | + } |
| 246 | + }, |
| 247 | + "x-ms-examples": { |
| 248 | + "Delete Certificate": { |
| 249 | + "$ref": "./examples/DeleteCertificate.json" |
| 250 | + } |
| 251 | + } |
| 252 | + }, |
| 253 | + "patch": { |
| 254 | + "tags": [ |
| 255 | + "Certificates" |
| 256 | + ], |
| 257 | + "summary": "Create or update a certificate.", |
| 258 | + "description": "Description for Create or update a certificate.", |
| 259 | + "operationId": "Certificates_Update", |
| 260 | + "parameters": [ |
| 261 | + { |
| 262 | + "$ref": "#/parameters/resourceGroupNameParameter" |
| 263 | + }, |
| 264 | + { |
| 265 | + "name": "name", |
| 266 | + "in": "path", |
| 267 | + "description": "Name of the certificate.", |
| 268 | + "required": true, |
| 269 | + "type": "string" |
| 270 | + }, |
| 271 | + { |
| 272 | + "name": "certificateEnvelope", |
| 273 | + "in": "body", |
| 274 | + "description": "Details of certificate, if it exists already.", |
| 275 | + "required": true, |
| 276 | + "schema": { |
| 277 | + "$ref": "./CommonDefinitions.json#/definitions/CertificatePatchResource" |
| 278 | + } |
| 279 | + }, |
| 280 | + { |
| 281 | + "$ref": "#/parameters/subscriptionIdParameter" |
| 282 | + }, |
| 283 | + { |
| 284 | + "$ref": "#/parameters/apiVersionParameter" |
| 285 | + } |
| 286 | + ], |
| 287 | + "responses": { |
| 288 | + "200": { |
| 289 | + "description": "OK.", |
| 290 | + "schema": { |
| 291 | + "$ref": "./CommonDefinitions.json#/definitions/Certificate" |
| 292 | + } |
| 293 | + }, |
| 294 | + "default": { |
| 295 | + "description": "App Service error response.", |
| 296 | + "schema": { |
| 297 | + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" |
| 298 | + } |
| 299 | + } |
| 300 | + }, |
| 301 | + "x-ms-examples": { |
| 302 | + "Patch Certificate": { |
| 303 | + "$ref": "./examples/PatchCertificate.json" |
| 304 | + } |
| 305 | + } |
| 306 | + } |
| 307 | + } |
| 308 | + }, |
| 309 | + "definitions": {}, |
| 310 | + "parameters": { |
| 311 | + "subscriptionIdParameter": { |
| 312 | + "name": "subscriptionId", |
| 313 | + "in": "path", |
| 314 | + "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", |
| 315 | + "required": true, |
| 316 | + "type": "string", |
| 317 | + "x-ms-parameter-location": "client" |
| 318 | + }, |
| 319 | + "resourceGroupNameParameter": { |
| 320 | + "name": "resourceGroupName", |
| 321 | + "in": "path", |
| 322 | + "description": "Name of the resource group to which the resource belongs.", |
| 323 | + "required": true, |
| 324 | + "type": "string", |
| 325 | + "maxLength": 90, |
| 326 | + "minLength": 1, |
| 327 | + "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", |
| 328 | + "x-ms-parameter-location": "method" |
| 329 | + }, |
| 330 | + "apiVersionParameter": { |
| 331 | + "name": "api-version", |
| 332 | + "in": "query", |
| 333 | + "description": "API Version", |
| 334 | + "required": true, |
| 335 | + "type": "string", |
| 336 | + "x-ms-parameter-location": "client" |
| 337 | + } |
| 338 | + }, |
| 339 | + "securityDefinitions": { |
| 340 | + "azure_auth": { |
| 341 | + "type": "oauth2", |
| 342 | + "description": "Azure Active Directory OAuth2 Flow", |
| 343 | + "flow": "implicit", |
| 344 | + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", |
| 345 | + "scopes": { |
| 346 | + "user_impersonation": "impersonate your user account" |
| 347 | + } |
| 348 | + } |
| 349 | + }, |
| 350 | + "security": [ |
| 351 | + { |
| 352 | + "azure_auth": [ |
| 353 | + "user_impersonation" |
| 354 | + ] |
| 355 | + } |
| 356 | + ] |
| 357 | +} |
0 commit comments