{ "swagger": "2.0", "info": { "title": "Applications.Core Management APIs", "version": "2023-10-01-preview", "description": "REST APIs for Applications.Core", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "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" } } }, "tags": [ { "name": "Operations" }, { "name": "Environments" }, { "name": "Applications" }, { "name": "Containers" }, { "name": "Gateways" }, { "name": "SecretStores" }, { "name": "Volumes" }, { "name": "Extenders" } ], "paths": { "/{rootScope}/providers/Applications.Core/applications": { "get": { "operationId": "Applications_ListByScope", "tags": [ "Applications" ], "description": "List ApplicationResource resources by Scope", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get applications by resource group": { "$ref": "./examples/Applications_List.json" }, "Get applications by rootScope": { "$ref": "./examples/Applications_ListByScope.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{rootScope}/providers/Applications.Core/applications/{applicationName}": { "get": { "operationId": "Applications_Get", "tags": [ "Applications" ], "description": "Get a ApplicationResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "applicationName", "in": "path", "description": "The application name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an application resource": { "$ref": "./examples/Applications_Get.json" } } }, "put": { "operationId": "Applications_CreateOrUpdate", "tags": [ "Applications" ], "description": "Create a ApplicationResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "applicationName", "in": "path", "description": "The application name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/ApplicationResource" } } ], "responses": { "200": { "description": "Resource 'ApplicationResource' update operation succeeded", "schema": { "$ref": "#/definitions/ApplicationResource" } }, "201": { "description": "Resource 'ApplicationResource' create operation succeeded", "schema": { "$ref": "#/definitions/ApplicationResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update an application resource": { "$ref": "./examples/Applications_CreateOrUpdate.json" } } }, "patch": { "operationId": "Applications_Update", "tags": [ "Applications" ], "description": "Update a ApplicationResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "applicationName", "in": "path", "description": "The application name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/ApplicationResourceUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update (Patch) an application resource": { "$ref": "./examples/Applications_Update.json" } } }, "delete": { "operationId": "Applications_Delete", "tags": [ "Applications" ], "description": "Delete a ApplicationResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "applicationName", "in": "path", "description": "The application name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an application resource": { "$ref": "./examples/Applications_Delete.json" } } } }, "/{rootScope}/providers/Applications.Core/applications/{applicationName}/getGraph": { "post": { "operationId": "Applications_GetGraph", "tags": [ "Applications" ], "description": "Gets the application graph and resources.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "applicationName", "in": "path", "description": "The application name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGraphResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } } }, "/{rootScope}/providers/Applications.Core/containers": { "get": { "operationId": "Containers_ListByScope", "tags": [ "Containers" ], "description": "List ContainerResource resources by Scope", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ContainerResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List containers at resource group": { "$ref": "./examples/Containers_List.json" }, "List containers at root scope": { "$ref": "./examples/Containers_ListByScope.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{rootScope}/providers/Applications.Core/containers/{containerName}": { "get": { "operationId": "Containers_Get", "tags": [ "Containers" ], "description": "Get a ContainerResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "containerName", "in": "path", "description": "Container name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ContainerResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an container resource": { "$ref": "./examples/Containers_Get.json" } } }, "put": { "operationId": "Containers_CreateOrUpdate", "tags": [ "Containers" ], "description": "Create a ContainerResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "containerName", "in": "path", "description": "Container name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/ContainerResource" } } ], "responses": { "200": { "description": "Resource 'ContainerResource' update operation succeeded", "schema": { "$ref": "#/definitions/ContainerResource" } }, "201": { "description": "Resource 'ContainerResource' create operation succeeded", "schema": { "$ref": "#/definitions/ContainerResource" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update an container resource": { "$ref": "./examples/Containers_CreateOrUpdate.json" }, "Create or update an container resource with base manifest": { "$ref": "./examples/Containers_CreateOrUpdate_BaseManifest.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Containers_Update", "tags": [ "Containers" ], "description": "Update a ContainerResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "containerName", "in": "path", "description": "Container name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/ContainerResourceUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ContainerResource" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Containers_Delete", "tags": [ "Containers" ], "description": "Delete a ContainerResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "containerName", "in": "path", "description": "Container name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an container resource": { "$ref": "./examples/Containers_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/{rootScope}/providers/Applications.Core/environments": { "get": { "operationId": "Environments_ListByScope", "tags": [ "Environments" ], "description": "List EnvironmentResource resources by Scope", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EnvironmentResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get environments by resource group": { "$ref": "./examples/Environments_List.json" }, "Get environments by rootScope": { "$ref": "./examples/Environments_ListByScope.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{rootScope}/providers/Applications.Core/environments/{environmentName}": { "get": { "operationId": "Environments_Get", "tags": [ "Environments" ], "description": "Get a EnvironmentResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "environmentName", "in": "path", "description": "environment name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EnvironmentResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an environment resource": { "$ref": "./examples/Environments_GetEnv0.json" } } }, "put": { "operationId": "Environments_CreateOrUpdate", "tags": [ "Environments" ], "description": "Create a EnvironmentResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "environmentName", "in": "path", "description": "environment name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/EnvironmentResource" } } ], "responses": { "200": { "description": "Resource 'EnvironmentResource' update operation succeeded", "schema": { "$ref": "#/definitions/EnvironmentResource" } }, "201": { "description": "Resource 'EnvironmentResource' create operation succeeded", "schema": { "$ref": "#/definitions/EnvironmentResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update an environment resource": { "$ref": "./examples/Environments_CreateOrUpdate.json" } } }, "patch": { "operationId": "Environments_Update", "tags": [ "Environments" ], "description": "Update a EnvironmentResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "environmentName", "in": "path", "description": "environment name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/EnvironmentResourceUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/EnvironmentResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update an environment resource": { "$ref": "./examples/Environments_PatchEnv0.json" } } }, "delete": { "operationId": "Environments_Delete", "tags": [ "Environments" ], "description": "Delete a EnvironmentResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "environmentName", "in": "path", "description": "environment name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an environment resource": { "$ref": "./examples/Environments_DeleteEnv0.json" } } } }, "/{rootScope}/providers/Applications.Core/environments/{environmentName}/getMetadata": { "post": { "operationId": "Environments_GetMetadata", "tags": [ "Environments" ], "description": "Gets recipe metadata including parameters and any constraints on the parameters.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "environmentName", "in": "path", "description": "environment name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/RecipeGetMetadata" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecipeGetMetadataResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get recipe metadata from environment": { "$ref": "./examples/Environments_GetRecipeMetadata.json" } } } }, "/{rootScope}/providers/Applications.Core/extenders": { "get": { "operationId": "Extenders_ListByScope", "tags": [ "Extenders" ], "description": "List ExtenderResource resources by Scope", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExtenderResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List extender resources by resource group": { "$ref": "./examples/Extenders_List.json" }, "List extender resources by rootScope": { "$ref": "./examples/Extenders_ListByRootScope.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{rootScope}/providers/Applications.Core/extenders/{extenderName}": { "get": { "operationId": "Extenders_Get", "tags": [ "Extenders" ], "description": "Get a ExtenderResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "extenderName", "in": "path", "description": "The name of the ExtenderResource portable resource", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExtenderResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an extender resource": { "$ref": "./examples/Extenders_Get.json" } } }, "put": { "operationId": "Extenders_CreateOrUpdate", "tags": [ "Extenders" ], "description": "Create a ExtenderResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "extenderName", "in": "path", "description": "The name of the ExtenderResource portable resource", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/ExtenderResource" } } ], "responses": { "200": { "description": "Resource 'ExtenderResource' update operation succeeded", "schema": { "$ref": "#/definitions/ExtenderResource" } }, "201": { "description": "Resource 'ExtenderResource' create operation succeeded", "schema": { "$ref": "#/definitions/ExtenderResource" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update an extender resource": { "$ref": "./examples/Extenders_CreateOrUpdate.json" }, "Create or Update an extender resource with recipe": { "$ref": "./examples/Extenders_CreateOrUpdateWithRecipe.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Extenders_Update", "tags": [ "Extenders" ], "description": "Update a ExtenderResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "extenderName", "in": "path", "description": "The name of the ExtenderResource portable resource", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/ExtenderResourceUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExtenderResource" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update an extender resource": { "$ref": "./examples/Extenders_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Extenders_Delete", "tags": [ "Extenders" ], "description": "Delete a ExtenderResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "extenderName", "in": "path", "description": "The name of the ExtenderResource portable resource", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an extender resource": { "$ref": "./examples/Extenders_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/{rootScope}/providers/Applications.Core/extenders/{extenderName}/listSecrets": { "post": { "operationId": "Extenders_ListSecrets", "tags": [ "Extenders" ], "description": "Lists secrets values for the specified Extender resource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "extenderName", "in": "path", "description": "The name of the ExtenderResource portable resource", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ExtenderListSecretResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List the secrets from extender resources": { "$ref": "./examples/Extenders_ListSecrets.json" } } } }, "/{rootScope}/providers/Applications.Core/gateways": { "get": { "operationId": "Gateways_ListByScope", "tags": [ "Gateways" ], "description": "List GatewayResource resources by Scope", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GatewayResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List gateway resources": { "$ref": "./examples/Gateways_List.json" }, "List gateway resources by rootScope": { "$ref": "./examples/Gateways_ListByScope.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{rootScope}/providers/Applications.Core/gateways/{gatewayName}": { "get": { "operationId": "Gateways_Get", "tags": [ "Gateways" ], "description": "Get a GatewayResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "gatewayName", "in": "path", "description": "Gateway name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GatewayResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an gateway resource": { "$ref": "./examples/Gateways_Get.json" } } }, "put": { "operationId": "Gateways_Create", "tags": [ "Gateways" ], "description": "Create a GatewayResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "gatewayName", "in": "path", "description": "Gateway name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/GatewayResource" } } ], "responses": { "200": { "description": "Resource 'GatewayResource' update operation succeeded", "schema": { "$ref": "#/definitions/GatewayResource" } }, "201": { "description": "Resource 'GatewayResource' create operation succeeded", "schema": { "$ref": "#/definitions/GatewayResource" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Gateways_CreateOrUpdate", "tags": [ "Gateways" ], "description": "Update a GatewayResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "gatewayName", "in": "path", "description": "Gateway name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/GatewayResourceUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/GatewayResource" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a gateway resource": { "$ref": "./examples/Gateways_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Gateways_Delete", "tags": [ "Gateways" ], "description": "Delete a GatewayResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "gatewayName", "in": "path", "description": "Gateway name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an gateway resource": { "$ref": "./examples/Gateways_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/{rootScope}/providers/Applications.Core/secretStores": { "get": { "operationId": "SecretStores_ListByScope", "tags": [ "SecretStores" ], "description": "List SecretStoreResource resources by Scope", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SecretStoreResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List secret stores": { "$ref": "./examples/SecretStores_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{rootScope}/providers/Applications.Core/secretStores/{secretStoreName}": { "get": { "operationId": "SecretStores_Get", "tags": [ "SecretStores" ], "description": "Get a SecretStoreResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "secretStoreName", "in": "path", "description": "SecretStore name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SecretStoreResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a secret store": { "$ref": "./examples/SecretStores_Get.json" }, "Get a secret store for Azure Keyvault": { "$ref": "./examples/SecretStores_Get_AzureKeyVault.json" } } }, "put": { "operationId": "SecretStores_CreateOrUpdate", "tags": [ "SecretStores" ], "description": "Create a SecretStoreResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "secretStoreName", "in": "path", "description": "SecretStore name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/SecretStoreResource" } } ], "responses": { "200": { "description": "Resource 'SecretStoreResource' update operation succeeded", "schema": { "$ref": "#/definitions/SecretStoreResource" } }, "201": { "description": "Resource 'SecretStoreResource' create operation succeeded", "schema": { "$ref": "#/definitions/SecretStoreResource" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update a secret store resource with azure keyvault": { "$ref": "./examples/SecretStores_CreateOrUpdate.json" }, "Create or Update a secret store resource with global scope": { "$ref": "./examples/SecretStores_CreateOrUpdate_GlobalScope.json" }, "Create or Update a secret store resource with valueFrom": { "$ref": "./examples/SecretStores_CreateOrUpdateValueFrom.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "SecretStores_Update", "tags": [ "SecretStores" ], "description": "Update a SecretStoreResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "secretStoreName", "in": "path", "description": "SecretStore name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/SecretStoreResourceUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SecretStoreResource" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a secret store": { "$ref": "./examples/SecretStores_Update.json" }, "Update a secret store resource": { "$ref": "./examples/SecretStores_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "SecretStores_Delete", "tags": [ "SecretStores" ], "description": "Delete a SecretStoreResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "secretStoreName", "in": "path", "description": "SecretStore name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/{rootScope}/providers/Applications.Core/secretStores/{secretStoreName}/listSecrets": { "post": { "operationId": "SecretStores_ListSecrets", "tags": [ "SecretStores" ], "description": "List the secrets of a secret stores.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "secretStoreName", "in": "path", "description": "SecretStore name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SecretStoreListSecretsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List secret stores": { "$ref": "./examples/SecretStores_ListSecrets.json" } } } }, "/{rootScope}/providers/Applications.Core/volumes": { "get": { "operationId": "Volumes_ListByScope", "tags": [ "Volumes" ], "description": "List VolumeResource resources by Scope", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VolumeResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List volumes by resource group": { "$ref": "./examples/Volumes_List.json" }, "List volumes by rootScope": { "$ref": "./examples/Volumes_ListByScope.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{rootScope}/providers/Applications.Core/volumes/{volumeName}": { "get": { "operationId": "Volumes_Get", "tags": [ "Volumes" ], "description": "Get a VolumeResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "volumeName", "in": "path", "description": "Volume name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VolumeResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a volume": { "$ref": "./examples/Volumes_Get.json" } } }, "put": { "operationId": "Volumes_CreateOrUpdate", "tags": [ "Volumes" ], "description": "Create a VolumeResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "volumeName", "in": "path", "description": "Volume name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/VolumeResource" } } ], "responses": { "200": { "description": "Resource 'VolumeResource' update operation succeeded", "schema": { "$ref": "#/definitions/VolumeResource" } }, "201": { "description": "Resource 'VolumeResource' create operation succeeded", "schema": { "$ref": "#/definitions/VolumeResource" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or update a volume": { "$ref": "./examples/Volumes_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Volumes_Update", "tags": [ "Volumes" ], "description": "Update a VolumeResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "volumeName", "in": "path", "description": "Volume name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/VolumeResourceUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/VolumeResource" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a volume": { "$ref": "./examples/Volumes_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Volumes_Delete", "tags": [ "Volumes" ], "description": "Delete a VolumeResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "volumeName", "in": "path", "description": "Volume name", "required": true, "type": "string", "maxLength": 63, "pattern": "^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a volume": { "$ref": "./examples/Volumes_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/providers/Applications.Core/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get the operations for the Applications.Core resource provider": { "$ref": "./examples/Operations_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "ACIRuntimeProperties": { "type": "object", "description": "The runtime configuration properties for Kubernetes", "properties": { "gatewayID": { "type": "string", "description": "The ID of the gateway that is providing L7 traffic for the container" } } }, "ApplicationGraphConnection": { "type": "object", "description": "Describes the connection between two resources.", "properties": { "id": { "type": "string", "description": "The resource ID " }, "direction": { "$ref": "#/definitions/Direction", "description": "The direction of the connection. 'Outbound' indicates this connection specifies the ID of the destination and 'Inbound' indicates indicates this connection specifies the ID of the source." } }, "required": [ "id", "direction" ] }, "ApplicationGraphOutputResource": { "type": "object", "description": "Describes an output resource that comprises an application graph resource.", "properties": { "id": { "type": "string", "description": "The resource ID." }, "type": { "type": "string", "description": "The resource type." }, "name": { "type": "string", "description": "The resource name." } }, "required": [ "id", "type", "name" ] }, "ApplicationGraphResource": { "type": "object", "description": "Describes a resource in the application graph.", "properties": { "id": { "type": "string", "description": "The resource ID." }, "type": { "type": "string", "description": "The resource type." }, "name": { "type": "string", "description": "The resource name." }, "outputResources": { "type": "array", "description": "The resources that comprise this resource.", "items": { "$ref": "#/definitions/ApplicationGraphOutputResource" }, "x-ms-identifiers": [ "id" ] }, "connections": { "type": "array", "description": "The connections between resources in the application graph.", "items": { "$ref": "#/definitions/ApplicationGraphConnection" }, "x-ms-identifiers": [] }, "provisioningState": { "type": "string", "description": "provisioningState of this resource." } }, "required": [ "id", "type", "name", "outputResources", "connections", "provisioningState" ] }, "ApplicationGraphResponse": { "type": "object", "description": "Describes the application architecture and its dependencies.", "properties": { "resources": { "type": "array", "description": "The resources in the application graph.", "items": { "$ref": "#/definitions/ApplicationGraphResource" }, "x-ms-identifiers": [ "id" ] } }, "required": [ "resources" ] }, "ApplicationProperties": { "type": "object", "description": "Application properties", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the asynchronous operation.", "readOnly": true }, "environment": { "type": "string", "description": "Fully qualified resource ID for the environment that the application is linked to" }, "extensions": { "type": "array", "description": "The application extension.", "items": { "$ref": "#/definitions/Extension" }, "x-ms-identifiers": [] }, "status": { "$ref": "#/definitions/ResourceStatus", "description": "Status of a resource.", "readOnly": true } }, "required": [ "environment" ] }, "ApplicationResource": { "type": "object", "description": "Radius Application resource", "properties": { "properties": { "$ref": "#/definitions/ApplicationProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, "x-ms-mutability": [ "read", "create" ] } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ] }, "ApplicationResourceListResult": { "type": "object", "description": "The response of a ApplicationResource list operation.", "properties": { "value": { "type": "array", "description": "The ApplicationResource items on this page", "items": { "$ref": "#/definitions/ApplicationResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ApplicationResourceUpdate": { "type": "object", "description": "Radius Application resource", "allOf": [ { "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" } ] }, "AuthConfig": { "type": "object", "description": "Authentication information used to access private Terraform module sources. Supported module sources: Git.", "properties": { "git": { "$ref": "#/definitions/GitAuthConfig", "description": "Authentication information used to access private Terraform modules from Git repository sources." } } }, "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": { "type": "object", "title": "Tracked Resource", "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" } ] }, "AzureContainerInstanceCompute": { "type": "object", "description": "The Azure container instance compute configuration", "properties": { "resourceGroup": { "type": "string", "description": "The resource group to use for the environment." } }, "allOf": [ { "$ref": "#/definitions/EnvironmentCompute" } ], "x-ms-discriminator-value": "aci" }, "AzureContainerInstanceExtension": { "type": "object", "description": "Azure container instance resource group extension of a environment/application resource.", "properties": { "resourceGroup": { "type": "string", "description": "The resource group of the application environment." } }, "required": [ "resourceGroup" ], "allOf": [ { "$ref": "#/definitions/Extension" } ], "x-ms-discriminator-value": "aci" }, "AzureKeyVaultVolumeProperties": { "type": "object", "description": "Represents Azure Key Vault Volume properties", "properties": { "certificates": { "type": "object", "description": "The KeyVault certificates that this volume exposes", "additionalProperties": { "$ref": "#/definitions/CertificateObjectProperties" } }, "keys": { "type": "object", "description": "The KeyVault keys that this volume exposes", "additionalProperties": { "$ref": "#/definitions/KeyObjectProperties" } }, "resource": { "type": "string", "description": "The ID of the keyvault to use for this volume resource" }, "secrets": { "type": "object", "description": "The KeyVault secrets that this volume exposes", "additionalProperties": { "$ref": "#/definitions/SecretObjectProperties" } } }, "required": [ "resource" ], "allOf": [ { "$ref": "#/definitions/VolumeProperties" } ], "x-ms-discriminator-value": "azure.com.keyvault" }, "BicepConfigProperties": { "type": "object", "description": "Configuration for Bicep Recipes. Controls how Bicep plans and applies templates as part of Recipe deployment.", "properties": { "authentication": { "type": "object", "description": "Authentication information used to access private bicep registries, which is a map of registry hostname to secret config that contains credential information.", "additionalProperties": { "$ref": "#/definitions/RegistrySecretConfig" } } } }, "BicepRecipeProperties": { "type": "object", "description": "Represents Bicep recipe properties.", "properties": { "plainHttp": { "type": "boolean", "description": "Connect to the Bicep registry using HTTP (not-HTTPS). This should be used when the registry is known not to support HTTPS, for example in a locally-hosted registry. Defaults to false (use HTTPS/TLS)." } }, "allOf": [ { "$ref": "#/definitions/RecipeProperties" } ], "x-ms-discriminator-value": "bicep" }, "CertificateFormats": { "type": "string", "description": "Represents certificate formats", "enum": [ "pem", "pfx" ], "x-ms-enum": { "name": "CertificateFormats", "modelAsString": false, "values": [ { "name": "pem", "value": "pem", "description": "PEM Certificate format" }, { "name": "pfx", "value": "pfx", "description": "PFX Certificate format" } ] } }, "CertificateObjectProperties": { "type": "object", "description": "Represents certificate object properties", "properties": { "alias": { "type": "string", "description": "File name when written to disk" }, "encoding": { "type": "string", "description": "Encoding format. Default utf-8", "default": "utf-8", "enum": [ "utf-8", "hex", "base64" ], "x-ms-enum": { "name": "VolumeSecretEncodings", "modelAsString": false, "values": [ { "name": "utf8", "value": "utf-8", "description": "UTF-8 encoding" }, { "name": "hex", "value": "hex", "description": "Hex encoding" }, { "name": "base64", "value": "base64", "description": "Base64 encoding" } ] } }, "format": { "type": "string", "description": "Certificate format. Default pem", "default": "pem", "enum": [ "pem", "pfx" ], "x-ms-enum": { "name": "CertificateFormats", "modelAsString": false, "values": [ { "name": "pem", "value": "pem", "description": "PEM Certificate format" }, { "name": "pfx", "value": "pfx", "description": "PFX Certificate format" } ] } }, "name": { "type": "string", "description": "The name of the certificate" }, "certType": { "$ref": "#/definitions/CertificateTypes", "description": "Certificate object type to be downloaded - the certificate itself, private key or public key of the certificate" }, "version": { "type": "string", "description": "Certificate version" } }, "required": [ "name" ] }, "CertificateTypes": { "type": "string", "description": "Represents certificate types", "enum": [ "certificate", "privatekey", "publickey" ], "x-ms-enum": { "name": "CertificateTypes", "modelAsString": false, "values": [ { "name": "certificate", "value": "certificate", "description": "Certificate type" }, { "name": "privatekey", "value": "privatekey", "description": "Private Key type" }, { "name": "publickey", "value": "publickey", "description": "Public Key type" } ] } }, "ConnectionProperties": { "type": "object", "description": "Connection Properties", "properties": { "source": { "type": "string", "description": "The source of the connection" }, "disableDefaultEnvVars": { "type": "boolean", "description": "default environment variable override" }, "iam": { "$ref": "#/definitions/IamProperties", "description": "iam properties" } }, "required": [ "source" ] }, "Container": { "type": "object", "description": "Definition of a container", "properties": { "image": { "type": "string", "description": "The registry and image to download and run in your container" }, "imagePullPolicy": { "$ref": "#/definitions/ImagePullPolicy", "description": "The pull policy for the container image" }, "env": { "type": "object", "description": "environment", "additionalProperties": { "$ref": "#/definitions/EnvironmentVariable" } }, "ports": { "type": "object", "description": "container ports", "additionalProperties": { "$ref": "#/definitions/ContainerPortProperties" } }, "readinessProbe": { "$ref": "#/definitions/HealthProbeProperties", "description": "readiness probe properties" }, "livenessProbe": { "$ref": "#/definitions/HealthProbeProperties", "description": "liveness probe properties" }, "volumes": { "type": "object", "description": "container volumes", "additionalProperties": { "$ref": "#/definitions/Volume" } }, "command": { "type": "array", "description": "Entrypoint array. Overrides the container image's ENTRYPOINT", "items": { "type": "string" } }, "args": { "type": "array", "description": "Arguments to the entrypoint. Overrides the container image's CMD", "items": { "type": "string" } }, "workingDir": { "type": "string", "description": "Working directory for the container" } }, "required": [ "image" ] }, "ContainerPortProperties": { "type": "object", "description": "Specifies a listening port for the container", "properties": { "containerPort": { "type": "integer", "format": "int32", "description": "The listening port number" }, "protocol": { "$ref": "#/definitions/PortProtocol", "description": "Protocol in use by the port" }, "scheme": { "type": "string", "description": "Specifies the URL scheme of the communication protocol. Consumers can use the scheme to construct a URL. The value defaults to 'http' or 'https' depending on the port value" }, "port": { "type": "integer", "format": "int32", "description": "Specifies the port that will be exposed by this container. Must be set when value different from containerPort is desired" } }, "required": [ "containerPort" ] }, "ContainerProperties": { "type": "object", "description": "Container properties", "properties": { "environment": { "type": "string", "description": "Fully qualified resource ID for the environment that the application is linked to" }, "application": { "type": "string", "description": "Fully qualified resource ID for the application" }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the asynchronous operation.", "readOnly": true }, "status": { "$ref": "#/definitions/ResourceStatus", "description": "Status of a resource.", "readOnly": true }, "container": { "$ref": "#/definitions/Container", "description": "Definition of a container." }, "connections": { "type": "object", "description": "Specifies a connection to another resource.", "additionalProperties": { "$ref": "#/definitions/ConnectionProperties" } }, "identity": { "$ref": "#/definitions/IdentitySettings", "description": "Configuration for supported external identity providers" }, "extensions": { "type": "array", "description": "Extensions spec of the resource", "items": { "$ref": "#/definitions/Extension" }, "x-ms-identifiers": [] }, "resourceProvisioning": { "$ref": "#/definitions/ContainerResourceProvisioning", "description": "Specifies how the underlying container resource is provisioned and managed." }, "resources": { "type": "array", "description": "A collection of references to resources associated with the container", "items": { "$ref": "#/definitions/ResourceReference" } }, "restartPolicy": { "$ref": "#/definitions/RestartPolicy", "description": "The restart policy for the underlying container" }, "runtimes": { "$ref": "#/definitions/RuntimesProperties", "description": "Specifies Runtime-specific functionality" } }, "required": [ "application", "container" ] }, "ContainerResource": { "type": "object", "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", "properties": { "properties": { "$ref": "#/definitions/ContainerProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, "x-ms-mutability": [ "read", "create" ] } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ] }, "ContainerResourceListResult": { "type": "object", "description": "The response of a ContainerResource list operation.", "properties": { "value": { "type": "array", "description": "The ContainerResource items on this page", "items": { "$ref": "#/definitions/ContainerResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ContainerResourceProvisioning": { "type": "string", "description": "Specifies how the underlying service/resource is provisioned and managed. Available values are 'internal', where Radius manages the lifecycle of the resource internally, and 'manual', where a user manages the resource.", "enum": [ "internal", "manual" ], "x-ms-enum": { "name": "ContainerResourceProvisioning", "modelAsString": false, "values": [ { "name": "internal", "value": "internal", "description": "The resource lifecycle will be managed internally by Radius" }, { "name": "manual", "value": "manual", "description": "The resource lifecycle will be managed by the user" } ] } }, "ContainerResourceUpdate": { "type": "object", "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", "allOf": [ { "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" } ] }, "DaprSidecarExtension": { "type": "object", "description": "Specifies the resource should have a Dapr sidecar injected", "properties": { "appPort": { "type": "integer", "format": "int32", "description": "The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. " }, "appId": { "type": "string", "description": "The Dapr appId. Specifies the identifier used by Dapr for service invocation." }, "config": { "type": "string", "description": "Specifies the Dapr configuration to use for the resource." }, "protocol": { "$ref": "#/definitions/DaprSidecarExtensionProtocol", "description": "Specifies the Dapr app-protocol to use for the resource." } }, "required": [ "appId" ], "allOf": [ { "$ref": "#/definitions/Extension" } ], "x-ms-discriminator-value": "daprSidecar" }, "DaprSidecarExtensionProtocol": { "type": "string", "description": "The Dapr sidecar extension protocol", "enum": [ "http", "grpc" ], "x-ms-enum": { "name": "DaprSidecarExtensionProtocol", "modelAsString": false, "values": [ { "name": "http", "value": "http", "description": "HTTP protocol" }, { "name": "grpc", "value": "grpc", "description": "gRPC protocol" } ] } }, "Direction": { "type": "string", "description": "The direction of a connection.", "enum": [ "Outbound", "Inbound" ], "x-ms-enum": { "name": "Direction", "modelAsString": false, "values": [ { "name": "Outbound", "value": "Outbound", "description": "The resource defining this connection makes an outbound connection resource specified by this id." }, { "name": "Inbound", "value": "Inbound", "description": "The resource defining this connection accepts inbound connections from the resource specified by this id." } ] } }, "EnvironmentCompute": { "type": "object", "description": "Represents backing compute resource", "properties": { "kind": { "type": "string", "description": "Discriminator property for EnvironmentCompute." }, "resourceId": { "type": "string", "description": "The resource id of the compute resource for application environment." }, "identity": { "$ref": "#/definitions/IdentitySettings", "description": "Configuration for supported external identity providers" } }, "discriminator": "kind", "required": [ "kind" ] }, "EnvironmentProperties": { "type": "object", "description": "Environment properties", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the asynchronous operation.", "readOnly": true }, "compute": { "$ref": "#/definitions/EnvironmentCompute", "description": "The compute resource used by application environment." }, "providers": { "$ref": "#/definitions/Providers", "description": "Cloud providers configuration for the environment." }, "simulated": { "type": "boolean", "description": "Simulated environment." }, "recipes": { "type": "object", "description": "Specifies Recipes linked to the Environment.", "additionalProperties": { "additionalProperties": { "$ref": "#/definitions/RecipeProperties" }, "type": "object" } }, "recipeConfig": { "$ref": "#/definitions/RecipeConfigProperties", "description": "Configuration for Recipes. Defines how each type of Recipe should be configured and run." }, "extensions": { "type": "array", "description": "The environment extension.", "items": { "$ref": "#/definitions/Extension" }, "x-ms-identifiers": [] } }, "required": [ "compute" ] }, "EnvironmentResource": { "type": "object", "description": "The environment resource", "properties": { "properties": { "$ref": "#/definitions/EnvironmentProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, "x-ms-mutability": [ "read", "create" ] } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ] }, "EnvironmentResourceListResult": { "type": "object", "description": "The response of a EnvironmentResource list operation.", "properties": { "value": { "type": "array", "description": "The EnvironmentResource items on this page", "items": { "$ref": "#/definitions/EnvironmentResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "EnvironmentResourceUpdate": { "type": "object", "description": "The environment resource", "allOf": [ { "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" } ] }, "EnvironmentVariable": { "type": "object", "description": "Environment variables type", "properties": { "value": { "type": "string", "description": "The value of the environment variable" }, "valueFrom": { "$ref": "#/definitions/EnvironmentVariableReference", "description": "The reference to the variable" } } }, "EnvironmentVariableReference": { "type": "object", "description": "The reference to the variable", "properties": { "secretRef": { "$ref": "#/definitions/SecretReference", "description": "The secret reference" } }, "required": [ "secretRef" ] }, "EnvironmentVariables": { "type": "object", "description": "The environment variables injected during Terraform Recipe execution for the recipes in the environment.", "additionalProperties": { "type": "string" } }, "EphemeralVolume": { "type": "object", "description": "Specifies an ephemeral volume for a container", "properties": { "managedStore": { "$ref": "#/definitions/ManagedStore", "description": "Backing store for the ephemeral volume" } }, "required": [ "managedStore" ], "allOf": [ { "$ref": "#/definitions/Volume" } ], "x-ms-discriminator-value": "ephemeral" }, "ExecHealthProbeProperties": { "type": "object", "description": "Specifies the properties for readiness/liveness probe using an executable", "properties": { "command": { "type": "string", "description": "Command to execute to probe readiness/liveness" } }, "required": [ "command" ], "allOf": [ { "$ref": "#/definitions/HealthProbeProperties" } ], "x-ms-discriminator-value": "exec" }, "ExtenderListSecretResponse": { "type": "object", "description": "Response for list secrets API call", "additionalProperties": {} }, "ExtenderProperties": { "type": "object", "description": "ExtenderResource portable resource properties", "properties": { "environment": { "type": "string", "description": "Fully qualified resource ID for the environment that the portable resource is linked to" }, "application": { "type": "string", "description": "Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)" }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the asynchronous operation.", "readOnly": true }, "status": { "$ref": "#/definitions/ResourceStatus", "description": "Status of a resource.", "readOnly": true }, "secrets": { "type": "object", "description": "The secrets for referenced resource" }, "recipe": { "$ref": "#/definitions/Recipe", "description": "The recipe used to automatically deploy underlying infrastructure for the extender portable resource" }, "resourceProvisioning": { "$ref": "#/definitions/ResourceProvisioning", "description": "Specifies how the underlying service/resource is provisioned and managed." } }, "required": [ "environment" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "ExtenderResource": { "type": "object", "description": "ExtenderResource portable resource", "properties": { "properties": { "$ref": "#/definitions/ExtenderProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, "x-ms-mutability": [ "read", "create" ] } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ] }, "ExtenderResourceListResult": { "type": "object", "description": "The response of a ExtenderResource list operation.", "properties": { "value": { "type": "array", "description": "The ExtenderResource items on this page", "items": { "$ref": "#/definitions/ExtenderResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ExtenderResourceUpdate": { "type": "object", "description": "ExtenderResource portable resource", "allOf": [ { "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" } ] }, "Extension": { "type": "object", "description": "Extension of a environment/application resource.", "properties": { "kind": { "type": "string", "description": "Discriminator property for Extension." } }, "discriminator": "kind", "required": [ "kind" ] }, "GatewayHostname": { "type": "object", "description": "Declare hostname information for the Gateway. Leaving the hostname empty auto-assigns one: mygateway.myapp.PUBLICHOSTNAMEORIP.nip.io.", "properties": { "prefix": { "type": "string", "description": "Specify a prefix for the hostname: myhostname.myapp.PUBLICHOSTNAMEORIP.nip.io. Mutually exclusive with 'fullyQualifiedHostname' and will be overridden if both are defined." }, "fullyQualifiedHostname": { "type": "string", "description": "Specify a fully-qualified domain name: myapp.mydomain.com. Mutually exclusive with 'prefix' and will take priority if both are defined." } } }, "GatewayProperties": { "type": "object", "description": "Gateway properties", "properties": { "environment": { "type": "string", "description": "Fully qualified resource ID for the environment that the application is linked to" }, "application": { "type": "string", "description": "Fully qualified resource ID for the application" }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the asynchronous operation.", "readOnly": true }, "status": { "$ref": "#/definitions/ResourceStatus", "description": "Status of a resource.", "readOnly": true }, "internal": { "type": "boolean", "description": "Sets Gateway to not be exposed externally (no public IP address associated). Defaults to false (exposed to internet)." }, "hostname": { "$ref": "#/definitions/GatewayHostname", "description": "Declare hostname information for the Gateway. Leaving the hostname empty auto-assigns one: mygateway.myapp.PUBLICHOSTNAMEORIP.nip.io." }, "routes": { "type": "array", "description": "Routes attached to this Gateway", "items": { "$ref": "#/definitions/GatewayRoute" }, "x-ms-identifiers": [] }, "tls": { "$ref": "#/definitions/GatewayTls", "description": "TLS configuration for the Gateway." }, "url": { "type": "string", "description": "URL of the gateway resource. Readonly", "readOnly": true } }, "required": [ "application", "routes" ] }, "GatewayResource": { "type": "object", "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", "properties": { "properties": { "$ref": "#/definitions/GatewayProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, "x-ms-mutability": [ "read", "create" ] } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ] }, "GatewayResourceListResult": { "type": "object", "description": "The response of a GatewayResource list operation.", "properties": { "value": { "type": "array", "description": "The GatewayResource items on this page", "items": { "$ref": "#/definitions/GatewayResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "GatewayResourceUpdate": { "type": "object", "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", "allOf": [ { "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" } ] }, "GatewayRoute": { "type": "object", "description": "Route attached to Gateway", "properties": { "path": { "type": "string", "description": "The path to match the incoming request path on. Ex - /myservice." }, "destination": { "type": "string", "description": "The URL or id of the service to route to. Ex - 'http://myservice'." }, "replacePrefix": { "type": "string", "description": "Optionally update the prefix when sending the request to the service. Ex - replacePrefix: '/' and path: '/myservice' will transform '/myservice/myroute' to '/myroute'" }, "enableWebsockets": { "type": "boolean", "description": "Enables websocket support for the route. Defaults to false." }, "timeoutPolicy": { "$ref": "#/definitions/GatewayRouteTimeoutPolicy", "description": "The timeout policy for the route." } } }, "GatewayRouteTimeoutPolicy": { "type": "object", "description": "Gateway route timeout policy", "properties": { "request": { "type": "string", "description": "The request timeout in duration for the route. Defaults to 15 seconds.", "pattern": "^(\\d+(\\.\\d+)?(ns|us|µs|ms|s|m|h))+$" }, "backendRequest": { "type": "string", "description": "The backend request timeout in duration for the route. Cannot be greater than the request timeout.", "pattern": "^(\\d+(\\.\\d+)?(ns|us|µs|ms|s|m|h))+$" } } }, "GatewayTls": { "type": "object", "description": "TLS configuration definition for Gateway resource.", "properties": { "sslPassthrough": { "type": "boolean", "description": "If true, gateway lets the https traffic sslPassthrough to the backend servers for decryption." }, "minimumProtocolVersion": { "type": "string", "description": "TLS minimum protocol version (defaults to 1.2).", "default": "1.2", "enum": [ "1.2", "1.3" ], "x-ms-enum": { "name": "TlsMinVersion", "modelAsString": false, "values": [ { "name": "tls12", "value": "1.2", "description": "TLS Version 1.2" }, { "name": "tls13", "value": "1.3", "description": "TLS Version 1.3" } ] } }, "certificateFrom": { "type": "string", "description": "The resource id for the secret containing the TLS certificate and key for the gateway." } } }, "GitAuthConfig": { "type": "object", "description": "Authentication information used to access private Terraform modules from Git repository sources.", "properties": { "pat": { "type": "object", "description": "Personal Access Token (PAT) configuration used to authenticate to Git platforms.", "additionalProperties": { "$ref": "#/definitions/SecretConfig" } } } }, "HealthProbeProperties": { "type": "object", "description": "Properties for readiness/liveness probe", "properties": { "kind": { "type": "string", "description": "Discriminator property for HealthProbeProperties." }, "initialDelaySeconds": { "type": "number", "format": "float", "description": "Initial delay in seconds before probing for readiness/liveness" }, "failureThreshold": { "type": "number", "format": "float", "description": "Threshold number of times the probe fails after which a failure would be reported" }, "periodSeconds": { "type": "number", "format": "float", "description": "Interval for the readiness/liveness probe in seconds" }, "timeoutSeconds": { "type": "number", "format": "float", "description": "Number of seconds after which the readiness/liveness probe times out. Defaults to 5 seconds", "default": 5 } }, "discriminator": "kind", "required": [ "kind" ] }, "HttpGetHealthProbeProperties": { "type": "object", "description": "Specifies the properties for readiness/liveness probe using HTTP Get", "properties": { "containerPort": { "type": "integer", "format": "int32", "description": "The listening port number" }, "path": { "type": "string", "description": "The route to make the HTTP request on" }, "headers": { "type": "object", "description": "Custom HTTP headers to add to the get request", "additionalProperties": { "type": "string" } } }, "required": [ "containerPort", "path" ], "allOf": [ { "$ref": "#/definitions/HealthProbeProperties" } ], "x-ms-discriminator-value": "httpGet" }, "IAMKind": { "type": "string", "description": "The kind of IAM provider to configure", "enum": [ "azure", "string" ], "x-ms-enum": { "name": "IAMKind", "modelAsString": false, "values": [ { "name": "azure", "value": "azure", "description": "Azure Active Directory" }, { "name": "string", "value": "string" } ] } }, "IamProperties": { "type": "object", "description": "IAM properties", "properties": { "kind": { "$ref": "#/definitions/IAMKind", "description": "The kind of IAM provider to configure" }, "roles": { "type": "array", "description": "RBAC permissions to be assigned on the source resource", "items": { "type": "string" } } }, "required": [ "kind" ] }, "IdentitySettingKind": { "type": "string", "description": "IdentitySettingKind is the kind of supported external identity setting", "enum": [ "undefined", "azure.com.workload", "userAssigned", "systemAssigned", "systemAssignedUserAssigned" ], "x-ms-enum": { "name": "IdentitySettingKind", "modelAsString": false, "values": [ { "name": "undefined", "value": "undefined", "description": "undefined identity" }, { "name": "azure.com.workload", "value": "azure.com.workload", "description": "azure ad workload identity" }, { "name": "userAssigned", "value": "userAssigned", "description": "User assigned managed identity" }, { "name": "systemAssigned", "value": "systemAssigned", "description": "System assigned managed identity" }, { "name": "systemAssignedUserAssigned", "value": "systemAssignedUserAssigned", "description": "System assigned and user assigned managed identity" } ] } }, "IdentitySettings": { "type": "object", "description": "IdentitySettings is the external identity setting.", "properties": { "kind": { "$ref": "#/definitions/IdentitySettingKind", "description": "kind of identity setting" }, "oidcIssuer": { "type": "string", "description": "The URI for your compute platform's OIDC issuer" }, "resource": { "type": "string", "description": "The resource ID of the provisioned identity" }, "managedIdentity": { "type": "array", "description": "The list of user assigned managed identities", "items": { "type": "string" } } }, "required": [ "kind" ] }, "ImagePullPolicy": { "type": "string", "description": "The image pull policy for the container", "enum": [ "Always", "IfNotPresent", "Never" ], "x-ms-enum": { "name": "ImagePullPolicy", "modelAsString": false, "values": [ { "name": "Always", "value": "Always", "description": "Always" }, { "name": "IfNotPresent", "value": "IfNotPresent", "description": "IfNotPresent" }, { "name": "Never", "value": "Never", "description": "Never" } ] } }, "KeyObjectProperties": { "type": "object", "description": "Represents key object properties", "properties": { "alias": { "type": "string", "description": "File name when written to disk" }, "name": { "type": "string", "description": "The name of the key" }, "version": { "type": "string", "description": "Key version" } }, "required": [ "name" ] }, "KubernetesCompute": { "type": "object", "description": "The Kubernetes compute configuration", "properties": { "namespace": { "type": "string", "description": "The namespace to use for the environment." } }, "required": [ "namespace" ], "allOf": [ { "$ref": "#/definitions/EnvironmentCompute" } ], "x-ms-discriminator-value": "kubernetes" }, "KubernetesMetadataExtension": { "type": "object", "description": "Kubernetes metadata extension of a environment/application resource.", "properties": { "annotations": { "type": "object", "description": "Annotations to be applied to the Kubernetes resources output by the resource", "additionalProperties": { "type": "string" } }, "labels": { "type": "object", "description": "Labels to be applied to the Kubernetes resources output by the resource", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "#/definitions/Extension" } ], "x-ms-discriminator-value": "kubernetesMetadata" }, "KubernetesNamespaceExtension": { "type": "object", "description": "Kubernetes namespace extension of a environment/application resource.", "properties": { "namespace": { "type": "string", "description": "The namespace of the application environment." } }, "required": [ "namespace" ], "allOf": [ { "$ref": "#/definitions/Extension" } ], "x-ms-discriminator-value": "kubernetesNamespace" }, "KubernetesPodSpec": { "type": "object", "description": "A strategic merge patch that will be applied to the PodSpec object when this container is being deployed.", "additionalProperties": {} }, "KubernetesRuntimeProperties": { "type": "object", "description": "The runtime configuration properties for Kubernetes", "properties": { "base": { "type": "string", "description": "The serialized YAML manifest which represents the base Kubernetes resources to deploy, such as Deployment, Service, ServiceAccount, Secrets, and ConfigMaps." }, "pod": { "$ref": "#/definitions/KubernetesPodSpec", "description": "A strategic merge patch that will be applied to the PodSpec object when this container is being deployed." } } }, "ManagedStore": { "type": "string", "description": "The managed store for the ephemeral volume", "enum": [ "memory", "disk" ], "x-ms-enum": { "name": "ManagedStore", "modelAsString": false, "values": [ { "name": "memory", "value": "memory", "description": "Memory store" }, { "name": "disk", "value": "disk", "description": "Disk store" } ] } }, "ManualScalingExtension": { "type": "object", "description": "ManualScaling Extension", "properties": { "replicas": { "type": "integer", "format": "int32", "description": "Replica count." } }, "required": [ "replicas" ], "allOf": [ { "$ref": "#/definitions/Extension" } ], "x-ms-discriminator-value": "manualScaling" }, "OutputResource": { "type": "object", "description": "Properties of an output resource.", "properties": { "localId": { "type": "string", "description": "The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships." }, "id": { "type": "string", "description": "The UCP resource ID of the underlying resource." }, "radiusManaged": { "type": "boolean", "description": "Determines whether Radius manages the lifecycle of the underlying resource." } } }, "PersistentVolume": { "type": "object", "description": "Specifies a persistent volume for a container", "properties": { "permission": { "$ref": "#/definitions/VolumePermission", "description": "Container read/write access to the volume" }, "source": { "type": "string", "description": "The source of the volume" } }, "required": [ "source" ], "allOf": [ { "$ref": "#/definitions/Volume" } ], "x-ms-discriminator-value": "persistent" }, "PortProtocol": { "type": "string", "description": "The protocol in use by the port", "enum": [ "TCP", "UDP" ], "x-ms-enum": { "name": "PortProtocol", "modelAsString": false, "values": [ { "name": "TCP", "value": "TCP", "description": "TCP protocol" }, { "name": "UDP", "value": "UDP", "description": "UDP protocol" } ] } }, "ProviderConfigProperties": { "type": "object", "description": "This configuration holds the necessary information to authenticate and interact with a provider for the recipe execution.", "properties": { "secrets": { "type": "object", "description": "Sensitive data in provider configuration can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource.", "additionalProperties": { "$ref": "#/definitions/SecretReference" } } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "Providers": { "type": "object", "description": "The Cloud providers configuration.", "properties": { "azure": { "$ref": "#/definitions/ProvidersAzure", "description": "The Azure cloud provider configuration." }, "aws": { "$ref": "#/definitions/ProvidersAws", "description": "The AWS cloud provider configuration." } } }, "ProvidersAws": { "type": "object", "description": "The AWS cloud provider definition.", "properties": { "scope": { "type": "string", "description": "Target scope for AWS resources to be deployed into. For example: '/planes/aws/aws/accounts/000000000000/regions/us-west-2'." } }, "required": [ "scope" ] }, "ProvidersAzure": { "type": "object", "description": "The Azure cloud provider definition.", "properties": { "scope": { "type": "string", "description": "Target scope for Azure resources to be deployed into. For example: '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup'." } }, "required": [ "scope" ] }, "ProvisioningState": { "type": "string", "description": "Provisioning state of the resource at the time the operation was called", "enum": [ "Creating", "Updating", "Deleting", "Accepted", "Provisioning", "Succeeded", "Failed", "Canceled" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": false, "values": [ { "name": "Creating", "value": "Creating", "description": "The resource is being created" }, { "name": "Updating", "value": "Updating", "description": "The resource is being updated" }, { "name": "Deleting", "value": "Deleting", "description": "The resource is being deleted" }, { "name": "Accepted", "value": "Accepted", "description": "The resource create request has been accepted" }, { "name": "Provisioning", "value": "Provisioning", "description": "The resource is being provisioned" }, { "name": "Succeeded", "value": "Succeeded", "description": "The resource has been successfully provisioned" }, { "name": "Failed", "value": "Failed", "description": "The resource provisioning has failed" }, { "name": "Canceled", "value": "Canceled", "description": "The resource provisioning has been canceled" } ] }, "readOnly": true }, "Recipe": { "type": "object", "description": "The recipe used to automatically deploy underlying infrastructure for a portable resource", "properties": { "name": { "type": "string", "description": "The name of the recipe within the environment to use" }, "parameters": { "type": "object", "description": "Key/value parameters to pass into the recipe at deployment" } }, "required": [ "name" ] }, "RecipeConfigProperties": { "type": "object", "description": "Configuration for Recipes. Defines how each type of Recipe should be configured and run.", "properties": { "terraform": { "$ref": "#/definitions/TerraformConfigProperties", "description": "Configuration for Terraform Recipes. Controls how Terraform plans and applies templates as part of Recipe deployment." }, "bicep": { "$ref": "#/definitions/BicepConfigProperties", "description": "Configuration for Bicep Recipes. Controls how Bicep plans and applies templates as part of Recipe deployment." }, "env": { "$ref": "#/definitions/EnvironmentVariables", "description": "Environment variables injected during recipe execution for the recipes in the environment, currently supported for Terraform recipes." }, "envSecrets": { "type": "object", "description": "Environment variables containing sensitive information can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource.", "additionalProperties": { "$ref": "#/definitions/SecretReference" } } } }, "RecipeGetMetadata": { "type": "object", "description": "Represents the request body of the getmetadata action.", "properties": { "resourceType": { "type": "string", "description": "Type of the resource this recipe can be consumed by. For example: 'Applications.Datastores/mongoDatabases'." }, "name": { "type": "string", "description": "The name of the recipe registered to the environment." } }, "required": [ "resourceType", "name" ] }, "RecipeGetMetadataResponse": { "type": "object", "description": "The properties of a Recipe linked to an Environment.", "properties": { "templateKind": { "type": "string", "description": "The format of the template provided by the recipe. Allowed values: bicep, terraform." }, "templatePath": { "type": "string", "description": "The path to the template provided by the recipe. Currently only link to Azure Container Registry is supported." }, "templateVersion": { "type": "string", "description": "The version of the template to deploy. For Terraform recipes using a module registry this is required, but must be omitted for other module sources." }, "parameters": { "type": "object", "description": "The key/value parameters to pass to the recipe template at deployment." }, "plainHttp": { "type": "boolean", "description": "Connect to the Bicep registry using HTTP (not-HTTPS). This should be used when the registry is known not to support HTTPS, for example in a locally-hosted registry. Defaults to false (use HTTPS/TLS)." } }, "required": [ "templateKind", "templatePath", "parameters" ] }, "RecipeProperties": { "type": "object", "description": "Format of the template provided by the recipe. Allowed values: bicep, terraform.", "properties": { "templateKind": { "type": "string", "description": "Discriminator property for RecipeProperties." }, "templatePath": { "type": "string", "description": "Path to the template provided by the recipe. Currently only link to Azure Container Registry is supported." }, "parameters": { "type": "object", "description": "Key/value parameters to pass to the recipe template at deployment." } }, "discriminator": "templateKind", "required": [ "templateKind", "templatePath" ] }, "RecipeStatus": { "type": "object", "description": "Recipe status at deployment time for a resource.", "properties": { "templateKind": { "type": "string", "description": "TemplateKind is the kind of the recipe template used by the portable resource upon deployment." }, "templatePath": { "type": "string", "description": "TemplatePath is the path of the recipe consumed by the portable resource upon deployment." }, "templateVersion": { "type": "string", "description": "TemplateVersion is the version number of the template." } }, "required": [ "templateKind", "templatePath" ] }, "RegistrySecretConfig": { "type": "object", "description": "Registry Secret Configuration used to authenticate to private bicep registries.", "properties": { "secret": { "type": "string", "description": "The ID of an Applications.Core/SecretStore resource containing credential information used to authenticate private container registry.The keys in the secretstore depends on the type." } } }, "ResourceProvisioning": { "type": "string", "description": "Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values.", "enum": [ "recipe", "manual" ], "x-ms-enum": { "name": "ResourceProvisioning", "modelAsString": false, "values": [ { "name": "recipe", "value": "recipe", "description": "The resource lifecycle will be managed by Radius" }, { "name": "manual", "value": "manual", "description": "The resource lifecycle will be managed by the user" } ] } }, "ResourceReference": { "type": "object", "description": "Describes a reference to an existing resource", "properties": { "id": { "type": "string", "description": "Resource id of an existing resource" } }, "required": [ "id" ] }, "ResourceStatus": { "type": "object", "description": "Status of a resource.", "properties": { "compute": { "$ref": "#/definitions/EnvironmentCompute", "description": "The compute resource associated with the resource." }, "recipe": { "$ref": "#/definitions/RecipeStatus", "description": "The recipe data at the time of deployment", "readOnly": true }, "outputResources": { "type": "array", "description": "Properties of an output resource", "items": { "$ref": "#/definitions/OutputResource" }, "x-ms-identifiers": [] } } }, "RestartPolicy": { "type": "string", "description": "Restart policy for the container", "enum": [ "Always", "OnFailure", "Never" ], "x-ms-enum": { "name": "RestartPolicy", "modelAsString": false, "values": [ { "name": "Always", "value": "Always", "description": "Always" }, { "name": "OnFailure", "value": "OnFailure", "description": "OnFailure" }, { "name": "Never", "value": "Never", "description": "Never" } ] } }, "RuntimesProperties": { "type": "object", "description": "The properties for runtime configuration", "properties": { "kubernetes": { "$ref": "#/definitions/KubernetesRuntimeProperties", "description": "The runtime configuration properties for Kubernetes" }, "aci": { "$ref": "#/definitions/ACIRuntimeProperties", "description": "The runtime configuration properties for ACI" } } }, "SecretConfig": { "type": "object", "description": "Personal Access Token (PAT) configuration used to authenticate to Git platforms.", "properties": { "secret": { "type": "string", "description": "The ID of an Applications.Core/SecretStore resource containing the Git platform personal access token (PAT). The secret store must have a secret named 'pat', containing the PAT value. A secret named 'username' is optional, containing the username associated with the pat. By default no username is specified." } } }, "SecretObjectProperties": { "type": "object", "description": "Represents secret object properties", "properties": { "alias": { "type": "string", "description": "File name when written to disk" }, "encoding": { "type": "string", "description": "Encoding format. Default utf-8", "default": "utf-8", "enum": [ "utf-8", "hex", "base64" ], "x-ms-enum": { "name": "VolumeSecretEncodings", "modelAsString": false, "values": [ { "name": "utf8", "value": "utf-8", "description": "UTF-8 encoding" }, { "name": "hex", "value": "hex", "description": "Hex encoding" }, { "name": "base64", "value": "base64", "description": "Base64 encoding" } ] } }, "name": { "type": "string", "description": "The name of the secret" }, "version": { "type": "string", "description": "secret version" } }, "required": [ "name" ] }, "SecretReference": { "type": "object", "description": "This secret is used within a recipe. Secrets are encrypted, often have fine-grained access control, auditing and are recommended to be used to hold sensitive data.", "properties": { "source": { "type": "string", "description": "The ID of an Applications.Core/SecretStore resource containing sensitive data required for recipe execution." }, "key": { "type": "string", "description": "The key for the secret in the secret store." } }, "required": [ "source", "key" ] }, "SecretStoreDataType": { "type": "string", "description": "The type of SecretStore data", "enum": [ "generic", "certificate", "basicAuthentication", "azureWorkloadIdentity", "awsIRSA" ], "x-ms-enum": { "name": "SecretStoreDataType", "modelAsString": false, "values": [ { "name": "generic", "value": "generic", "description": "Generic secret data type" }, { "name": "certificate", "value": "certificate", "description": "Certificate secret data type" }, { "name": "basicAuthentication", "value": "basicAuthentication", "description": "basicAuthentication type is used to represent username and password based authentication and the secretstore resource is expected to have the keys 'username' and 'password'." }, { "name": "azureWorkloadIdentity", "value": "azureWorkloadIdentity", "description": "azureWorkloadIdentity type is used to represent authentication using azure federated identity and the secretstore resource is expected to have the keys 'clientId' and 'tenantId'." }, { "name": "awsIRSA", "value": "awsIRSA", "description": "awsIRSA type is used to represent authentication using AWS IRSA (IAM Roles for Service accounts) and the secretstore resource is expected to have the key 'roleARN'." } ] } }, "SecretStoreListSecretsResult": { "type": "object", "description": "The list of secrets", "properties": { "type": { "$ref": "#/definitions/SecretStoreDataType", "description": "The type of secret store data" }, "data": { "type": "object", "description": "An object to represent key-value type secrets", "additionalProperties": { "$ref": "#/definitions/SecretValueProperties" } } }, "required": [ "type", "data" ] }, "SecretStoreProperties": { "type": "object", "description": "The properties of SecretStore", "properties": { "environment": { "type": "string", "description": "Fully qualified resource ID for the environment that the application is linked to" }, "application": { "type": "string", "description": "Fully qualified resource ID for the application" }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the asynchronous operation.", "readOnly": true }, "status": { "$ref": "#/definitions/ResourceStatus", "description": "Status of a resource.", "readOnly": true }, "type": { "type": "string", "description": "The type of secret store data", "default": "generic", "enum": [ "generic", "certificate", "basicAuthentication", "azureWorkloadIdentity", "awsIRSA" ], "x-ms-enum": { "name": "SecretStoreDataType", "modelAsString": false, "values": [ { "name": "generic", "value": "generic", "description": "Generic secret data type" }, { "name": "certificate", "value": "certificate", "description": "Certificate secret data type" }, { "name": "basicAuthentication", "value": "basicAuthentication", "description": "basicAuthentication type is used to represent username and password based authentication and the secretstore resource is expected to have the keys 'username' and 'password'." }, { "name": "azureWorkloadIdentity", "value": "azureWorkloadIdentity", "description": "azureWorkloadIdentity type is used to represent authentication using azure federated identity and the secretstore resource is expected to have the keys 'clientId' and 'tenantId'." }, { "name": "awsIRSA", "value": "awsIRSA", "description": "awsIRSA type is used to represent authentication using AWS IRSA (IAM Roles for Service accounts) and the secretstore resource is expected to have the key 'roleARN'." } ] } }, "data": { "type": "object", "description": "An object to represent key-value type secrets", "additionalProperties": { "$ref": "#/definitions/SecretValueProperties" } }, "resource": { "type": "string", "description": "The resource id of external secret store." } }, "required": [ "data" ] }, "SecretStoreResource": { "type": "object", "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", "properties": { "properties": { "$ref": "#/definitions/SecretStoreProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, "x-ms-mutability": [ "read", "create" ] } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ] }, "SecretStoreResourceListResult": { "type": "object", "description": "The response of a SecretStoreResource list operation.", "properties": { "value": { "type": "array", "description": "The SecretStoreResource items on this page", "items": { "$ref": "#/definitions/SecretStoreResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SecretStoreResourceUpdate": { "type": "object", "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", "allOf": [ { "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" } ] }, "SecretValueEncoding": { "type": "string", "description": "The type of SecretValue Encoding", "enum": [ "raw", "base64" ], "x-ms-enum": { "name": "SecretValueEncoding", "modelAsString": false, "values": [ { "name": "raw", "value": "raw", "description": "The raw secret value" }, { "name": "base64", "value": "base64", "description": "The base64-encoded secret value" } ] } }, "SecretValueProperties": { "type": "object", "description": "The properties of SecretValue", "properties": { "encoding": { "type": "string", "description": "The encoding of value", "default": "raw", "enum": [ "raw", "base64" ], "x-ms-enum": { "name": "SecretValueEncoding", "modelAsString": false, "values": [ { "name": "raw", "value": "raw", "description": "The raw secret value" }, { "name": "base64", "value": "base64", "description": "The base64-encoded secret value" } ] } }, "value": { "type": "string", "format": "password", "description": "The value of secret.", "x-ms-secret": true }, "valueFrom": { "$ref": "#/definitions/ValueFromProperties", "description": "The referenced secret in properties.resource" } } }, "TcpHealthProbeProperties": { "type": "object", "description": "Specifies the properties for readiness/liveness probe using TCP", "properties": { "containerPort": { "type": "integer", "format": "int32", "description": "The listening port number" } }, "required": [ "containerPort" ], "allOf": [ { "$ref": "#/definitions/HealthProbeProperties" } ], "x-ms-discriminator-value": "tcp" }, "TerraformConfigProperties": { "type": "object", "description": "Configuration for Terraform Recipes. Controls how Terraform plans and applies templates as part of Recipe deployment.", "properties": { "authentication": { "$ref": "#/definitions/AuthConfig", "description": "Authentication information used to access private Terraform module sources. Supported module sources: Git." }, "providers": { "type": "object", "description": "Configuration for Terraform Recipe Providers. Controls how Terraform interacts with cloud providers, SaaS providers, and other APIs. For more information, please see: https://developer.hashicorp.com/terraform/language/providers/configuration.", "additionalProperties": { "items": { "$ref": "#/definitions/ProviderConfigProperties" }, "type": "array" } } } }, "TerraformRecipeProperties": { "type": "object", "description": "Represents Terraform recipe properties.", "properties": { "templateVersion": { "type": "string", "description": "Version of the template to deploy. For Terraform recipes using a module registry this is required, but must be omitted for other module sources." } }, "allOf": [ { "$ref": "#/definitions/RecipeProperties" } ], "x-ms-discriminator-value": "terraform" }, "TlsMinVersion": { "type": "string", "description": "Tls Minimum versions for Gateway resource.", "enum": [ "1.2", "1.3" ], "x-ms-enum": { "name": "TlsMinVersion", "modelAsString": false, "values": [ { "name": "tls12", "value": "1.2", "description": "TLS Version 1.2" }, { "name": "tls13", "value": "1.3", "description": "TLS Version 1.3" } ] } }, "ValueFromProperties": { "type": "object", "description": "The Secret value source properties", "properties": { "name": { "type": "string", "description": "The name of the referenced secret." }, "version": { "type": "string", "description": "The version of the referenced secret." } }, "required": [ "name" ] }, "Volume": { "type": "object", "description": "Specifies a volume for a container", "properties": { "kind": { "type": "string", "description": "Discriminator property for Volume." }, "mountPath": { "type": "string", "description": "The path where the volume is mounted" } }, "discriminator": "kind", "required": [ "kind" ] }, "VolumePermission": { "type": "string", "description": "The persistent volume permission", "enum": [ "read", "write" ], "x-ms-enum": { "name": "VolumePermission", "modelAsString": false, "values": [ { "name": "read", "value": "read", "description": "Read only" }, { "name": "write", "value": "write", "description": "Read and write" } ] } }, "VolumeProperties": { "type": "object", "description": "Volume properties", "properties": { "kind": { "type": "string", "description": "Discriminator property for VolumeProperties." }, "environment": { "type": "string", "description": "Fully qualified resource ID for the environment that the application is linked to" }, "application": { "type": "string", "description": "Fully qualified resource ID for the application" }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the asynchronous operation.", "readOnly": true }, "status": { "$ref": "#/definitions/ResourceStatus", "description": "Status of a resource.", "readOnly": true } }, "discriminator": "kind", "required": [ "kind", "application" ] }, "VolumeResource": { "type": "object", "description": "Radius Volume resource.", "properties": { "properties": { "$ref": "#/definitions/VolumeProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true, "x-ms-mutability": [ "read", "create" ] } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ] }, "VolumeResourceListResult": { "type": "object", "description": "The response of a VolumeResource list operation.", "properties": { "value": { "type": "array", "description": "The VolumeResource items on this page", "items": { "$ref": "#/definitions/VolumeResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "VolumeResourceUpdate": { "type": "object", "description": "Radius Volume resource.", "allOf": [ { "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" } ] }, "VolumeSecretEncodings": { "type": "string", "description": "Represents secret encodings", "enum": [ "utf-8", "hex", "base64" ], "x-ms-enum": { "name": "VolumeSecretEncodings", "modelAsString": false, "values": [ { "name": "utf8", "value": "utf-8", "description": "UTF-8 encoding" }, { "name": "hex", "value": "hex", "description": "Hex encoding" }, { "name": "base64", "value": "base64", "description": "Base64 encoding" } ] } } }, "parameters": { "RootScopeParameter": { "name": "rootScope", "in": "path", "description": "The scope in which the resource is present. UCP Scope is /planes/{planeType}/{planeName}/resourceGroup/{resourcegroupID} and Azure resource scope is /subscriptions/{subscriptionID}/resourceGroup/{resourcegroupID}", "required": true, "type": "string", "minLength": 1, "x-ms-parameter-location": "client", "x-ms-skip-url-encoding": true } } }