{ "swagger": "2.0", "info": { "version": "2025-07-01", "title": "ContainerApps API Client" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.App/managedEnvironments": { "get": { "tags": [ "ManagedEnvironments" ], "summary": "Get all Environments for a subscription.", "description": "Get all Managed Environments for a subscription.", "operationId": "ManagedEnvironments_ListBySubscription", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManagedEnvironmentsCollection" } }, "default": { "description": "Common error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List environments by subscription": { "$ref": "./examples/ManagedEnvironments_ListBySubscription.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments": { "get": { "tags": [ "ManagedEnvironments" ], "summary": "Get all the Environments in a resource group.", "description": "Get all the Managed Environments in a resource group.", "operationId": "ManagedEnvironments_ListByResourceGroup", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManagedEnvironmentsCollection" } }, "default": { "description": "Common error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List environments by resource group": { "$ref": "./examples/ManagedEnvironments_ListByResourceGroup.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}": { "get": { "tags": [ "ManagedEnvironments" ], "summary": "Get the properties of a Managed Environment.", "description": "Get the properties of a Managed Environment used to host container apps.", "operationId": "ManagedEnvironments_Get", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Environment.", "required": true, "type": "string" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManagedEnvironment" } }, "default": { "description": "Common error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Get environments by name": { "$ref": "./examples/ManagedEnvironments_Get.json" } } }, "put": { "tags": [ "ManagedEnvironments" ], "summary": "Creates or updates a Managed Environment.", "description": "Creates or updates a Managed Environment used to host container apps.", "operationId": "ManagedEnvironments_CreateOrUpdate", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Environment.", "required": true, "type": "string" }, { "name": "environmentEnvelope", "in": "body", "description": "Configuration details of the Environment.", "required": true, "schema": { "$ref": "#/definitions/ManagedEnvironment" } }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManagedEnvironment" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/ManagedEnvironment" } }, "default": { "description": "Common error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Create environments": { "$ref": "./examples/ManagedEnvironments_CreateOrUpdate.json" }, "Create environment with custom infrastructureResourceGroup": { "$ref": "./examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json" } } }, "delete": { "tags": [ "ManagedEnvironments" ], "summary": "Delete a Managed Environment.", "description": "Delete a Managed Environment if it does not have any container apps.", "operationId": "ManagedEnvironments_Delete", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Environment.", "required": true, "type": "string" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Delete operation completed" }, "202": { "description": "Delete operation is in progress" }, "204": { "description": "Environment does not exist" }, "default": { "description": "Common error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Delete environment by name": { "$ref": "./examples/ManagedEnvironments_Delete.json" } }, "x-ms-long-running-operation": true }, "patch": { "tags": [ "ManagedEnvironments" ], "summary": "Update Managed Environment's properties.", "description": "Patches a Managed Environment using JSON Merge Patch", "operationId": "ManagedEnvironments_Update", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Environment.", "required": true, "type": "string" }, { "name": "environmentEnvelope", "in": "body", "description": "Configuration details of the Environment.", "required": true, "schema": { "$ref": "#/definitions/ManagedEnvironment" } }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ManagedEnvironment" } }, "202": { "description": "Patch operation is in progress." }, "default": { "description": "Common error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Patch Managed Environment": { "$ref": "./examples/ManagedEnvironments_Patch.json" } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates": { "get": { "tags": [ "ManagedEnvironments", "Certificates" ], "summary": "Get the Certificates in a given managed environment.", "operationId": "Certificates_List", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./CommonDefinitions.json#/definitions/CertificateCollection" } }, "default": { "description": "Error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "List Certificates by Managed Environment": { "$ref": "./examples/Certificates_ListByManagedEnvironment.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates/{certificateName}": { "get": { "tags": [ "ManagedEnvironments", "Certificates" ], "summary": "Get the specified Certificate.", "operationId": "Certificates_Get", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string" }, { "name": "certificateName", "in": "path", "description": "Name of the Certificate.", "required": true, "type": "string" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./CommonDefinitions.json#/definitions/Certificate" } }, "default": { "description": "Error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Get Certificate": { "$ref": "./examples/Certificate_Get.json" } } }, "put": { "tags": [ "ManagedEnvironments", "Certificates" ], "summary": "Create or Update a Certificate.", "operationId": "Certificates_CreateOrUpdate", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string" }, { "name": "certificateName", "in": "path", "description": "Name of the Certificate.", "required": true, "type": "string" }, { "name": "certificateEnvelope", "in": "body", "description": "Certificate to be created or updated", "schema": { "$ref": "./CommonDefinitions.json#/definitions/Certificate" } }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./CommonDefinitions.json#/definitions/Certificate" } }, "default": { "description": "Error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Create or Update Certificate": { "$ref": "./examples/Certificate_CreateOrUpdate.json" }, "Create or Update Certificate using Managed Identity": { "$ref": "./examples/Certificate_CreateOrUpdate_FromKeyVault.json" } } }, "delete": { "tags": [ "ManagedEnvironments", "Certificates" ], "summary": "Deletes the specified Certificate.", "operationId": "Certificates_Delete", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string" }, { "name": "certificateName", "in": "path", "description": "Name of the Certificate.", "required": true, "type": "string" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Delete operation completed" }, "204": { "description": "Certificate does not exist" }, "default": { "description": "Error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Delete Certificate": { "$ref": "./examples/Certificate_Delete.json" } } }, "patch": { "tags": [ "ManagedEnvironments", "Certificates" ], "summary": "Update properties of a certificate", "description": "Patches a certificate. Currently only patching of tags is supported", "operationId": "Certificates_Update", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string" }, { "name": "certificateName", "in": "path", "description": "Name of the Certificate.", "required": true, "type": "string" }, { "name": "certificateEnvelope", "in": "body", "required": true, "description": "Properties of a certificate that need to be updated", "schema": { "$ref": "./CommonDefinitions.json#/definitions/CertificatePatch" } }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Certificate updated successfully.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/Certificate" } }, "default": { "description": "Common error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Patch Certificate": { "$ref": "./examples/Certificates_Patch.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}": { "get": { "tags": [ "ManagedEnvironments", "ManagedCertificates" ], "summary": "Get the specified Managed Certificate.", "operationId": "ManagedCertificates_Get", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string" }, { "name": "managedCertificateName", "in": "path", "description": "Name of the Managed Certificate.", "required": true, "type": "string" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" } }, "default": { "description": "Error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Get Certificate": { "$ref": "./examples/ManagedCertificate_Get.json" } } }, "put": { "tags": [ "ManagedEnvironments", "ManagedCertificates" ], "summary": "Create or Update a Managed Certificate.", "operationId": "ManagedCertificates_CreateOrUpdate", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string" }, { "name": "managedCertificateName", "in": "path", "description": "Name of the Managed Certificate.", "required": true, "type": "string" }, { "name": "managedCertificateEnvelope", "in": "body", "description": "Managed Certificate to be created or updated", "schema": { "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" } }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" } }, "201": { "description": "Created", "schema": { "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" } }, "400": { "description": "Bad Request.", "x-ms-error-response": true }, "default": { "description": "Error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-examples": { "Create or Update Certificate": { "$ref": "./examples/ManagedCertificate_CreateOrUpdate.json" } } }, "delete": { "tags": [ "ManagedEnvironments", "ManagedCertificates" ], "summary": "Deletes the specified Managed Certificate.", "operationId": "ManagedCertificates_Delete", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string" }, { "name": "managedCertificateName", "in": "path", "description": "Name of the Managed Certificate.", "required": true, "type": "string" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Delete operation completed" }, "204": { "description": "Certificate does not exist" }, "default": { "description": "Error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Delete Certificate": { "$ref": "./examples/ManagedCertificate_Delete.json" } } }, "patch": { "tags": [ "ManagedEnvironments", "ManagedCertificates" ], "summary": "Update tags of a managed certificate", "description": "Patches a managed certificate. Oly patching of tags is supported", "operationId": "ManagedCertificates_Update", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string" }, { "name": "managedCertificateName", "in": "path", "description": "Name of the Managed Certificate.", "required": true, "type": "string" }, { "name": "managedCertificateEnvelope", "in": "body", "required": true, "description": "Properties of a managed certificate that need to be updated", "schema": { "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificatePatch" } }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Managed Certificate updated successfully.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" } }, "default": { "description": "Common error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Patch Managed Certificate": { "$ref": "./examples/ManagedCertificates_Patch.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates": { "get": { "tags": [ "ManagedEnvironments", "ManagedCertificates" ], "summary": "Get the Managed Certificates in a given managed environment.", "operationId": "ManagedCertificates_List", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificateCollection" } }, "default": { "description": "Error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "List Managed Certificates by Managed Environment": { "$ref": "./examples/ManagedCertificates_ListByManagedEnvironment.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/checkNameAvailability": { "post": { "tags": [ "ManagedEnvironments" ], "summary": "Checks the resource name availability.", "description": "Checks if resource name is available.", "operationId": "Namespaces_CheckNameAvailability", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string" }, { "name": "checkNameAvailabilityRequest", "in": "body", "description": "The check name availability request.", "required": true, "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest" } }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" } }, "default": { "description": "Error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "ContainerApps_CheckNameAvailability": { "$ref": "./examples/ContainerApps_CheckNameAvailability.json" }, "Certificates_CheckNameAvailability": { "$ref": "./examples/Certificates_CheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/getAuthtoken": { "post": { "tags": [ "ManagedEnvironments" ], "summary": "Get auth token for a managed environment", "description": "Checks if resource name is available.", "operationId": "ManagedEnvironments_GetAuthToken", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnvironmentAuthToken" } }, "default": { "description": "Error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-examples": { "Get Managed Environment Auth Token": { "$ref": "./examples/ManagedEnvironments_GetAuthToken.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/workloadProfileStates": { "get": { "tags": [ "ManagedEnvironments" ], "summary": "Get all workload Profile States for a Managed Environment..", "description": "Get all workload Profile States for a Managed Environment.", "operationId": "ManagedEnvironments_ListWorkloadProfileStates", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/workloadProfileStatesCollection" } }, "default": { "description": "Common error response.", "schema": { "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List environments by subscription": { "$ref": "./examples/ManagedEnvironments_ListWorkloadProfileStates.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/privateEndpointConnections": { "get": { "tags": [ "ManagedEnvironments", "PrivateEndpointConnections" ], "summary": "List private endpoint connections for a given managed environment.", "operationId": "ManagedEnvironmentPrivateEndpointConnections_List", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string", "pattern": "^[-\\w\\._\\(\\)]+$" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnectionListResult" } }, "default": { "description": "Error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List Private Endpoint Connections by Managed Environment": { "$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "tags": [ "ManagedEnvironments", "PrivateEndpointConnections" ], "summary": "Get a private endpoint connection for a given managed environment.", "operationId": "ManagedEnvironmentPrivateEndpointConnections_Get", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string", "pattern": "^[-\\w\\._\\(\\)]+$" }, { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" } }, "default": { "description": "Error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a Private Endpoint Connection by Managed Environment": { "$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_Get.json" } } }, "put": { "tags": [ "ManagedEnvironments", "PrivateEndpointConnections" ], "summary": "Update the state of a private endpoint connection for a given managed environment.", "operationId": "ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string", "pattern": "^[-\\w\\._\\(\\)]+$" }, { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "name": "privateEndpointConnectionEnvelope", "in": "body", "description": "The resource of private endpoint and its properties", "required": true, "schema": { "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" } }, "201": { "description": "Created", "schema": { "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" } }, "default": { "description": "Error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a Private Endpoint Connection by Managed Environment": { "$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate.json" } }, "x-ms-long-running-operation": true }, "delete": { "tags": [ "ManagedEnvironments", "PrivateEndpointConnections" ], "summary": "Delete a private endpoint connection for a given managed environment.", "operationId": "ManagedEnvironmentPrivateEndpointConnections_Delete", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string", "pattern": "^[-\\w\\._\\(\\)]+$" }, { "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { "description": "Accepted", "headers": { "Location": { "type": "string" } } }, "204": { "description": "No content. Already deleted." }, "default": { "description": "Error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a Private Endpoint Connection by Managed Environment": { "$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_Delete.json" } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/privateLinkResources": { "get": { "tags": [ "ManagedEnvironments", "PrivateLinkResources" ], "summary": "List private link resources for a given managed environment.", "operationId": "ManagedEnvironmentPrivateLinkResources_List", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "environmentName", "in": "path", "description": "Name of the Managed Environment.", "required": true, "type": "string", "pattern": "^[-\\w\\._\\(\\)]+$" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./CommonDefinitions.json#/definitions/PrivateLinkResourceListResult" } }, "default": { "description": "Error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List Private Link Resources by Managed Environment": { "$ref": "./examples/ManagedEnvironmentPrivateLinkResources_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "AppLogsConfiguration": { "description": "Configuration of application logs", "type": "object", "properties": { "destination": { "description": "Logs destination, can be 'log-analytics', 'azure-monitor' or 'none'", "type": "string" }, "logAnalyticsConfiguration": { "description": "Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'", "$ref": "#/definitions/LogAnalyticsConfiguration" } } }, "KedaConfiguration": { "type": "object", "description": "Configuration properties Keda component", "properties": { "version": { "type": "string", "readOnly": true, "description": "The version of Keda" } } }, "DaprConfiguration": { "type": "object", "description": "Configuration properties Dapr component", "properties": { "version": { "type": "string", "readOnly": true, "description": "The version of Dapr" } } }, "VnetConfiguration": { "type": "object", "description": "Configuration properties for apps environment to join a Virtual Network", "properties": { "internal": { "type": "boolean", "description": "Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property", "x-ms-mutability": [ "create", "read" ] }, "infrastructureSubnetId": { "type": "string", "description": "Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges.", "x-ms-mutability": [ "create", "read" ] }, "dockerBridgeCidr": { "type": "string", "description": "CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges.", "x-ms-mutability": [ "create", "read" ] }, "platformReservedCidr": { "type": "string", "description": "IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges.", "x-ms-mutability": [ "create", "read" ] }, "platformReservedDnsIP": { "type": "string", "description": " An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server.", "x-ms-mutability": [ "create", "read" ] } } }, "Mtls": { "type": "object", "description": "Configuration properties for mutual TLS authentication", "properties": { "enabled": { "type": "boolean", "description": "Boolean indicating whether the mutual TLS authentication is enabled" } } }, "IngressConfiguration": { "description": "Settings for the ingress component, including workload profile, scaling, and connection handling.", "type": "object", "properties": { "workloadProfileName": { "description": "Name of the workload profile used by the ingress component. Required.", "type": "string" }, "terminationGracePeriodSeconds": { "description": "Time (in seconds) to allow active connections to complete on termination. Must be between 0 and 3600. Defaults to 480 seconds.", "type": "integer", "format": "int32" }, "headerCountLimit": { "description": "Maximum number of headers per request allowed by the ingress. Must be at least 1. Defaults to 100.", "type": "integer", "format": "int32" }, "requestIdleTimeout": { "description": "Duration (in minutes) before idle requests are timed out. Must be between 4 and 30 inclusive. Defaults to 4 minutes.", "type": "integer", "format": "int32" } } }, "ManagedEnvironment": { "description": "An environment for hosting container apps", "type": "object", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "properties": { "kind": { "type": "string", "description": "Kind of the Environment." }, "identity": { "description": "Managed identities for the Managed Environment to interact with other Azure services without maintaining any secrets or credentials in code.", "$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" }, "properties": { "description": "Managed environment resource specific properties", "type": "object", "properties": { "provisioningState": { "description": "Provisioning state of the Environment.", "enum": [ "Succeeded", "Failed", "Canceled", "Waiting", "InitializationInProgress", "InfrastructureSetupInProgress", "InfrastructureSetupComplete", "ScheduledForDelete", "UpgradeRequested", "UpgradeFailed" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "EnvironmentProvisioningState", "modelAsString": true } }, "daprAIInstrumentationKey": { "type": "string", "description": "Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry", "x-ms-secret": true }, "daprAIConnectionString": { "type": "string", "description": "Application Insights connection string used by Dapr to export Service to Service communication telemetry", "x-ms-secret": true }, "vnetConfiguration": { "description": "Vnet configuration for the environment", "$ref": "#/definitions/VnetConfiguration" }, "deploymentErrors": { "description": "Any errors that occurred during deployment or deployment validation", "type": "string", "readOnly": true }, "defaultDomain": { "description": "Default Domain Name for the cluster", "type": "string", "readOnly": true }, "staticIp": { "description": "Static IP of the Environment", "type": "string", "readOnly": true }, "appLogsConfiguration": { "$ref": "#/definitions/AppLogsConfiguration", "description": "Cluster configuration which enables the log daemon to export app logs to configured destination." }, "zoneRedundant": { "description": "Whether or not this Managed Environment is zone-redundant.", "type": "boolean", "x-ms-mutability": [ "create", "read" ] }, "customDomainConfiguration": { "$ref": "./CommonDefinitions.json#/definitions/CustomDomainConfiguration", "description": "Custom domain configuration for the environment" }, "eventStreamEndpoint": { "description": "The endpoint of the eventstream of the Environment.", "type": "string", "readOnly": true }, "workloadProfiles": { "description": "Workload profiles configured for the Managed Environment.", "type": "array", "items": { "$ref": "#/definitions/WorkloadProfile" }, "x-ms-identifiers": [ "name" ] }, "kedaConfiguration": { "$ref": "#/definitions/KedaConfiguration", "description": "The configuration of Keda component." }, "daprConfiguration": { "$ref": "#/definitions/DaprConfiguration", "description": "The configuration of Dapr component." }, "infrastructureResourceGroup": { "description": "Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet.", "type": "string", "x-ms-mutability": [ "create", "read" ] }, "peerAuthentication": { "description": "Peer authentication settings for the Managed Environment", "type": "object", "properties": { "mtls": { "description": "Mutual TLS authentication settings for the Managed Environment", "$ref": "#/definitions/Mtls" } } }, "peerTrafficConfiguration": { "description": "Peer traffic settings for the Managed Environment", "type": "object", "properties": { "encryption": { "description": "Peer traffic encryption settings for the Managed Environment", "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Boolean indicating whether the peer traffic encryption is enabled" } } } } }, "ingressConfiguration": { "$ref": "#/definitions/IngressConfiguration", "description": "Ingress configuration for the Managed Environment." }, "privateEndpointConnections": { "description": "Private endpoint connections to the resource.", "type": "array", "items": { "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" }, "readOnly": true }, "publicNetworkAccess": { "enum": [ "Enabled", "Disabled" ], "description": "Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled'.", "type": "string", "x-ms-enum": { "name": "PublicNetworkAccess", "modelAsString": true } } }, "x-ms-client-flatten": true } } }, "ManagedEnvironmentsCollection": { "description": "Collection of Environments", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "#/definitions/ManagedEnvironment" } }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } }, "LogAnalyticsConfiguration": { "description": "Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'", "type": "object", "properties": { "customerId": { "description": "Log analytics customer id", "type": "string" }, "sharedKey": { "description": "Log analytics customer key", "type": "string", "x-ms-mutability": [ "create", "update" ], "x-ms-secret": true } } }, "EnvironmentAuthToken": { "description": "Environment Auth Token.", "type": "object", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ], "properties": { "properties": { "description": "Environment auth token resource specific properties", "type": "object", "properties": { "token": { "description": "Auth token value.", "type": "string", "x-ms-secret": true, "readOnly": true }, "expires": { "format": "date-time", "description": "Token expiration date.", "type": "string", "readOnly": true } }, "x-ms-client-flatten": true } } }, "WorkloadProfile": { "description": "Workload profile to scope container app execution.", "type": "object", "properties": { "name": { "$ref": "./CommonDefinitions.json#/definitions/WorkloadProfileName", "description": "Workload profile type for the workloads to run on." }, "workloadProfileType": { "$ref": "./CommonDefinitions.json#/definitions/WorkloadProfileType", "description": "Workload profile type for the workloads to run on." }, "minimumCount": { "type": "integer", "format": "int32", "description": "The minimum capacity." }, "maximumCount": { "type": "integer", "format": "int32", "description": "The maximum capacity." } }, "required": [ "name", "workloadProfileType" ] }, "workloadProfileStates": { "description": "Collection of all the workload Profile States for a Managed Environment..", "type": "object", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ], "properties": { "properties": { "description": "Workload Profile resource specific properties.", "type": "object", "properties": { "minimumCount": { "type": "integer", "format": "int32", "description": "Minimum count of instances." }, "maximumCount": { "type": "integer", "format": "int32", "description": "Maximum count of nodes." }, "currentCount": { "type": "integer", "format": "int32", "description": "Current count of nodes." } } } } }, "workloadProfileStatesCollection": { "description": "Collection of workloadProfileStates", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "Collection of resources.", "type": "array", "items": { "$ref": "#/definitions/workloadProfileStates" } }, "nextLink": { "description": "Link to next page of resources.", "type": "string", "readOnly": true } } } }, "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" ] } ] }