{ "swagger": "2.0", "info": { "version": "2024-11-01", "title": "Certificates API Client" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates": { "get": { "tags": [ "Certificates" ], "summary": "Get all certificates for a subscription.", "description": "Description for Get all certificates for a subscription.", "operationId": "Certificates_List", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" }, { "name": "$filter", "in": "query", "description": "Return only information specified in the filter (using OData syntax). For example: $filter=KeyVaultId eq 'KeyVaultId'", "type": "string", "x-ms-skip-url-encoding": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./CommonDefinitions.json#/definitions/CertificateCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "List Certificates for subscription": { "$ref": "./examples/ListCertificates.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates": { "get": { "tags": [ "Certificates" ], "summary": "Get all certificates in a resource group.", "description": "Description for Get all certificates in a resource group.", "operationId": "Certificates_ListByResourceGroup", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/CertificateCollection" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "List Certificates by resource group": { "$ref": "./examples/ListCertificatesByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}": { "get": { "tags": [ "Certificates" ], "summary": "Get a certificate.", "description": "Description for Get a certificate.", "operationId": "Certificates_Get", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the certificate.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./CommonDefinitions.json#/definitions/Certificate" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Get Certificate": { "$ref": "./examples/GetCertificate.json" } } }, "put": { "tags": [ "Certificates" ], "summary": "Create or update a certificate.", "description": "Description for Create or update a certificate.", "operationId": "Certificates_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the certificate.", "required": true, "type": "string" }, { "name": "certificateEnvelope", "in": "body", "description": "Details of certificate, if it exists already.", "required": true, "schema": { "$ref": "./CommonDefinitions.json#/definitions/Certificate" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/Certificate" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Create Or Update Certificate": { "$ref": "./examples/CreateOrUpdateCertificate.json" } } }, "delete": { "tags": [ "Certificates" ], "summary": "Delete a certificate.", "description": "Description for Delete a certificate.", "operationId": "Certificates_Delete", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the certificate.", "required": true, "type": "string" }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "Successfully deleted certificate." }, "204": { "description": "Certificate does not exist." }, "default": { "description": "App Service error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Delete Certificate": { "$ref": "./examples/DeleteCertificate.json" } } }, "patch": { "tags": [ "Certificates" ], "summary": "Create or update a certificate.", "description": "Description for Create or update a certificate.", "operationId": "Certificates_Update", "parameters": [ { "$ref": "#/parameters/resourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of the certificate.", "required": true, "type": "string" }, { "name": "certificateEnvelope", "in": "body", "description": "Details of certificate, if it exists already.", "required": true, "schema": { "$ref": "./CommonDefinitions.json#/definitions/CertificatePatchResource" } }, { "$ref": "#/parameters/subscriptionIdParameter" }, { "$ref": "#/parameters/apiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/Certificate" } }, "default": { "description": "App Service error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Patch Certificate": { "$ref": "./examples/PatchCertificate.json" } } } } }, "definitions": {}, "parameters": { "subscriptionIdParameter": { "name": "subscriptionId", "in": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", "required": true, "type": "string", "x-ms-parameter-location": "client" }, "resourceGroupNameParameter": { "name": "resourceGroupName", "in": "path", "description": "Name of the resource group to which the resource belongs.", "required": true, "type": "string", "maxLength": 90, "minLength": 1, "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$", "x-ms-parameter-location": "method" }, "apiVersionParameter": { "name": "api-version", "in": "query", "description": "API Version", "required": true, "type": "string", "x-ms-parameter-location": "client" } }, "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "security": [ { "azure_auth": [ "user_impersonation" ] } ] }