{ "swagger": "2.0", "info": { "title": "Radius Core Resource Provider", "version": "2025-08-01-preview", "description": "REST APIs for next-generation Radius Core resources (preview).", "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": "Applications" }, { "name": "BicepSettings" }, { "name": "Environments" }, { "name": "RecipePacks" }, { "name": "TerraformSettings" } ], "paths": { "/{rootScope}/providers/Radius.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/Radius.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" } } } }, "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/Radius.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/Radius.Core/bicepSettings": { "get": { "operationId": "BicepSettings_ListByScope", "tags": [ "BicepSettings" ], "description": "List BicepSettingsResource 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/BicepSettingsResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{rootScope}/providers/Radius.Core/bicepSettings/{bicepSettingsName}": { "get": { "operationId": "BicepSettings_Get", "tags": [ "BicepSettings" ], "description": "Get a BicepSettingsResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "bicepSettingsName", "in": "path", "description": "Bicep configuration 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/BicepSettingsResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } }, "put": { "operationId": "BicepSettings_CreateOrUpdate", "tags": [ "BicepSettings" ], "description": "Create a BicepSettingsResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "bicepSettingsName", "in": "path", "description": "Bicep configuration 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/BicepSettingsResource" } } ], "responses": { "200": { "description": "Resource 'BicepSettingsResource' update operation succeeded", "schema": { "$ref": "#/definitions/BicepSettingsResource" } }, "201": { "description": "Resource 'BicepSettingsResource' create operation succeeded", "schema": { "$ref": "#/definitions/BicepSettingsResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } }, "patch": { "operationId": "BicepSettings_Update", "tags": [ "BicepSettings" ], "description": "Update a BicepSettingsResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "bicepSettingsName", "in": "path", "description": "Bicep configuration 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/BicepSettingsResourceUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/BicepSettingsResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } }, "delete": { "operationId": "BicepSettings_Delete", "tags": [ "BicepSettings" ], "description": "Delete a BicepSettingsResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "bicepSettingsName", "in": "path", "description": "Bicep configuration 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" } } } } }, "/{rootScope}/providers/Radius.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-pageable": { "nextLinkName": "nextLink" } } }, "/{rootScope}/providers/Radius.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" } } } }, "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 with Azure provider and identity": { "$ref": "./examples/Environments_CreateOrUpdate_Azure.json" }, "Create or Update an environment with Kubernetes provider": { "$ref": "./examples/Environments_CreateOrUpdate_Kubernetes.json" }, "Create or Update an environment with hybrid Azure and Kubernetes providers": { "$ref": "./examples/Environments_CreateOrUpdate_Hybrid.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" } } } }, "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" } } } } }, "/{rootScope}/providers/Radius.Core/recipePacks": { "get": { "operationId": "RecipePacks_ListByScope", "tags": [ "RecipePacks" ], "description": "List RecipePackResource 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/RecipePackResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List recipe packs by scope": { "$ref": "./examples/RecipePacks_ListByScope.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{rootScope}/providers/Radius.Core/recipePacks/{recipePackName}": { "get": { "operationId": "RecipePacks_Get", "tags": [ "RecipePacks" ], "description": "Get a RecipePackResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "recipePackName", "in": "path", "description": "Recipe pack 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/RecipePackResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a recipe pack": { "$ref": "./examples/RecipePacks_Get.json" } } }, "put": { "operationId": "RecipePacks_CreateOrUpdate", "tags": [ "RecipePacks" ], "description": "Create a RecipePackResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "recipePackName", "in": "path", "description": "Recipe pack 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/RecipePackResource" } } ], "responses": { "200": { "description": "Resource 'RecipePackResource' update operation succeeded", "schema": { "$ref": "#/definitions/RecipePackResource" } }, "201": { "description": "Resource 'RecipePackResource' create operation succeeded", "schema": { "$ref": "#/definitions/RecipePackResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create or Update a recipe pack": { "$ref": "./examples/RecipePacks_CreateOrUpdate.json" } } }, "patch": { "operationId": "RecipePacks_Update", "tags": [ "RecipePacks" ], "description": "Update a RecipePackResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "recipePackName", "in": "path", "description": "Recipe pack 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/RecipePackResourceUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RecipePackResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } }, "delete": { "operationId": "RecipePacks_Delete", "tags": [ "RecipePacks" ], "description": "Delete a RecipePackResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "recipePackName", "in": "path", "description": "Recipe pack 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 a recipe pack": { "$ref": "./examples/RecipePacks_Delete.json" } } } }, "/{rootScope}/providers/Radius.Core/terraformSettings": { "get": { "operationId": "TerraformSettings_ListByScope", "tags": [ "TerraformSettings" ], "description": "List TerraformSettingsResource 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/TerraformSettingsResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{rootScope}/providers/Radius.Core/terraformSettings/{terraformSettingsName}": { "get": { "operationId": "TerraformSettings_Get", "tags": [ "TerraformSettings" ], "description": "Get a TerraformSettingsResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "terraformSettingsName", "in": "path", "description": "Terraform configuration 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/TerraformSettingsResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } }, "put": { "operationId": "TerraformSettings_CreateOrUpdate", "tags": [ "TerraformSettings" ], "description": "Create a TerraformSettingsResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "terraformSettingsName", "in": "path", "description": "Terraform configuration 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/TerraformSettingsResource" } } ], "responses": { "200": { "description": "Resource 'TerraformSettingsResource' update operation succeeded", "schema": { "$ref": "#/definitions/TerraformSettingsResource" } }, "201": { "description": "Resource 'TerraformSettingsResource' create operation succeeded", "schema": { "$ref": "#/definitions/TerraformSettingsResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } }, "patch": { "operationId": "TerraformSettings_Update", "tags": [ "TerraformSettings" ], "description": "Update a TerraformSettingsResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "terraformSettingsName", "in": "path", "description": "Terraform configuration 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/TerraformSettingsResourceUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TerraformSettingsResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } } }, "delete": { "operationId": "TerraformSettings_Delete", "tags": [ "TerraformSettings" ], "description": "Delete a TerraformSettingsResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/RootScopeParameter" }, { "name": "terraformSettingsName", "in": "path", "description": "Terraform configuration 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" } } } } }, "/providers/Radius.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-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "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." }, "diffHash": { "type": "string", "description": "Stable hash over the authorable properties of this resource and its sorted dependsOn list. Used by tooling to classify resources as added, removed, modified, or unchanged across graphs. Format: 'sha256:{hex}'." }, "properties": { "type": "object", "description": "Resource-type-specific properties of the resource as returned by its resource provider. The shape of this map varies by `type` (e.g. a `Radius.Compute/containers` resource exposes different keys than `Radius.Datastores/redisCaches` or any user-defined resource type) and matches the `properties` returned by that resource's GET response. Top-level keys already surfaced as first-class fields on this model (`provisioningState`, `connections`) are omitted. The whole `status` object is also omitted because it may contain computed values that include sensitive data (for example, connection strings); the redundant `status.outputResources` list is surfaced via the dedicated `outputResources` field instead. Use `diffHash` rather than a byte-wise compare of this map to detect change.", "additionalProperties": {} } }, "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" }, "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" } ] }, "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" }, "BicepAuthenticationMethod": { "type": "string", "description": "Supported authentication methods for private Bicep registries.", "enum": [ "BasicAuth", "AzureWI", "AwsIrsa" ], "x-ms-enum": { "name": "BicepAuthenticationMethod", "modelAsString": true, "values": [ { "name": "BasicAuth", "value": "BasicAuth", "description": "Username/password authentication." }, { "name": "AzureWI", "value": "AzureWI", "description": "Azure Workload Identity authentication." }, { "name": "AwsIrsa", "value": "AwsIrsa", "description": "AWS IAM Roles for Service Accounts authentication." } ] } }, "BicepRegistryAuthentication": { "type": "object", "description": "Authentication configuration for a single private Bicep registry. When `authenticationMethod` is `BasicAuth`, `basicAuthSecretId` is required; the controller rejects configs that omit it.", "properties": { "authenticationMethod": { "$ref": "#/definitions/BicepAuthenticationMethod", "description": "The authentication method to use. Supported values: BasicAuth, AzureWI, AwsIrsa." }, "basicAuthSecretId": { "type": "string", "description": "The ID of a secret resource containing username and password for BasicAuth. Supported types: Radius.Security/secrets (recommended) or Applications.Core/secretStores. Required when authenticationMethod is 'BasicAuth'." }, "azureWiClientId": { "type": "string", "description": "Azure Workload Identity client ID. Required when authenticationMethod is 'AzureWI'." }, "azureWiTenantId": { "type": "string", "description": "Azure Workload Identity tenant ID. Required when authenticationMethod is 'AzureWI'." }, "awsIamRoleArn": { "type": "string", "description": "AWS IAM Role ARN for IRSA authentication. Required when authenticationMethod is 'AwsIrsa'." } } }, "BicepSettingsProperties": { "type": "object", "description": "Bicep configuration properties.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the asynchronous operation.", "readOnly": true }, "referencedBy": { "type": "array", "description": "Environments that reference this Bicep configuration.", "items": { "type": "string" }, "readOnly": true }, "registryAuthentications": { "type": "object", "description": "Authentication configuration for private Bicep registries, keyed by registry hostname (e.g. 'corp.acr.io'). The Bicep driver looks up credentials by the host parsed from the recipe template path.", "additionalProperties": { "$ref": "#/definitions/BicepRegistryAuthentication" } } } }, "BicepSettingsResource": { "type": "object", "description": "The Bicep configuration resource, providing reusable Bicep recipe settings for environments.", "properties": { "properties": { "$ref": "#/definitions/BicepSettingsProperties", "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" } ] }, "BicepSettingsResourceListResult": { "type": "object", "description": "The response of a BicepSettingsResource list operation.", "properties": { "value": { "type": "array", "description": "The BicepSettingsResource items on this page", "items": { "$ref": "#/definitions/BicepSettingsResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "BicepSettingsResourceUpdate": { "type": "object", "description": "The Bicep configuration resource, providing reusable Bicep recipe settings for environments.", "allOf": [ { "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" } ] }, "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 }, "recipePacks": { "type": "array", "description": "List of Recipe Pack resource IDs linked to this environment.", "items": { "type": "string" } }, "recipeParameters": { "type": "object", "description": "Recipe specific parameters that apply to all resources of a given type in this environment.", "additionalProperties": { "$ref": "#/definitions/RecipeParameterValue" } }, "providers": { "$ref": "#/definitions/Providers", "description": "Cloud provider configuration for the environment." }, "terraformSettings": { "type": "string", "description": "Resource ID of a Radius.Core/terraformSettings resource providing Terraform recipe settings." }, "bicepSettings": { "type": "string", "description": "Resource ID of a Radius.Core/bicepSettings resource providing Bicep recipe settings." }, "simulated": { "type": "boolean", "description": "Simulated environment." } } }, "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" } ] }, "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" ] }, "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" }, "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." } } }, "Providers": { "type": "object", "properties": { "azure": { "$ref": "#/definitions/ProvidersAzure", "description": "The Azure cloud provider configuration." }, "kubernetes": { "$ref": "#/definitions/ProvidersKubernetes", "description": "The Kubernetes provider configuration." }, "aws": { "$ref": "#/definitions/ProvidersAws", "description": "The AWS cloud provider configuration." } } }, "ProvidersAws": { "type": "object", "description": "The AWS cloud provider definition.", "properties": { "accountId": { "type": "string", "description": "AWS account ID for AWS resources to be deployed into." }, "region": { "type": "string", "description": "AWS region for AWS resources to be deployed into." } }, "required": [ "accountId", "region" ] }, "ProvidersAzure": { "type": "object", "description": "The Azure cloud provider definition.", "properties": { "subscriptionId": { "type": "string", "description": "Azure subscription ID hosting deployed resources." }, "resourceGroupName": { "type": "string", "description": "Optional resource group name." }, "identity": { "$ref": "#/definitions/IdentitySettings", "description": "External identity settings (moved from compute)." } }, "required": [ "subscriptionId" ] }, "ProvidersKubernetes": { "type": "object", "properties": { "namespace": { "type": "string", "description": "Kubernetes namespace to deploy workloads into." } }, "required": [ "namespace" ] }, "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 }, "RecipeDefinition": { "type": "object", "description": "Recipe definition for a specific resource type", "properties": { "kind": { "$ref": "#/definitions/RecipeKind", "description": "The type of recipe (e.g., Terraform, Bicep)" }, "plainHttp": { "type": "boolean", "description": "Connect to the source using HTTP (not HTTPS). This should be used when the source is known not to support HTTPS, for example in a locally hosted registry for Bicep recipes. Defaults to false (use HTTPS/TLS)" }, "source": { "type": "string", "description": "The source of the recipe. For Bicep recipes this is the OCI registry reference. For Terraform recipes this is the module source." }, "parameters": { "type": "object", "description": "Parameters to pass to the recipe", "additionalProperties": {} }, "outputs": { "type": "object", "description": "Map of resource type property names to module output names. Used for recipes that point directly at a Bicep or Terraform module to map the module's outputs onto the resource's properties.", "additionalProperties": { "type": "string" } } }, "required": [ "kind", "source" ] }, "RecipeKind": { "type": "string", "description": "The type of recipe", "enum": [ "terraform", "bicep" ], "x-ms-enum": { "name": "RecipeKind", "modelAsString": false, "values": [ { "name": "terraform", "value": "terraform", "description": "Terraform recipe" }, { "name": "bicep", "value": "bicep", "description": "Bicep recipe" } ] } }, "RecipePackProperties": { "type": "object", "description": "Recipe Pack properties", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the asynchronous operation", "readOnly": true }, "referencedBy": { "type": "array", "description": "List of environment IDs that reference this recipe pack", "items": { "type": "string" }, "readOnly": true }, "recipes": { "type": "object", "description": "Map of resource types to their recipe configurations", "additionalProperties": { "$ref": "#/definitions/RecipeDefinition" } } }, "required": [ "recipes" ] }, "RecipePackResource": { "type": "object", "description": "The recipe pack resource", "properties": { "properties": { "$ref": "#/definitions/RecipePackProperties", "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" } ] }, "RecipePackResourceListResult": { "type": "object", "description": "The response of a RecipePackResource list operation.", "properties": { "value": { "type": "array", "description": "The RecipePackResource items on this page", "items": { "$ref": "#/definitions/RecipePackResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RecipePackResourceUpdate": { "type": "object", "description": "The recipe pack resource", "allOf": [ { "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" } ] }, "RecipeParameterValue": { "type": "object", "description": "Recipe parameter configuration for a specific resource type.", "additionalProperties": {} }, "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" ] }, "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": [] } } }, "TerraformCredentialConfig": { "type": "object", "description": "Credential configuration for a Terraform registry or module source host.", "properties": { "secret": { "type": "string", "description": "The ID of a secret resource containing the authentication token. Supported types: Radius.Security/secrets (recommended) or Applications.Core/secretStores. The secret must have a key named 'token'." } } }, "TerraformProviderDirect": { "type": "object", "description": "Direct provider installation configuration.", "properties": { "include": { "type": "array", "description": "Provider address patterns to include for direct installation.", "items": { "type": "string" } }, "exclude": { "type": "array", "description": "Provider address patterns to exclude from direct installation.", "items": { "type": "string" } } } }, "TerraformProviderInstallation": { "type": "object", "description": "Provider installation configuration for Terraform CLI.", "properties": { "networkMirror": { "$ref": "#/definitions/TerraformProviderMirror", "description": "Network mirror configuration for downloading providers." }, "direct": { "$ref": "#/definitions/TerraformProviderDirect", "description": "Direct provider installation configuration." } } }, "TerraformProviderMirror": { "type": "object", "description": "Network mirror configuration for Terraform providers.", "properties": { "url": { "type": "string", "description": "The URL of the provider mirror." }, "include": { "type": "array", "description": "Provider address patterns to include from this mirror.", "items": { "type": "string" } }, "exclude": { "type": "array", "description": "Provider address patterns to exclude from this mirror.", "items": { "type": "string" } } } }, "TerraformSettingsProperties": { "type": "object", "description": "Terraform configuration properties.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the asynchronous operation.", "readOnly": true }, "referencedBy": { "type": "array", "description": "Environments that reference this Terraform configuration.", "items": { "type": "string" }, "readOnly": true }, "terraformrc": { "$ref": "#/definitions/TerraformrcConfig", "description": "Terraform CLI configuration file settings. Maps directly to the Terraform CLI configuration file (.terraformrc)." }, "env": { "type": "object", "description": "Environment variables injected during Terraform recipe execution.", "additionalProperties": { "type": "string" } } } }, "TerraformSettingsResource": { "type": "object", "description": "The Terraform configuration resource, providing reusable Terraform recipe settings for environments.", "properties": { "properties": { "$ref": "#/definitions/TerraformSettingsProperties", "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" } ] }, "TerraformSettingsResourceListResult": { "type": "object", "description": "The response of a TerraformSettingsResource list operation.", "properties": { "value": { "type": "array", "description": "The TerraformSettingsResource items on this page", "items": { "$ref": "#/definitions/TerraformSettingsResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "TerraformSettingsResourceUpdate": { "type": "object", "description": "The Terraform configuration resource, providing reusable Terraform recipe settings for environments.", "allOf": [ { "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" } ] }, "TerraformrcConfig": { "type": "object", "description": "Terraform CLI configuration file (.terraformrc) settings. See https://developer.hashicorp.com/terraform/cli/config for details.", "properties": { "providerInstallation": { "$ref": "#/definitions/TerraformProviderInstallation", "description": "Provider installation configuration. Specifies the location of providers via network mirrors or direct downloads." }, "credentials": { "type": "object", "description": "Credentials for authenticating to private Terraform registries (HTTP-based, e.g. app.terraform.io). Map of registry hostname to credential configuration. Rendered as native `credentials \"hostname\" {}` blocks in the generated .terraformrc. Note: this is for Terraform CLI registry auth (HTTP), not for Git-based module sources; Git auth is a separate mechanism.", "additionalProperties": { "$ref": "#/definitions/TerraformCredentialConfig" } } } } }, "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 } } }