Bicep Module Documentation
| Property | Value | Description |
|---|---|---|
| general (required) | general | |
| identity | identity | The identity configuration. |
| appLogsConfiguration | appLogsConfiguration | Cluster configuration which enables the log daemon to export app logs to a destination. Currently only log-analytics is supported |
| customDomainConfiguration | customDomainConfiguration | Custom domain configuration for the environment |
| daprAIConnectionString | securestring | Application Insights connection string used by Dapr to export Service to Service communication telemetry |
| daprAIInstrumentationKey | securestring | Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry |
| infrastructureResourceGroup | string | Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet. |
| peerAuthenticationMtlsEnabled | bool | Peer authentication settings for the Managed Environment |
| vnetConfiguration | vnetConfiguration | Vnet configuration for the environment |
| workloadProfiles | containerAppsManagedEnvironmentWorkloadProfile[] | Workload profiles configured for the Managed Environment. |
| zoneRedundant | bool | Whether or not this Managed Environment is zone-redundant. (default: false) |
| containerApps | containerApp[] | Container Apps in the managed environment |
| containerAppJobs | containerAppJob[] | Container App Jobs in the managed environment |
| managedCertificates | containerAppManagedCertificate[] | Managed Certificates in the managed environment |
| certificates | containerAppCertificate[] | Certificates in the managed environment |
| storages | containerAppStorage[] | Storages in the managed environment |
| privateLink | privateLink | Settings for the private endpoint and private link for this resource. Private Endpoint is not supported for consumptionOnly environments |
| Property | Value | Description |
|---|---|---|
| type | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
The types of identities associated with this resource. (default: none) |
| userAssignedIdentities | string[] | Resource IDs of User Assigned Identities to associate with this resource. |
| Property | Value | Description |
|---|---|---|
| customerId (required) | string | Log analytics customer id |
| sharedKey (required) | string | Log analytics customer key |
| Property | Value | Description |
|---|---|---|
| destination | 'azure-monitor' 'log-analytics' 'none' |
Logs destination, can be log-analytics, azure-monitor or none |
| logAnalyticsConfiguration | logAnalyticsConfiguration | Log Analytics configuration, must only be provided when destination is configured as log-analytics |
| Property | Value | Description |
|---|---|---|
| certificatePassword (required) | string | Certificate password |
| certificateValue (required) | string | PFX or PEM blob |
| dnsSuffix (required) | string | Dns suffix for the environment domain |
| Property | Value | Description |
|---|---|---|
| dockerBridgeCidr | string | CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. |
| infrastructureSubnetId | string | Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. |
| internal | bool | Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property |
| platformReservedCidr | string | IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. |
| platformReservedDnsIP | string | An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. |
| Property | Value | Description |
|---|---|---|
| maximumCount | int | The maximum capacity. |
| minimumCount | int | The minimum capacity. |
| name (required) | string | Workload profile name for the workloads to run on. |
| workloadProfileType (required) | string | Workload profile type for the workloads to run on. |
| Property | Value | Description |
|---|---|---|
| naming (required) | naming | |
| domainControlValidation | 'CNAME' 'HTTP' 'TXT' |
Selected type of domain control validation for managed certificates. (default: TXT) |
| subjectName (required) | string | Subject name of the certificate. |
| Property | Value | Description |
|---|---|---|
| naming (required) | naming | |
| certificateKeyVaultProperties | certificateKeyVaultProperties | Properties for a certificate stored in a Key Vault. |
| password | string | Certificate password. |
| value | string | PFX or PEM blob |
| Property | Value | Description |
|---|---|---|
| identity (required) | string | Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. |
| keyVaultUrl (required) | string | URL pointing to the Azure Key Vault secret that holds the certificate. |
| Property | Value | Description |
|---|---|---|
| name (required) | string | Name of the storage |
| accessMode (required) | 'ReadOnly' 'ReadWrite' |
Access mode for storage |
| accountName (required) | string | Storage account name for azure file |
| accountKey (required) | string | Storage account key for azure file. |
| shareName (required) | string | Azure file share name |
| Property | Value | Description |
|---|---|---|
| identity | string | A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use system |
| passwordSecretRef | string | The name of the Secret that contains the registry login password |
| server (required) | string | Container Registry Server |
| username | string | Container Registry Username |
| Property | Value | Description |
|---|---|---|
| identity | string | Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. |
| keyVaultUrl | string | Azure Key Vault URL pointing to the secret referenced by the container app. |
| name (required) | string | Secret Name. |
| value | string | Secret Value. |
| Property | Value | Description |
|---|---|---|
| auth (required) | containerAppJobScaleRuleAuth[] | Authentication secrets for the scale rule. |
| metadata | string | Metadata properties to describe the scale rule. |
| name (required) | string | Scale Rule Name |
| type (required) | string | Type of the scale rule eg: azure-servicebus, redis etc. |
| Property | Value | Description |
|---|---|---|
| secretRef | string | Name of the secret from which to pull the auth params. |
| triggerParameter (required) | string | Trigger Parameter that uses the secret |
| Property | Value | Description |
|---|---|---|
| args | string[] | Container start command arguments. |
| command | string[] | Container start command. |
| env | containerAppJobTemplateContainerEnvironmentVar[] | Container environment variables. |
| image (required) | string | Container image tag. |
| name | string | Custom container name. |
| probes | containerAppJobTemplateContainerContainerAppProbe[] | List of probes for the container. |
| resources | containerAppResources | Container resource requirements. |
| volumeMounts | containerAppVolumeMount[] | Container volume mounts. |
| Property | Value | Description |
|---|---|---|
| failureThreshold | int | Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10. |
| httpGet (required) | containerAppProbeHttpGet | HTTPGet specifies the http request to perform. |
| initialDelaySeconds (required) | int | Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. |
| periodSeconds | int | How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. |
| successThreshold | int | Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10. |
| tcpSocket (required) | containerAppProbeTcpSocket | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. |
| terminationGracePeriodSeconds (required) | int | Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pods terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour) |
| timeoutSeconds | int | Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. |
| type (required) | 'Liveness' 'Readiness' 'Startup' |
The type of probe. |
| Property | Value | Description |
|---|---|---|
| name (required) | string | Environment variable name. |
| secretRef | string | Name of the Container App secret from which to pull the environment variable value. |
| value | string | Non-secret environment variable value. |
| Property | Value | Description |
|---|---|---|
| exposedPort | int | Specifies the exposed port for the target port. If not specified, it defaults to target port. |
| external (required) | bool | Specifies whether the app port is accessible outside of the environment. |
| targetPort (required) | int | Specifies the port user's container listens on. |
| Property | Value | Description |
|---|---|---|
| bindingType | 'Disabled' 'SniEnabled' |
Custom Domain binding type. |
| certificateName | string | Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. |
| name (required) | string | Hostname. |
| Property | Value | Description |
|---|---|---|
| action (required) | 'Allow' 'Deny' |
Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny. |
| description | string | Describe the IP restriction rule that is being sent to the container-app. This is an optional field. |
| ipAddressRange (required) | string | CIDR notation to match incoming IP address. |
| name (required) | string | Name for the IP restriction rule. |
| Property | Value | Description |
|---|---|---|
| host | string | Host name to connect to, defaults to the pod IP. You probably want to set Host in httpHeaders instead. |
| httpHeaders | containerAppProbeHttpGetHttpHeadersItem[] | Custom headers to set in the request. HTTP allows repeated headers. |
| path | string | Path to access on the HTTP server. |
| port (required) | int | Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
| scheme | 'HTTP' 'HTTPS' |
Scheme to use for connecting to the host. (default: HTTP) |
| Property | Value | Description |
|---|---|---|
| name (required) | string | The header field name. |
| value (required) | string | The header field value. |
| Property | Value | Description |
|---|---|---|
| host | string | Optional: Host name to connect to, defaults to the pod IP. |
| port (required) | int | Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
| Property | Value | Description |
|---|---|---|
| identity | string | A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use system. |
| passwordSecretRef | string | The name of the Secret that contains the registry login password. |
| server (required) | string | Container Registry Server. |
| username | string | Container Registry Username. |
| Property | Value | Description |
|---|---|---|
| cpu (required) | string | Required CPU in cores, e.g. 0.5 To specify a decimal value, use the json() function. |
| memory | string | Required memory, e.g. "250Mb" |
| Property | Value | Description |
|---|---|---|
| secretRef | string | Name of the secret from which to pull the auth params. |
| triggerParameter (required) | string | Trigger Parameter that uses the secret. |
| Property | Value | Description |
|---|---|---|
| identity | string | Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. |
| keyVaultUrl | string | Azure Key Vault URL pointing to the secret referenced by the container app. |
| name (required) | string | Secret Name. |
| value | string | Secret Value. |
| Property | Value | Description |
|---|---|---|
| args | string[] | Container start command arguments. |
| command | string[] | Container start command. |
| env | containerAppTemplateContainerEnvironmentVar[] | Container environment variables. |
| image | string | Container image tag. |
| name | string | Custom container name. |
| probes | containerAppTemplateContainerContainerAppProbe[] | List of probes for the container. |
| resources | containerAppResources | Container resource requirements. |
| volumeMounts | containerAppVolumeMount[] | Container volume mounts. |
| Property | Value | Description |
|---|---|---|
| failureThreshold (required) | int | Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1. Maximum value is 10. (default: 3) |
| httpGet (required) | httpGet | HTTPGet specifies the http request to perform. |
| initialDelaySeconds (required) | int | Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. |
| periodSeconds (required) | int | How often (in seconds) to perform the probe. Minimum value is 1. Maximum value is 240. (default: 10 seconds) |
| successThreshold (required) | int | Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10. |
| tcpSocket (required) | containerAppProbeTcpSocket | TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. |
| terminationGracePeriodSeconds (required) | int | Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. (default: 30 seconds) |
| timeoutSeconds (required) | int | Number of seconds after which the probe times out. Minimum value is 1. Maximum value is 240. (default: 1 second) |
| type (required) | 'Liveness' 'Readiness' 'Startup' |
The type of probe. |
| Property | Value | Description |
|---|---|---|
| host | string | Host name to connect to, defaults to the pod IP. You probably want to set Host in httpHeaders instead. |
| httpHeaders | containerAppProbeHttpGetHttpHeadersItem[] | Custom headers to set in the request. HTTP allows repeated headers. |
| path | string | Path to access on the HTTP server. |
| port (required) | int | Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. |
| scheme | 'HTTP' 'HTTPS' |
Scheme to use for connecting to the host. (default: HTTP) |
| Property | Value | Description |
|---|---|---|
| name (required) | string | Environment variable name. |
| secretRef | string | Name of the Container App secret from which to pull the environment variable value. |
| value | string | Non-secret environment variable value. |
| Property | Value | Description |
|---|---|---|
| args (required) | string[] | Container start command arguments. |
| command (required) | string[] | Container start command. |
| env (required) | containerAppTemplateInitContainerEnvironmentVar[] | Container environment variables. |
| image (required) | string | Container image tag. |
| name (required) | string | Custom container name. |
| resources (required) | containerAppResources | Container resource requirements. |
| volumeMounts | containerAppVolumeMount[] | Container volume mounts. |
| Property | Value | Description |
|---|---|---|
| name (required) | string | Environment variable name. |
| secretRef | string | Name of the Container App secret from which to pull the environment variable value. |
| value | string | Non-secret environment variable value. |
| Property | Value | Description |
|---|---|---|
| azureQueue | azureQueue | Azure Queue based scaling. |
| custom | custom | Custom scale rule. |
| http | http | HTTP requests based scaling. |
| name (required) | string | Scale Rule Name. |
| tcp | tcp | Tcp requests based scaling. |
| Property | Value | Description |
|---|---|---|
| accountName | string | Storage account name. required if using managed identity to authenticate |
| auth | containerAppScaleRuleAuth[] | Authentication secrets for the queue scale rule. |
| identity | string | The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. |
| queueLength (required) | int | Queue length. |
| queueName (required) | string | Queue name. |
| Property | Value | Description |
|---|---|---|
| auth | containerAppScaleRuleAuth[] | Authentication secrets for the custom scale rule. |
| metadata (required) | object | Metadata properties to describe custom scale rule. |
| type (required) | string | Type of the custom scale rule, eg: azure-servicebus, redis etc. |
| Property | Value | Description |
|---|---|---|
| auth | containerAppScaleRuleAuth[] | Authentication secrets for the http scale rule. |
| metadata (required) | object | Metadata properties to describe http scale rule. |
| Property | Value | Description |
|---|---|---|
| auth | containerAppScaleRuleAuth[] | Authentication secrets for the tcp scale rule. |
| metadata (required) | object | Metadata properties to describe tcp scale rule. |
| Property | Value | Description |
|---|---|---|
| name (required) | string | Name of the service bind. |
| serviceId (required) | string | Resource id of the target service. |
| Property | Value | Description |
|---|---|---|
| name (required) | string | Volume name. |
| secrets | containerAppTemplateVolumeSecretVolumeItem[] | List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. |
| storageName (required) | string | Name of storage resource. No need to provide for EmptyDir and Secret. |
| storageType | 'AzureFile' 'EmptyDir' 'Secret' |
Storage type for the volume. If not provided, use EmptyDir. |
| mountOptions | string | Mount options used while mounting the AzureFile. Must be a comma-separated string. |
| Property | Value | Description |
|---|---|---|
| path (required) | string | Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. |
| secretRef | string | Name of the Container App secret from which to pull the secret value. |
| Property | Value | Description |
|---|---|---|
| label | string | Associates a traffic label with a revision. |
| latestRevision | bool | Indicates that the traffic weight belongs to a latest stable revision. |
| revisionName | string | Name of a revision. |
| weight | int | Traffic weight assigned to a revision. |
| Property | Value | Description |
|---|---|---|
| mountPath (required) | string | Path within the container at which the volume should be mounted.Must not contain ':'. |
| subPath | string | Path within the volume from which the containers volume should be mounted. Defaults to " "(volumes root). |
| volumeName (required) | string | This must match the Name of a Volume. |
| Property | Value | Description |
|---|---|---|
| name | string | Character limit: 1-90. Valid characters: Alphanumerics, periods, underscores, hyphens, and parenthesis. Can't end in period. |
| level (required) | 'CanNotDelete' 'ReadOnly' |
The level of the lock. Possible values are: CanNotDelete and ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it. Read-Only locks must be commented to be able to deploy again |
| notes | string | Notes about the lock. Maximum of 512 characters. |
| owners | resourceLockOwner[] | The owners of the lock |
| Property | Value | Description |
|---|---|---|
| applicationId (required) | string | The application ID of the lock owner. |
| Property | Value | Description |
|---|---|---|
| principalId (required) | string | The principal ID |
| roleDefinitionId (required) | string | The role definition ID, data file can be used for this |
| condition | string | Condition on the role assignment |
| conditionVersion | string | Version of the condition. Currently the only accepted value is "2.0" |
| delegatedManagedIdentityResourceId | string | Id of the delegated managed identity resource |
| description | string | Description of role assignment |
| Property | Value | Description |
|---|---|---|
| naming (required) | naming | |
| managedIdentityType | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). (default: None) |
| managedIdentityId | string | User assigned managed identity id to access other resources. |
| managedBy | string | The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource. |
| configuration (required) | configuration | Non versioned Container App configuration properties. |
| template (required) | template | Container App versioned application definition. |
| workloadProfileName | string | Workload profile name to pin for container app execution. |
| Property | Value | Description |
|---|---|---|
| appId (required) | string | Dapr application identifier. |
| appPort (required) | int | Tells Dapr which port your application is listening on. |
| appProtocol | 'grpc' 'http' |
Tells Dapr which protocol your application is using. Valid options are http and grpc. (default: http) |
| enableApiLogging | bool | Enables API logging for the Dapr sidecar. |
| enabled | bool | Boolean indicating if the Dapr side car is enabled. |
| httpMaxRequestSize | int | Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. (default: 4MB) |
| httpReadBufferSize | int | Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. (Default: 65KB) |
| logLevel | 'debug' 'error' 'info' 'warn' |
Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. (Default: info) |
| Property | Value | Description |
|---|---|---|
| allowCredentials | bool | Specifies whether the resource allows credentials. |
| allowedHeaders | string[] | Specifies the content for the access-control-allow-headers header. |
| allowedMethods | string[] | Specifies the content for the access-control-allow-methods header. |
| allowedOrigins (required) | string[] | Specifies the content for the access-control-allow-origins header. |
| exposeHeaders | string[] | Specifies the content for the access-control-expose-headers header. |
| maxAge | int | Specifies the content for the access-control-max-age header. |
| Property | Value | Description |
|---|---|---|
| affinity (required) | 'none' 'sticky' |
Sticky Session Affinity. |
| Property | Value | Description |
|---|---|---|
| allowInsecure | bool | Boolean indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections. (default: false) |
| clientCertificateMode | 'accept' 'ignore' 'require' |
Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate. |
| corsPolicy | corsPolicy | CORS policy for container app. |
| customDomains | containerAppCustomDomain[] | Custom domain bindings for Container Apps hostnames. |
| exposedPort | int | Exposed Port in containers for TCP traffic from ingress. |
| additionalPortMappings | containerAppAdditionalPortMapping[] | Settings to expose additional ports on container app. |
| external (required) | bool | Boolean indicating if app exposes an external http endpoint. |
| ipSecurityRestrictions | containerAppIpSecurityRestrictionRule[] | Rules to restrict incoming IP address. |
| stickySessions | stickySessions | Sticky Sessions for Single Revision Mode. |
| targetPort | int | Target Port in containers for traffic from ingress. |
| traffic | containerAppTrafficWeight[] | Traffic weights for apps revisions. |
| transport | 'auto' 'http' 'http2' 'tcp' |
Ingress transport protocol. (default: auto) |
| Property | Value | Description |
|---|---|---|
| type (required) | string | Dev ContainerApp service type. |
| Property | Value | Description |
|---|---|---|
| eventTriggerConfig | eventTriggerConfig | Trigger configuration of an event driven job. |
| manualTriggerConfig | manualTriggerConfig | Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default |
| registries | containerAppJobRegistryCredentials[] | Collection of private container registry credentials used by a Container apps job |
| replicaRetryLimit | int | Maximum number of retries before failing the job. |
| replicaTimeout (required) | int | Maximum number of seconds a replica is allowed to run. |
| scheduleTriggerConfig | scheduleTriggerConfig | Cron formatted repeating trigger schedule (* * * * *) for cronjobs. Properties completions and parallelism would be set to 1 by default |
| secrets | containerAppJobRegistryCredentialsSecret[] | Collection of secrets used by a Container Apps Job |
| triggerType (required) | 'Event' 'Manual' 'Schedule' |
Trigger type of the job |
| Property | Value | Description |
|---|---|---|
| maxExecutions (required) | int | Maximum number of job executions that are created for a trigger, default 100. |
| minExecutions (required) | int | Minimum number of job executions that are created for a trigger, default 0 |
| pollingInterval (required) | int | Interval to check each event source in seconds. Defaults to 30s |
| rules (required) | containerAppJobScaleRule[] | Scaling rules. |
| Property | Value | Description |
|---|---|---|
| containers (required) | containerAppJobTemplateContainer[] | List of container definitions for the Container App. |
| initContainers | containerAppTemplateInitContainer[] | List of specialized containers that run before app containers. |
| volumes | containerAppTemplateVolume[] | List of volume definitions for the Container App. |
| Property | Value | Description |
|---|---|---|
| naming (required) | naming | |
| managedIdentityType | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). (default: None) |
| managedIdentityId | string | User assigned managed identity id to access other resources |
| configuration (required) | configuration | Container Apps Job configuration properties. |
| template (required) | template | Container Apps job definition. |
| workloadProfileName | string | Workload profile name to pin for container apps job execution. |
| Property | Value | Description |
|---|---|---|
| parallelism | int | Number of parallel replicas of a job that can run at a given time. |
| replicaCompletionCount | int | Minimum number of successful replica completions before overall job completion. |
| scale (required) | scale | Scaling configurations for event driven jobs. |
| Property | Value | Description |
|---|---|---|
| parallelism | int | Number of parallel replicas of a job that can run at a given time. |
| replicaCompletionCount | int | Minimum number of successful replica completions before overall job completion. |
| Property | Value | Description |
|---|---|---|
| cronExpression (required) | string | Cron formatted repeating schedule (* * * * *) of a Cron Job. |
| parallelism | int | Number of parallel replicas of a job that can run at a given time. |
| replicaCompletionCount | int | Minimum number of successful replica completions before overall job completion. |
| Property | Value | Description |
|---|---|---|
| tags | object | Tags of the resource [hashtable] |
| location (required) | string | Location of the resource |
| naming (required) | naming | Naming module of the resource |
| resourceGroupName (required) | string | Name of the resource group where the resource should be located |
| sharedNaming (required) | naming | Reference to the default naming |
| roleAssignments | roleAssignment[] | Role assignments on the resource |
| resourceLocks | resourceLock[] | Resource Locks on the resource |
| Property | Value | Description |
|---|---|---|
| forceFunctionAsFullName | bool | Use the function value as the full name of the resource |
| abbreviation | string | Override the abbreviation of this resource with this parameter |
| environment | string | The resource environment (for example: dev, tst, acc, prd) |
| location | string | The resource location (for example: weu, we, westeurope) |
| customer | string | The name of the customer |
| delimiter | string | The delimiter between resources (default: -) |
| nameFormat | Array containing any of: 'abbreviation' 'customer' 'environment' 'function' 'location' 'param1' 'param2' 'param3' 'useCaseName' |
The order of the array defines the order of elements in the naming scheme |
| param1 | string | Extra parameter self defined |
| param2 | string | Extra parameter self defined |
| param3 | string | Extra parameter self defined |
| function (required) | string | Function of the resource [can be app, db, security,...] |
| useCaseName | string | Name of the use case [can be hub, spoke,...] |
| suffix | string | Suffix for the resource, if empty non will be appended, otherwise will be added to the end [can be index, ...] |
| forceDefaultNaming | bool | Force the CAF naming instead of default company naming |
| Property | Value | Description |
|---|---|---|
| pepNaming | naming | Name of the private endpoint |
| nicNaming | naming | Name of the network interface of the private endpoint |
| privateLinkNaming | naming | Name of the private link connection |
| subnets (required) | subnets[] | Id of the subnets and optionally the name of the resourcegroup in which the private endpoint should be created |
| dnsZoneIds (required) | string[] | List of DNS zone ids that need to be linked |
| Property | Value | Description |
|---|---|---|
| resourceGroupName | string | Resourcegroup (default: resourcegroup defined here => resourceGroup of pep resource => resourceGroup of subnet) |
| id (required) | string | Id of the subnet |
| location | string | Location if Vnet is in different location |