Reference: applications.core/environments@2023-10-01-preview
Detailed reference documentation for applications.core/environments@2023-10-01-preview
Schema
Top-Level Resource
Properties
| Property | Type | Description |
|---|---|---|
| apiVersion | ‘2023-10-01-preview’ | The resource api version (ReadOnly, DeployTimeConstant) |
| id | string | The resource id (ReadOnly, DeployTimeConstant) |
| location | string | The geo-location where the resource lives |
| name | string | The resource name (Required, DeployTimeConstant, Identifier) |
| properties | EnvironmentProperties | Environment properties (Required) |
| systemData | SystemData | Metadata pertaining to creation and last modification of the resource. (ReadOnly) |
| tags | TrackedResourceTags | Resource tags. |
| type | ‘Applications.Core/environments’ | The resource type (ReadOnly, DeployTimeConstant) |
EnvironmentProperties
Properties
| Property | Type | Description |
|---|---|---|
| compute | EnvironmentCompute | Represents backing compute resource (Required) |
| extensions | Extension[] | The environment extension. |
| providers | Providers | The Cloud providers configuration. |
| provisioningState | ‘Accepted’ | ‘Canceled’ |
| recipeConfig | RecipeConfigProperties | Configuration for Recipes. Defines how each type of Recipe should be configured and run. |
| recipes | EnvironmentPropertiesRecipes | Specifies Recipes linked to the Environment. |
| simulated | bool | Simulated environment. |
EnvironmentCompute
- Discriminator: kind
Base Properties
| Property | Type | Description |
|---|---|---|
| identity | IdentitySettings | IdentitySettings is the external identity setting. |
| resourceId | string | The resource id of the compute resource for application environment. |
KubernetesCompute
Properties
| Property | Type | Description |
|---|---|---|
| kind | ‘kubernetes’ | Discriminator property for EnvironmentCompute. (Required) |
| namespace | string | The namespace to use for the environment. (Required) |
IdentitySettings
Properties
| Property | Type | Description |
|---|---|---|
| kind | ‘azure.com.workload’ | ‘undefined’ |
| oidcIssuer | string | The URI for your compute platform’s OIDC issuer |
| resource | string | The resource ID of the provisioned identity |
Extension
- Discriminator: kind
Base Properties
- none
DaprSidecarExtension
Properties
| Property | Type | Description |
|---|---|---|
| appId | string | The Dapr appId. Specifies the identifier used by Dapr for service invocation. (Required) |
| appPort | int | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. |
| config | string | Specifies the Dapr configuration to use for the resource. |
| kind | ‘daprSidecar’ | Discriminator property for Extension. (Required) |
| protocol | ‘grpc’ | ‘http’ |
KubernetesMetadataExtension
Properties
| Property | Type | Description |
|---|---|---|
| annotations | KubernetesMetadataExtensionAnnotations | Annotations to be applied to the Kubernetes resources output by the resource |
| kind | ‘kubernetesMetadata’ | Discriminator property for Extension. (Required) |
| labels | KubernetesMetadataExtensionLabels | Labels to be applied to the Kubernetes resources output by the resource |
KubernetesNamespaceExtension
Properties
| Property | Type | Description |
|---|---|---|
| kind | ‘kubernetesNamespace’ | Discriminator property for Extension. (Required) |
| namespace | string | The namespace of the application environment. (Required) |
ManualScalingExtension
Properties
| Property | Type | Description |
|---|---|---|
| kind | ‘manualScaling’ | Discriminator property for Extension. (Required) |
| replicas | int | Replica count. (Required) |
KubernetesMetadataExtensionAnnotations
Properties
- none
Additional Properties
- Additional Properties Type: string
KubernetesMetadataExtensionLabels
Properties
- none
Additional Properties
- Additional Properties Type: string
Providers
Properties
| Property | Type | Description |
|---|---|---|
| aws | ProvidersAws | The AWS cloud provider definition. |
| azure | ProvidersAzure | The Azure cloud provider definition. |
ProvidersAws
Properties
| Property | Type | Description |
|---|---|---|
| scope | string | Target scope for AWS resources to be deployed into. For example: ‘/planes/aws/aws/accounts/000000000000/regions/us-west-2’. (Required) |
ProvidersAzure
Properties
| Property | Type | Description |
|---|---|---|
| scope | string | Target scope for Azure resources to be deployed into. For example: ‘/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup’. (Required) |
RecipeConfigProperties
Properties
| Property | Type | Description |
|---|---|---|
| bicep | BicepConfigProperties | Configuration for Bicep Recipes. Controls how Bicep plans and applies templates as part of Recipe deployment. |
| env | EnvironmentVariables | The environment variables injected during Terraform Recipe execution for the recipes in the environment. |
| envSecrets | RecipeConfigPropertiesEnvSecrets | Environment variables containing sensitive information can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource. |
| terraform | TerraformConfigProperties | Configuration for Terraform Recipes. Controls how Terraform plans and applies templates as part of Recipe deployment. |
BicepConfigProperties
Properties
| Property | Type | Description |
|---|---|---|
| authentication | BicepConfigPropertiesAuthentication | Authentication information used to access private bicep registries, which is a map of registry hostname to secret config that contains credential information. |
BicepConfigPropertiesAuthentication
Properties
- none
Additional Properties
- Additional Properties Type: RegistrySecretConfig
RegistrySecretConfig
Properties
| Property | Type | Description |
|---|---|---|
| secret | string | 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. |
EnvironmentVariables
Properties
- none
Additional Properties
- Additional Properties Type: string
RecipeConfigPropertiesEnvSecrets
Properties
- none
Additional Properties
- Additional Properties Type: SecretReference
SecretReference
Properties
| Property | Type | Description |
|---|---|---|
| key | string | The key for the secret in the secret store. (Required) |
| source | string | The ID of an Applications.Core/SecretStore resource containing sensitive data required for recipe execution. (Required) |
TerraformConfigProperties
Properties
| Property | Type | Description |
|---|---|---|
| authentication | AuthConfig | Authentication information used to access private Terraform module sources. Supported module sources: Git. |
| providers | TerraformConfigPropertiesProviders | 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. |
AuthConfig
Properties
| Property | Type | Description |
|---|---|---|
| git | GitAuthConfig | Authentication information used to access private Terraform modules from Git repository sources. |
GitAuthConfig
Properties
| Property | Type | Description |
|---|---|---|
| pat | GitAuthConfigPat | Personal Access Token (PAT) configuration used to authenticate to Git platforms. |
GitAuthConfigPat
Properties
- none
Additional Properties
- Additional Properties Type: SecretConfig
SecretConfig
Properties
| Property | Type | Description |
|---|---|---|
| secret | string | 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. |
TerraformConfigPropertiesProviders
Properties
- none
Additional Properties
- Additional Properties Type: ProviderConfigProperties[]
ProviderConfigProperties
Properties
| Property | Type | Description |
|---|---|---|
| secrets | ProviderConfigPropertiesSecrets | Sensitive data in provider configuration can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource. |
Additional Properties
- Additional Properties Type: any
ProviderConfigPropertiesSecrets
Properties
- none
Additional Properties
- Additional Properties Type: SecretReference
EnvironmentPropertiesRecipes
Properties
- none
Additional Properties
- Additional Properties Type: DictionaryOfRecipeProperties
DictionaryOfRecipeProperties
Properties
- none
Additional Properties
- Additional Properties Type: RecipeProperties
RecipeProperties
- Discriminator: templateKind
Base Properties
| Property | Type | Description |
|---|---|---|
| parameters | any | Any object |
| templatePath | string | Path to the template provided by the recipe. Currently only link to Azure Container Registry is supported. (Required) |
BicepRecipeProperties
Properties
| Property | Type | Description |
|---|---|---|
| plainHttp | bool | 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). |
| templateKind | ‘bicep’ | Discriminator property for RecipeProperties. (Required) |
TerraformRecipeProperties
Properties
| Property | Type | Description |
|---|---|---|
| templateKind | ’terraform’ | Discriminator property for RecipeProperties. (Required) |
| templateVersion | string | Version of the template to deploy. For Terraform recipes using a module registry this is required, but must be omitted for other module sources. |
SystemData
Properties
| Property | Type | Description |
|---|---|---|
| createdAt | string | The timestamp of resource creation (UTC). |
| createdBy | string | The identity that created the resource. |
| createdByType | ‘Application’ | ‘Key’ |
| lastModifiedAt | string | The timestamp of resource last modification (UTC) |
| lastModifiedBy | string | The identity that last modified the resource. |
| lastModifiedByType | ‘Application’ | ‘Key’ |
TrackedResourceTags
Properties
- none
Additional Properties
- Additional Properties Type: string
Feedback
Was this page helpful?
Glad to hear it! Please feel free to star our repo and join our Discord server to stay up to date with the project.
Sorry to hear that. If you would like to also contribute a suggestion visit and tell us how we can improve.