Skip to main content

Azure Components

Reference for every Azure offer in the Fractal Cloud catalogue. Parameters and their required flags are sourced from the agent param contract (FRA-2955); each offer includes a fully-parameterized JSON example.

APIManagement

APIManagement.CaaS.Ambassador

Ambassador is an open-source API gateway and ingress controller deployed in a Kubernetes cluster.

ParameterDescriptionExample / possible valuesRequired
hoststring parameter(empty string)No
hostOwnerEmailstring parameter(string value)Yes
acmeProviderAuthoritystring parameter(string value)Yes
tlsSecretNamestring parameter(string value)Yes
licenseKeystring parameter(empty string)No
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "APIManagement.CaaS.Ambassador",
"parameters": {
"host": "",
"hostOwnerEmail": "example-value",
"acmeProviderAuthority": "example-value",
"tlsSecretName": "example-value",
"licenseKey": "",
"namespace": "example-value"
}
}

APIManagement.CaaS.Traefik

Traefik is a modern reverse proxy and load balancer for Kubernetes, providing routing, TLS termination, and API gateway features.

ParameterDescriptionExample / possible valuesRequired
entryPointslist parameter[] (array)Yes
hostnamestring parameter(empty string)No
loadbalancerIpstring parameter(empty string)No
oidcIssuerUrlstring parameter(string value)Conditional — part of the all-or-nothing OIDC config group
oidcClientIdstring parameter(string value)Conditional — part of the all-or-nothing OIDC config group
oidcClientSecretIdstring parameter(string value)Conditional — part of the all-or-nothing OIDC config group
forwardAuthSecretIdstring parameter(string value)Conditional — part of the all-or-nothing OIDC config group
securityHeadersSettingsmap parameter{}No
tlsCertificateslist parameter[]No
tlsSettingsmap parameter{}No
tracingmap parameter{}No
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "APIManagement.CaaS.Traefik",
"parameters": {
"entryPoints": [],
"hostname": "",
"loadbalancerIp": "",
"oidcIssuerUrl": "example-value",
"oidcClientId": "example-value",
"oidcClientSecretId": "example-value",
"forwardAuthSecretId": "example-value",
"securityHeadersSettings": {},
"tlsCertificates": [],
"tlsSettings": {},
"tracing": {},
"namespace": "example-value"
}
}

APIManagement.PaaS.ApiManagement

Azure API Management is a fully managed service for publishing, managing, and securing APIs.

ParameterDescriptionExample / possible valuesRequired
publisherNamestring parameterPlatform TeamNo
publisherEmailstring parameterplatform@fractal.cloudNo
skuNamestring parameterDeveloper_1No
publicNetworkAccessEnabledboolean parameterTrueNo
identitymap parameter{}No

Example (fully parameterized):

{
"type": "APIManagement.PaaS.ApiManagement",
"parameters": {
"publisherName": "Platform Team",
"publisherEmail": "platform@fractal.cloud",
"skuName": "Developer_1",
"publicNetworkAccessEnabled": true,
"identity": {}
}
}

APIManagement.SaaS.Unmanaged

External API management service with custom configuration supplied via secret.

ParameterDescriptionExample / possible valuesRequired
secretNamestring parameter(empty string)No
secretValuestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "APIManagement.SaaS.Unmanaged",
"parameters": {
"secretName": "",
"secretValue": "example-value"
}
}

BigData

BigData.CaaS.MinioTenant

MinIO is a Kubernetes-hosted S3-compatible object storage system.

ParameterDescriptionExample / possible valuesRequired
minioVersionstring parameterRELEASE.2025-03-12T18-04-18ZNo
serversinteger parameter4No
volumesPerServerinteger parameter4No
volumeSizestring parameter100GiNo
storageClassstring parameter(empty string)No
cpuRequeststring parameter500mNo
cpuLimitstring parameter2No
memoryRequeststring parameter1GiNo
memoryLimitstring parameter4GiNo
requestAutoCertboolean parameterTrueNo
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "BigData.CaaS.MinioTenant",
"parameters": {
"minioVersion": "RELEASE.2025-03-12T18-04-18Z",
"servers": 4,
"volumesPerServer": 4,
"volumeSize": "100Gi",
"storageClass": "",
"cpuRequest": "500m",
"cpuLimit": "2",
"memoryRequest": "1Gi",
"memoryLimit": "4Gi",
"requestAutoCert": true,
"namespace": "example-value"
}
}

BigData.CaaS.SparkCluster

Apache Spark cluster deployed on Kubernetes for distributed data processing.

ParameterDescriptionExample / possible valuesRequired
sparkVersionstring parameter3.5.3No
imagestring parameterapache/spark:3.5.3No
driverCoresstring parameter1No
driverMemorystring parameter1gNo
executorCoresstring parameter2No
executorMemorystring parameter2gNo
executorInstancesinteger parameter2No
sparkOperatorNamestring parameter(string value)Yes
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "BigData.CaaS.SparkCluster",
"parameters": {
"sparkVersion": "3.5.3",
"image": "apache/spark:3.5.3",
"driverCores": "1",
"driverMemory": "1g",
"executorCores": "2",
"executorMemory": "2g",
"executorInstances": 2,
"sparkOperatorName": "example-value",
"namespace": "example-value"
}
}

BigData.CaaS.SparkJob

Spark job that runs on a SparkApplication custom resource in a Kubernetes cluster.

ParameterDescriptionExample / possible valuesRequired
typestring parameterJavaNo
modestring parameterclusterNo
imagestring parameterapache/spark:3.5.3No
mainClassstring parameter(empty string)No
mainApplicationFilestring parameter(empty string)No
argumentslist parameter[]No
sparkVersionstring parameter3.5.3No
sparkConfmap parameter{}No
driverCoresstring parameter1No
driverMemorystring parameter1gNo
executorCoresstring parameter2No
executorMemorystring parameter2gNo
executorInstancesinteger parameter2No
restartPolicystring parameterNeverNo
maxRetriesinteger parameter3No
schedulestring parameter(empty string)No
concurrencyPolicystring parameterForbidNo
sparkOperatorNamestring parameter(string value)Yes
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "BigData.CaaS.SparkJob",
"parameters": {
"type": "Java",
"mode": "cluster",
"image": "apache/spark:3.5.3",
"mainClass": "",
"mainApplicationFile": "",
"arguments": [],
"sparkVersion": "3.5.3",
"sparkConf": {},
"driverCores": "1",
"driverMemory": "1g",
"executorCores": "2",
"executorMemory": "2g",
"executorInstances": 2,
"restartPolicy": "Never",
"maxRetries": 3,
"schedule": "",
"concurrencyPolicy": "Forbid",
"sparkOperatorName": "example-value",
"namespace": "example-value"
}
}

BigData.CaaS.SparkMlExperiment

MLflow experiment server deployed in Kubernetes for machine learning experiment tracking.

ParameterDescriptionExample / possible valuesRequired
mlflowVersionstring parameter2.21.3No
backendStoreUristring parametersqlite:///mlflow/mlflow.dbNo
artifactRootstring parameter/mlflow/artifactsNo
replicasinteger parameter2No
cpuRequeststring parameter250mNo
cpuLimitstring parameter1No
memoryRequeststring parameter512MiNo
memoryLimitstring parameter1GiNo
servicePortinteger parameter5000No
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "BigData.CaaS.SparkMlExperiment",
"parameters": {
"mlflowVersion": "2.21.3",
"backendStoreUri": "sqlite:///mlflow/mlflow.db",
"artifactRoot": "/mlflow/artifacts",
"replicas": 2,
"cpuRequest": "250m",
"cpuLimit": "1",
"memoryRequest": "512Mi",
"memoryLimit": "1Gi",
"servicePort": 5000,
"namespace": "example-value"
}
}

BigData.CaaS.SparkOperator

Spark Operator controller enabling native Spark job submission in Kubernetes.

ParameterDescriptionExample / possible valuesRequired
operatorVersionstring parameter2.5.0No
sparkVersionstring parameter3.5.3No
enableWebhookboolean parameterTrueNo
enableMetricsboolean parameterTrueNo
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "BigData.CaaS.SparkOperator",
"parameters": {
"operatorVersion": "2.5.0",
"sparkVersion": "3.5.3",
"enableWebhook": true,
"enableMetrics": true,
"namespace": "example-value"
}
}

BigData.CaaS.SparkUnityCatalog

Unity Catalog server for governing data and AI assets in a Spark ecosystem.

ParameterDescriptionExample / possible valuesRequired
unityCatalogVersionstring parameter0.3.0No
replicasinteger parameter2No
cpuRequeststring parameter250mNo
cpuLimitstring parameter1No
memoryRequeststring parameter512MiNo
memoryLimitstring parameter1GiNo
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "BigData.CaaS.SparkUnityCatalog",
"parameters": {
"unityCatalogVersion": "0.3.0",
"replicas": 2,
"cpuRequest": "250m",
"cpuLimit": "1",
"memoryRequest": "512Mi",
"memoryLimit": "1Gi",
"namespace": "example-value"
}
}

BigData.PaaS.Databricks

Azure Databricks is a managed Apache Spark platform for big data analytics and machine learning.

ParameterDescriptionExample / possible valuesRequired
pricingTierstring parameterpremiumNo
managedResourceGroupNamestring parameter(empty string)No
enableNoPublicIpboolean parameterFalseNo

Example (fully parameterized):

{
"type": "BigData.PaaS.Databricks",
"parameters": {
"pricingTier": "premium",
"managedResourceGroupName": "",
"enableNoPublicIp": false
}
}

BigData.PaaS.DatabricksCluster

Compute cluster in Databricks for running workloads, notebooks, and jobs.

ParameterDescriptionExample / possible valuesRequired
clusterNamestring parameter(empty string)No
sparkVersionstring parameter(empty string)No
nodeTypeIdstring parameter(empty string)No
numWorkersinteger parameter2No
minWorkersinteger parameter1No
maxWorkersinteger parameter8No
sparkConfmap parameter{}No
pypiLibrarieslist parameter[]No
mavenLibrarieslist parameter[]No
autoTerminationMinutesinteger parameter60No
dataSecurityModestring parameterSINGLE_USERNo

Example (fully parameterized):

{
"type": "BigData.PaaS.DatabricksCluster",
"parameters": {
"clusterName": "",
"sparkVersion": "",
"nodeTypeId": "",
"numWorkers": 2,
"minWorkers": 1,
"maxWorkers": 8,
"sparkConf": {},
"pypiLibraries": [],
"mavenLibraries": [],
"autoTerminationMinutes": 60,
"dataSecurityMode": "SINGLE_USER"
}
}

BigData.PaaS.DatabricksJob

Job in Databricks that executes notebooks, Python files, or JAR tasks on schedule or on-demand.

ParameterDescriptionExample / possible valuesRequired
jobNamestring parameter(empty string)No
taskTypestring parameter(empty string)No
notebookPathstring parameter(string value)Conditional — required when taskType=NOTEBOOK
pythonFilestring parameter(string value)Conditional — required when taskType=PYTHON
mainClassNamestring parameter(string value)Conditional — required when taskType=SPARK_JAR
jarUristring parameter(empty string)No
parameterslist parameter[]No
cronSchedulestring parameter(empty string)No
maxRetriesinteger parameter0No
existingClusterboolean parameterFalseNo
artifactTypestring parameter(empty string)No
artifactUristring parameter(empty string)No
packageNamestring parameter(empty string)No
entryPointstring parameter(string value)Conditional — required for a python_wheel task
entryPointArgslist parameter[]No

Example (fully parameterized):

{
"type": "BigData.PaaS.DatabricksJob",
"parameters": {
"jobName": "",
"taskType": "",
"notebookPath": "example-value",
"pythonFile": "example-value",
"mainClassName": "example-value",
"jarUri": "",
"parameters": [],
"cronSchedule": "",
"maxRetries": 0,
"existingCluster": false,
"artifactType": "",
"artifactUri": "",
"packageName": "",
"entryPoint": "example-value",
"entryPointArgs": []
}
}

BigData.PaaS.DatabricksMlflowExperiment

MLflow experiment in Databricks for tracking and managing machine learning experiments.

ParameterDescriptionExample / possible valuesRequired
experimentNamestring parameter(string value)Yes
artifactLocationstring parameter(empty string)No

Example (fully parameterized):

{
"type": "BigData.PaaS.DatabricksMlflowExperiment",
"parameters": {
"experimentName": "example-value",
"artifactLocation": ""
}
}

BigData.PaaS.StorageAccount

Azure Storage Account for storing blobs, files, queues, and tables.

ParameterDescriptionExample / possible valuesRequired
kindstring parameterStorageV2No
azureRegionstring parameterwesteuropeNo
skustring parameterStandard_LRSNo
extendedLocationmap parameter{} (object)No
identitymap parameter{} (object)No
accessTierstring parameterHotNo
allowBlobPublicAccessboolean parameterFalseNo
allowCrossTenantReplicationboolean parameterFalseNo
allowSharedKeyAccessboolean parameterTrueNo
allowedCopyScopestring parameter(string value)No
azureFilesIdentityBasedAuthenticationmap parameter{} (object)No
customDomainmap parameter{} (object)No
defaultToOAuthAuthenticationboolean parameterFalseNo
dnsEndpointTypestring parameterStandardNo
encryptionmap parameter{} (object)No
immutableStorageWithVersioningmap parameter{} (object)No
isHnsEnabledboolean parametertrue or falseNo
isLocalUserEnabledboolean parametertrue or falseNo
isNfsV3Enabledboolean parametertrue or falseNo
isSftpEnabledboolean parametertrue or falseNo
keyPolicymap parameter{} (object)No
largeFileSharesStatestring parameter(string value)No
minimumTlsVersionstring parameterTLS1_2No
networkRuleSetmap parameter{} (object)No
publicNetworkAccessstring parameterEnabledNo
routingPreferencemap parameter{} (object)No
sasPolicymap parameter{} (object)No
supportsHttpsTrafficOnlyboolean parameterTrueNo
fileServicemap parameter{} (object)No
backupmap parameter{} (object)No

Example (fully parameterized):

{
"type": "BigData.PaaS.StorageAccount",
"parameters": {
"kind": "StorageV2",
"azureRegion": "westeurope",
"sku": "Standard_LRS",
"extendedLocation": {},
"identity": {},
"accessTier": "Hot",
"allowBlobPublicAccess": false,
"allowCrossTenantReplication": false,
"allowSharedKeyAccess": true,
"allowedCopyScope": "example-value",
"azureFilesIdentityBasedAuthentication": {},
"customDomain": {},
"defaultToOAuthAuthentication": false,
"dnsEndpointType": "Standard",
"encryption": {},
"immutableStorageWithVersioning": {},
"isHnsEnabled": true,
"isLocalUserEnabled": true,
"isNfsV3Enabled": true,
"isSftpEnabled": true,
"keyPolicy": {},
"largeFileSharesState": "example-value",
"minimumTlsVersion": "TLS1_2",
"networkRuleSet": {},
"publicNetworkAccess": "Enabled",
"routingPreference": {},
"sasPolicy": {},
"supportsHttpsTrafficOnly": true,
"fileService": {},
"backup": {}
}
}

BigData.SaaS.Unmanaged

External big data service with custom configuration supplied via secret.

ParameterDescriptionExample / possible valuesRequired
secretNamestring parameter(empty string)No
secretValuestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "BigData.SaaS.Unmanaged",
"parameters": {
"secretName": "",
"secretValue": "example-value"
}
}

CustomWorkloads

CustomWorkloads.CaaS.KubernetesWorkload

Generic Kubernetes workload deployed from a GitOps repository.

ParameterDescriptionExample / possible valuesRequired
sshRepositoryURIstring parameter(string value)Yes
repoIdstring parameter(string value)Yes
branchNamestring parameter(string value)Yes
privateSSHKeySecretIdstring parameter(empty string)No
privateSSHKeyEnvironmentSecretShortNamestring parameter(empty string)No
privateSSHKeyPassphraseSecretIdstring parameter(empty string)No
privateSSHKeyPassphraseEnvironmentSecretShortNamestring parameter(empty string)No
ciCdProfileShortNamestring parameter(empty string)No
environmentSecretShortNameslist parameter[]No
roleslist parameter[]No
workloadSecretIdKeystring parameter(empty string)No
workloadSecretPasswordKeystring parameter(empty string)No
workloadIdentityEnabledboolean parameterTrueNo
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "CustomWorkloads.CaaS.KubernetesWorkload",
"parameters": {
"sshRepositoryURI": "example-value",
"repoId": "example-value",
"branchName": "example-value",
"privateSSHKeySecretId": "",
"privateSSHKeyEnvironmentSecretShortName": "",
"privateSSHKeyPassphraseSecretId": "",
"privateSSHKeyPassphraseEnvironmentSecretShortName": "",
"ciCdProfileShortName": "",
"environmentSecretShortNames": [],
"roles": [],
"workloadSecretIdKey": "",
"workloadSecretPasswordKey": "",
"workloadIdentityEnabled": true,
"namespace": "example-value"
}
}

CustomWorkloads.FaaS.AzureFunction

Serverless function hosted in Azure Functions runtime.

ParameterDescriptionExample / possible valuesRequired
configurationmap parameter{}No
appSettingsmap parameter{}No
identitymap parameter{}No
appServicePlanmap parameter{}No
storageAccountConnectionStringstring parameter(empty string)No
sourceArtifactstring parameter(empty string)No
packageTypestring parameter(empty string)No

Example (fully parameterized):

{
"type": "CustomWorkloads.FaaS.AzureFunction",
"parameters": {
"configuration": {},
"appSettings": {},
"identity": {},
"appServicePlan": {},
"storageAccountConnectionString": "",
"sourceArtifact": "",
"packageType": ""
}
}

CustomWorkloads.PaaS.AzureContainerApp

Container application managed by Azure Container Apps, a serverless container hosting service.

ParameterDescriptionExample / possible valuesRequired
imagestring parameter(empty string)No
cpunumber parameter0.5No
memorystring parameter1GiNo
portinteger parameter8080No
externalIngressboolean parameterTrueNo
minReplicasinteger parameter0No
maxReplicasinteger parameter10No
locationstring parameter(empty string)No
resourceGroupstring parameter(empty string)No

Example (fully parameterized):

{
"type": "CustomWorkloads.PaaS.AzureContainerApp",
"parameters": {
"image": "",
"cpu": 0.5,
"memory": "1Gi",
"port": 8080,
"externalIngress": true,
"minReplicas": 0,
"maxReplicas": 10,
"location": "",
"resourceGroup": ""
}
}

CustomWorkloads.PaaS.AzureContainerInstance

Container instance managed by Azure Container Instances for quick, serverless deployment.

ParameterDescriptionExample / possible valuesRequired
imagestring parameter(empty string)No
cpunumber parameter1.0No
memoryInGBnumber parameter1.5No
portinteger parameter8080No
restartPolicystring parameterAlwaysNo
publicIpboolean parameterFalseNo
dnsNameLabelstring parameter(empty string)No
locationstring parameter(empty string)No
resourceGroupstring parameter(empty string)No

Example (fully parameterized):

{
"type": "CustomWorkloads.PaaS.AzureContainerInstance",
"parameters": {
"image": "",
"cpu": 1.0,
"memoryInGB": 1.5,
"port": 8080,
"restartPolicy": "Always",
"publicIp": false,
"dnsNameLabel": "",
"location": "",
"resourceGroup": ""
}
}

CustomWorkloads.PaaS.WebApp

Azure App Service web application for hosting web apps and APIs.

ParameterDescriptionExample / possible valuesRequired
azureRegionstring parameter(empty string)No
containerSizeinteger parameter0No
certificateslist parameter[]No
customDomainslist parameter[]No
appServicePlanmap parameter{}No
configurationmap parameter{}No
cloningInfomap parameter{}No
clientAffinityEnabledboolean parameterFalseNo
clientCertEnabledboolean parameterFalseNo
clientCertExclusionPathsstring parameter(empty string)No
clientCertModestring parameter(empty string)No
customDomainVerificationIdstring parameter(empty string)No
hostingEnvironmentProfileIdstring parameter(empty string)No
redundancyModestring parameter(empty string)No
virtualNetworkSubnetIdstring parameter(empty string)No
publishingUsernamestring parameterFractal CloudNo
httpsOnlyboolean parameterTrueNo
enabledboolean parameterFalseNo
hostNamesDisabledboolean parameterFalseNo
hyperVboolean parameterFalseNo
reservedboolean parameterFalseNo
scmSiteAlsoStoppedboolean parameterFalseNo
storageAccountRequiredboolean parameterFalseNo
dailyMemoryTimeQuotainteger parameter0No
repoIdstring parameter(empty string)No
branchNamestring parameter(empty string)No
sshRepositoryURIstring parameter(empty string)No
privateSSHKeySecretIdstring parameter(empty string)No
privateSSHKeyPassphraseSecretIdstring parameter(empty string)No
ciCdProfileShortNamestring parameter(empty string)No
roleslist parameter[]No
workloadSecretIdKeystring parameter(empty string)No
workloadSecretPasswordKeystring parameter(empty string)No

Example (fully parameterized):

{
"type": "CustomWorkloads.PaaS.WebApp",
"parameters": {
"azureRegion": "",
"containerSize": 0,
"certificates": [],
"customDomains": [],
"appServicePlan": {},
"configuration": {},
"cloningInfo": {},
"clientAffinityEnabled": false,
"clientCertEnabled": false,
"clientCertExclusionPaths": "",
"clientCertMode": "",
"customDomainVerificationId": "",
"hostingEnvironmentProfileId": "",
"redundancyMode": "",
"virtualNetworkSubnetId": "",
"publishingUsername": "Fractal Cloud",
"httpsOnly": true,
"enabled": false,
"hostNamesDisabled": false,
"hyperV": false,
"reserved": false,
"scmSiteAlsoStopped": false,
"storageAccountRequired": false,
"dailyMemoryTimeQuota": 0,
"repoId": "",
"branchName": "",
"sshRepositoryURI": "",
"privateSSHKeySecretId": "",
"privateSSHKeyPassphraseSecretId": "",
"ciCdProfileShortName": "",
"roles": [],
"workloadSecretIdKey": "",
"workloadSecretPasswordKey": ""
}
}

CustomWorkloads.SaaS.Unmanaged

External custom workload service with custom configuration supplied via secret.

ParameterDescriptionExample / possible valuesRequired
secretNamestring parameter(empty string)No
secretValuestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "CustomWorkloads.SaaS.Unmanaged",
"parameters": {
"secretName": "",
"secretValue": "example-value"
}
}

Messaging

Messaging.CaaS.Kafka

Apache Kafka cluster deployed on Kubernetes for event streaming.

ParameterDescriptionExample / possible valuesRequired
replicasinteger parameter5No
kafkaVersionstring parameter4.2.0No
memoryRequeststring parameter16GiNo
memoryLimitstring parameter32GiNo
cpuRequeststring parameter4No
cpuLimitstring parameter8No
storageSizestring parameter1TiNo
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Messaging.CaaS.Kafka",
"parameters": {
"replicas": 5,
"kafkaVersion": "4.2.0",
"memoryRequest": "16Gi",
"memoryLimit": "32Gi",
"cpuRequest": "4",
"cpuLimit": "8",
"storageSize": "1Ti",
"namespace": "example-value"
}
}

Messaging.CaaS.KafkaTopic

Topic in a Kafka cluster for publishing and consuming messages.

ParameterDescriptionExample / possible valuesRequired
partitionsinteger parameter50No
replicasinteger parameter2No
retentionMsinteger parameter172800000No
clusterNamestring parameter(string value)Yes
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Messaging.CaaS.KafkaTopic",
"parameters": {
"partitions": 50,
"replicas": 2,
"retentionMs": 172800000,
"clusterName": "example-value",
"namespace": "example-value"
}
}

Messaging.CaaS.KafkaUser

Kafka user with ACLs for secure access to Kafka cluster topics.

ParameterDescriptionExample / possible valuesRequired
aclslist parameter[]No
clusterNamestring parameter(string value)Yes
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Messaging.CaaS.KafkaUser",
"parameters": {
"acls": [],
"clusterName": "example-value",
"namespace": "example-value"
}
}

Messaging.PaaS.EventHubInstance

Event hub instance in Azure Event Hubs for capturing event streams.

ParameterDescriptionExample / possible valuesRequired
partitionCountinteger parameter1No
messageRetentionInDaysinteger parameter1No
userMetadatastring parameter(empty string)No
retentionmap parameter{"cleanupPolicy": "Compact", "tombstoneTimeInHours": 12, "timeInHours": 12}No

Example (fully parameterized):

{
"type": "Messaging.PaaS.EventHubInstance",
"parameters": {
"partitionCount": 1,
"messageRetentionInDays": 1,
"userMetadata": "",
"retention": {
"cleanupPolicy": "Compact",
"tombstoneTimeInHours": 12,
"timeInHours": 12
}
}
}

Messaging.PaaS.EventHubNamespace

Namespace in Azure Event Hubs containing event hubs and related infrastructure.

ParameterDescriptionExample / possible valuesRequired
kafkaEnabledboolean parameterTrueNo
alternateNamestring parameter(empty string)No
diableLocalAuthboolean parameterFalseNo
autoInflateEnabledboolean parameterTrueNo
maximumThroughputUnitsinteger parameter20No
minimumTlsVersionstring parameter1.2No
publicNetworkAccessstring parameterDisabledNo
skumap parameter{"tier": "Standard", "name": "Standard", "capacity": 1}No
zoneRedundantboolean parameterFalseNo

Example (fully parameterized):

{
"type": "Messaging.PaaS.EventHubNamespace",
"parameters": {
"kafkaEnabled": true,
"alternateName": "",
"diableLocalAuth": false,
"autoInflateEnabled": true,
"maximumThroughputUnits": 20,
"minimumTlsVersion": "1.2",
"publicNetworkAccess": "Disabled",
"sku": {
"tier": "Standard",
"name": "Standard",
"capacity": 1
},
"zoneRedundant": false
}
}

Messaging.PaaS.Relay

Azure Relay service for secure communication across network boundaries.

No configurable parameters.

Example (fully parameterized):

{
"type": "Messaging.PaaS.Relay",
"parameters": {}
}

Messaging.PaaS.ServiceBus

Azure Service Bus namespace for messaging, queues, topics, and subscriptions.

ParameterDescriptionExample / possible valuesRequired
skumap parameter{}No
skuTierstring parameter(empty string)No
identitystring parameterSystemAssignedNo
encryptionmap parameter{}No
disableLocalAuthboolean parameterFalseNo
zoneRedundantboolean parameterFalseNo

Example (fully parameterized):

{
"type": "Messaging.PaaS.ServiceBus",
"parameters": {
"sku": {},
"skuTier": "",
"identity": "SystemAssigned",
"encryption": {},
"disableLocalAuth": false,
"zoneRedundant": false
}
}

Messaging.PaaS.ServiceBusQueue

Message queue in Azure Service Bus for reliable message delivery.

ParameterDescriptionExample / possible valuesRequired
autoDeleteOnIdlestring parameterPT5MNo
deadLetteringOnMessageExpirationboolean parameterFalseNo
defaultMessageTimeToLivestring parameterPT5MNo
duplicateDetectionHistoryTimeWindowstring parameterPT5MNo
enableExpressboolean parameterFalseNo
enableBatchedOperationsboolean parameterFalseNo
enablePartitioningboolean parameterFalseNo
forwardTostring parameter(empty string)No
forwardDeadLetteredMessagesTostring parameter(empty string)No
lockDurationstring parameterPT5MNo
maxDeliveryCountinteger parameter1No
maxSizeInMegabytesinteger parameter1024No
maxMessageSizeInKilobytesinteger parameter256No
requiresSessionboolean parameterFalseNo
requiresDuplicateDetectionboolean parameterFalseNo
statusstring parameterUnknownNo

Example (fully parameterized):

{
"type": "Messaging.PaaS.ServiceBusQueue",
"parameters": {
"autoDeleteOnIdle": "PT5M",
"deadLetteringOnMessageExpiration": false,
"defaultMessageTimeToLive": "PT5M",
"duplicateDetectionHistoryTimeWindow": "PT5M",
"enableExpress": false,
"enableBatchedOperations": false,
"enablePartitioning": false,
"forwardTo": "",
"forwardDeadLetteredMessagesTo": "",
"lockDuration": "PT5M",
"maxDeliveryCount": 1,
"maxSizeInMegabytes": 1024,
"maxMessageSizeInKilobytes": 256,
"requiresSession": false,
"requiresDuplicateDetection": false,
"status": "Unknown"
}
}

Messaging.PaaS.ServiceBusTopic

Topic in Azure Service Bus for pub/sub messaging patterns.

ParameterDescriptionExample / possible valuesRequired
autoDeleteOnIdlestring parameterPT5MNo
defaultMessageTimeToLivestring parameterPT5MNo
duplicateDetectionHistoryTimeWindowstring parameterPT5MNo
enableExpressboolean parameterFalseNo
enableBatchedOperationsboolean parameterFalseNo
enablePartitioningboolean parameterFalseNo
maxSizeInMegabytesinteger parameter1024No
maxMessageSizeInKilobytesinteger parameter256No
requiresDuplicateDetectionboolean parameterFalseNo
statusstring parameterUnknownNo
supportOrderingboolean parameterFalseNo

Example (fully parameterized):

{
"type": "Messaging.PaaS.ServiceBusTopic",
"parameters": {
"autoDeleteOnIdle": "PT5M",
"defaultMessageTimeToLive": "PT5M",
"duplicateDetectionHistoryTimeWindow": "PT5M",
"enableExpress": false,
"enableBatchedOperations": false,
"enablePartitioning": false,
"maxSizeInMegabytes": 1024,
"maxMessageSizeInKilobytes": 256,
"requiresDuplicateDetection": false,
"status": "Unknown",
"supportOrdering": false
}
}

Messaging.SaaS.Unmanaged

External messaging service with custom configuration supplied via secret.

ParameterDescriptionExample / possible valuesRequired
secretNamestring parameter(empty string)No
secretValuestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Messaging.SaaS.Unmanaged",
"parameters": {
"secretName": "",
"secretValue": "example-value"
}
}

NetworkAndCompute

NetworkAndCompute.IaaS.AzureLoadBalancer

Azure Load Balancer distributes incoming traffic across backend resources.

ParameterDescriptionExample / possible valuesRequired
lbTypestring parameterStandardNo
lbSchemestring parameterinternalNo

Example (fully parameterized):

{
"type": "NetworkAndCompute.IaaS.AzureLoadBalancer",
"parameters": {
"lbType": "Standard",
"lbScheme": "internal"
}
}

NetworkAndCompute.IaaS.AzureNetworkSecurityGroup

Network Security Group controls inbound and outbound traffic with security rules.

ParameterDescriptionExample / possible valuesRequired
descriptionstring parameter(empty string)No
ingressRuleslist parameter[]No

Example (fully parameterized):

{
"type": "NetworkAndCompute.IaaS.AzureNetworkSecurityGroup",
"parameters": {
"description": "",
"ingressRules": []
}
}

NetworkAndCompute.IaaS.AzureSecurityGroup

Network security group for controlling traffic flow to and from resources.

ParameterDescriptionExample / possible valuesRequired
descriptionstring parameter(empty string)No
ingressRuleslist parameter[]No

Example (fully parameterized):

{
"type": "NetworkAndCompute.IaaS.AzureSecurityGroup",
"parameters": {
"description": "",
"ingressRules": []
}
}

NetworkAndCompute.IaaS.AzureSubnet

Subnet within a virtual network for grouping and isolating resources.

ParameterDescriptionExample / possible valuesRequired
cidrBlockstring parameter(empty string)No
vnetNamestring parameter(empty string)No

Example (fully parameterized):

{
"type": "NetworkAndCompute.IaaS.AzureSubnet",
"parameters": {
"cidrBlock": "",
"vnetName": ""
}
}

NetworkAndCompute.IaaS.AzureVirtualMachine

Virtual machine in Azure for computing workloads.

ParameterDescriptionExample / possible valuesRequired
instanceTypestring parameterStandard_B1sNo
imageIdstring parameterCanonical:UbuntuServer:18.04-LTS:latestNo
keyNamestring parameter(empty string)No
userDatastring parameter(empty string)No
associatePublicIpboolean parameterFalseNo

Example (fully parameterized):

{
"type": "NetworkAndCompute.IaaS.AzureVirtualMachine",
"parameters": {
"instanceType": "Standard_B1s",
"imageId": "Canonical:UbuntuServer:18.04-LTS:latest",
"keyName": "",
"userData": "",
"associatePublicIp": false
}
}

NetworkAndCompute.IaaS.AzureVirtualNetwork

Virtual network in Azure providing isolated network environment.

ParameterDescriptionExample / possible valuesRequired
cidrBlockstring parameter(empty string)No

Example (fully parameterized):

{
"type": "NetworkAndCompute.IaaS.AzureVirtualNetwork",
"parameters": {
"cidrBlock": ""
}
}

NetworkAndCompute.IaaS.SecurityGroup

Network security group for controlling inbound and outbound traffic.

ParameterDescriptionExample / possible valuesRequired
descriptionstring parameter(empty string)No
ingressRuleslist parameter[]No

Example (fully parameterized):

{
"type": "NetworkAndCompute.IaaS.SecurityGroup",
"parameters": {
"description": "",
"ingressRules": []
}
}

NetworkAndCompute.IaaS.VNet

Virtual network providing isolated networking and connectivity for Azure resources.

ParameterDescriptionExample / possible valuesRequired
cidrBlockstring parameter(empty string)No

Example (fully parameterized):

{
"type": "NetworkAndCompute.IaaS.VNet",
"parameters": {
"cidrBlock": ""
}
}

NetworkAndCompute.PaaS.AKS

Azure Kubernetes Service — managed Kubernetes cluster in Azure.

ParameterDescriptionExample / possible valuesRequired
managedClusterSkuTierstring parameterFreeNo
azureActiveDirectoryProfilemap parameter{}No
outboundIpslist parameter[]No
cidrBlockstring parameter(empty string)No
vnetSubnetAddressIpRangestring parameter(empty string)No
podIpRangestring parameter(empty string)No
serviceIpRangestring parameter(empty string)No

Example (fully parameterized):

{
"type": "NetworkAndCompute.PaaS.AKS",
"parameters": {
"managedClusterSkuTier": "Free",
"azureActiveDirectoryProfile": {},
"outboundIps": [],
"cidrBlock": "",
"vnetSubnetAddressIpRange": "",
"podIpRange": "",
"serviceIpRange": ""
}
}

NetworkAndCompute.PaaS.AzureAppService

Shared compute infrastructure for running App Service apps.

No configurable parameters.

Example (fully parameterized):

{
"type": "NetworkAndCompute.PaaS.AzureAppService",
"parameters": {}
}

NetworkAndCompute.PaaS.AzureContainerAppsEnvironment

Container Apps Environment providing container runtime and networking.

ParameterDescriptionExample / possible valuesRequired
locationstring parameter(empty string)No
resourceGroupstring parameter(empty string)No
logAnalyticsWorkspaceIdstring parameter(empty string)No
logAnalyticsSharedKeystring parameter(empty string)No

Example (fully parameterized):

{
"type": "NetworkAndCompute.PaaS.AzureContainerAppsEnvironment",
"parameters": {
"location": "",
"resourceGroup": "",
"logAnalyticsWorkspaceId": "",
"logAnalyticsSharedKey": ""
}
}

NetworkAndCompute.PaaS.AzureContainerInstanceService

Service for running containers on Azure Container Instances.

No configurable parameters.

Example (fully parameterized):

{
"type": "NetworkAndCompute.PaaS.AzureContainerInstanceService",
"parameters": {}
}

NetworkAndCompute.PaaS.DnsZone

DNS zone for managing DNS records and domain resolution.

ParameterDescriptionExample / possible valuesRequired
isPrivateboolean parameterTrueNo

Example (fully parameterized):

{
"type": "NetworkAndCompute.PaaS.DnsZone",
"parameters": {
"isPrivate": true
}
}

NetworkAndCompute.PaaS.Kubernetes

Managed Kubernetes cluster in Azure (alias for AKS).

ParameterDescriptionExample / possible valuesRequired
managedClusterSkuTierstring parameterFreeNo
azureActiveDirectoryProfilemap parameter{}No
outboundIpslist parameter[]No
cidrBlockstring parameter(empty string)No
vnetSubnetAddressIpRangestring parameter(empty string)No
podIpRangestring parameter(empty string)No
serviceIpRangestring parameter(empty string)No

Example (fully parameterized):

{
"type": "NetworkAndCompute.PaaS.Kubernetes",
"parameters": {
"managedClusterSkuTier": "Free",
"azureActiveDirectoryProfile": {},
"outboundIps": [],
"cidrBlock": "",
"vnetSubnetAddressIpRange": "",
"podIpRange": "",
"serviceIpRange": ""
}
}

NetworkAndCompute.SaaS.Unmanaged

External network/compute service with custom configuration supplied via secret.

ParameterDescriptionExample / possible valuesRequired
secretNamestring parameter(empty string)No
secretValuestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "NetworkAndCompute.SaaS.Unmanaged",
"parameters": {
"secretName": "",
"secretValue": "example-value"
}
}

Observability

Observability.CaaS.Elastic

Elastic Stack (Elasticsearch + Kibana) deployed on Kubernetes for logging and analytics.

ParameterDescriptionExample / possible valuesRequired
elasticVersionstring parameter(string value)Yes
elasticInstancesinteger parameter1 (example)Yes
storagestring parameter(string value)Yes
storageClassNamestring parameter(empty string)No
memoryinteger parameter8No
cpuinteger parameter8No
isApmRequiredboolean parameterFalseNo
isKibanaRequiredboolean parameterTrueNo
secretsmap parameter{}No
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Observability.CaaS.Elastic",
"parameters": {
"elasticVersion": "example-value",
"elasticInstances": 1,
"storage": "example-value",
"storageClassName": "",
"memory": 8,
"cpu": 8,
"isApmRequired": false,
"isKibanaRequired": true,
"secrets": {},
"namespace": "example-value"
}
}

Observability.CaaS.Jaeger

Jaeger distributed tracing system deployed on Kubernetes.

ParameterDescriptionExample / possible valuesRequired
storageClassNamestring parameter(empty string)No
storageSettingsmap parameter{}No
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Observability.CaaS.Jaeger",
"parameters": {
"storageClassName": "",
"storageSettings": {},
"namespace": "example-value"
}
}

Observability.CaaS.Prometheus

Prometheus monitoring and alerting system deployed on Kubernetes.

ParameterDescriptionExample / possible valuesRequired
grafanaConfigSecretIdstring parameter(empty string)No
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Observability.CaaS.Prometheus",
"parameters": {
"grafanaConfigSecretId": "",
"namespace": "example-value"
}
}

Observability.SaaS.Elastic

External Elastic Cloud (hosted Elasticsearch) with custom URI configuration.

ParameterDescriptionExample / possible valuesRequired
kibanaUristring parameter(string value)Yes
versionstring parameter(string value)Yes
operatorVersionstring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Observability.SaaS.Elastic",
"parameters": {
"kibanaUri": "example-value",
"version": "example-value",
"operatorVersion": "example-value"
}
}

Observability.SaaS.Jaeger

External Jaeger instance with custom frontend URI.

ParameterDescriptionExample / possible valuesRequired
frontendUristring parameter(string value)Yes
versionstring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Observability.SaaS.Jaeger",
"parameters": {
"frontendUri": "example-value",
"version": "example-value"
}
}

Observability.SaaS.Prometheus

External Prometheus service with API gateway and authentication.

ParameterDescriptionExample / possible valuesRequired
apiGatewayUrlstring parameter(string value)Yes
grafanaConfigSecretIdstring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Observability.SaaS.Prometheus",
"parameters": {
"apiGatewayUrl": "example-value",
"grafanaConfigSecretId": "example-value"
}
}

Security

Security.CaaS.Ocelot

Ocelot API gateway deployed in Kubernetes for authentication and routing.

ParameterDescriptionExample / possible valuesRequired
hoststring parameter(string value)Yes
corsOriginslist parameter[]No
cookieMaxAgeSecinteger parameter900No
pathPrefixstring parameter/*No
roleslist parameter[]No
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Security.CaaS.Ocelot",
"parameters": {
"host": "example-value",
"corsOrigins": [],
"cookieMaxAgeSec": 900,
"pathPrefix": "/*",
"roles": [],
"namespace": "example-value"
}
}

Security.SaaS.Unmanaged

External security service with custom configuration supplied via secret.

ParameterDescriptionExample / possible valuesRequired
secretNamestring parameter(empty string)No
secretValuestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Security.SaaS.Unmanaged",
"parameters": {
"secretName": "",
"secretValue": "example-value"
}
}

Storage

Storage.CaaS.CnpgCluster

CloudNativePG cluster — PostgreSQL deployed natively on Kubernetes.

ParameterDescriptionExample / possible valuesRequired
instancesinteger parameter3No
postgresqlVersionstring parameter17.2No
storageSizestring parameter10GiNo
storageClassstring parameter(empty string)No
cpuRequeststring parameter500mNo
cpuLimitstring parameter1No
memoryRequeststring parameter512MiNo
memoryLimitstring parameter1GiNo
databasestring parameterappNo
databaseOwnerstring parameterappNo
enableSuperuserAccessboolean parameterFalseNo
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Storage.CaaS.CnpgCluster",
"parameters": {
"instances": 3,
"postgresqlVersion": "17.2",
"storageSize": "10Gi",
"storageClass": "",
"cpuRequest": "500m",
"cpuLimit": "1",
"memoryRequest": "512Mi",
"memoryLimit": "1Gi",
"database": "app",
"databaseOwner": "app",
"enableSuperuserAccess": false,
"namespace": "example-value"
}
}

Storage.CaaS.CnpgDatabase

Database in a CloudNativePG cluster.

ParameterDescriptionExample / possible valuesRequired
databaseNamestring parameterappNo
databaseOwnerstring parameterappNo
encodingstring parameterUTF8No
localeCollatestring parameter(empty string)No
localeCTypestring parameter(empty string)No
cnpgClusterNamestring parameter(string value)Yes
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Storage.CaaS.CnpgDatabase",
"parameters": {
"databaseName": "app",
"databaseOwner": "app",
"encoding": "UTF8",
"localeCollate": "",
"localeCType": "",
"cnpgClusterName": "example-value",
"namespace": "example-value"
}
}

Storage.CaaS.Elastic

Elastic Stack (Elasticsearch + Kibana) deployed on Kubernetes.

ParameterDescriptionExample / possible valuesRequired
elasticVersionstring parameter(string value)Yes
elasticInstancesinteger parameter1 (example)Yes
storagestring parameter(string value)Yes
storageClassNamestring parameter(empty string)No
memoryinteger parameter8No
cpuinteger parameter8No
isApmRequiredboolean parameterFalseNo
isKibanaRequiredboolean parameterTrueNo
secretsmap parameter{}No
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Storage.CaaS.Elastic",
"parameters": {
"elasticVersion": "example-value",
"elasticInstances": 1,
"storage": "example-value",
"storageClassName": "",
"memory": 8,
"cpu": 8,
"isApmRequired": false,
"isKibanaRequired": true,
"secrets": {},
"namespace": "example-value"
}
}

Storage.CaaS.MinioTenant

MinIO S3-compatible object storage cluster deployed on Kubernetes.

ParameterDescriptionExample / possible valuesRequired
minioVersionstring parameterRELEASE.2025-03-12T18-04-18ZNo
serversinteger parameter4No
volumesPerServerinteger parameter4No
volumeSizestring parameter100GiNo
storageClassstring parameter(empty string)No
cpuRequeststring parameter500mNo
cpuLimitstring parameter2No
memoryRequeststring parameter1GiNo
memoryLimitstring parameter4GiNo
requestAutoCertboolean parameterTrueNo
namespacestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Storage.CaaS.MinioTenant",
"parameters": {
"minioVersion": "RELEASE.2025-03-12T18-04-18Z",
"servers": 4,
"volumesPerServer": 4,
"volumeSize": "100Gi",
"storageClass": "",
"cpuRequest": "500m",
"cpuLimit": "2",
"memoryRequest": "1Gi",
"memoryLimit": "4Gi",
"requestAutoCert": true,
"namespace": "example-value"
}
}

Storage.PaaS.CosmosDbAccount

Azure Cosmos DB account providing multi-model database service.

ParameterDescriptionExample / possible valuesRequired
maxTotalThroughputinteger parameter-1No
publicNetworkAccessstring parameterDisabledNo
backupPolicymap parameter{}No

Example (fully parameterized):

{
"type": "Storage.PaaS.CosmosDbAccount",
"parameters": {
"maxTotalThroughput": -1,
"publicNetworkAccess": "Disabled",
"backupPolicy": {}
}
}

Storage.PaaS.CosmosDbCassandra

Cassandra API database in Azure Cosmos DB.

ParameterDescriptionExample / possible valuesRequired
cassandraVersionstring parameter3.11No
useCassandraAuthenticationboolean parameterTrueNo
isDeallocatedboolean parameterFalseNo
delegatedManagementSubnetIdstring parameter(empty string)No
isCassandraAuditLoggingEnabledboolean parameterTrueNo
hoursBetweenBackupsinteger parameter24No

Example (fully parameterized):

{
"type": "Storage.PaaS.CosmosDbCassandra",
"parameters": {
"cassandraVersion": "3.11",
"useCassandraAuthentication": true,
"isDeallocated": false,
"delegatedManagementSubnetId": "",
"isCassandraAuditLoggingEnabled": true,
"hoursBetweenBackups": 24
}
}

Storage.PaaS.CosmosDbGremlinDatabase

Gremlin graph database in Azure Cosmos DB.

ParameterDescriptionExample / possible valuesRequired
throughputinteger parameter-1No
maxThroughputinteger parameter2000No

Example (fully parameterized):

{
"type": "Storage.PaaS.CosmosDbGremlinDatabase",
"parameters": {
"throughput": -1,
"maxThroughput": 2000
}
}

Storage.PaaS.CosmosDbMongoDatabase

MongoDB API database in Azure Cosmos DB.

ParameterDescriptionExample / possible valuesRequired
throughputinteger parameter-1No
maxThroughputinteger parameter2000No

Example (fully parameterized):

{
"type": "Storage.PaaS.CosmosDbMongoDatabase",
"parameters": {
"throughput": -1,
"maxThroughput": 2000
}
}

Storage.PaaS.CosmosDbPostgreSqlDatabase

PostgreSQL database in Azure Cosmos DB.

ParameterDescriptionExample / possible valuesRequired
azureRegionstring parameter(empty string)No
storageAutoGrowstring parameterEnabledNo
highAvailabilityModestring parameterDisabledNo
replicationRolestring parameterPrimaryNo
versionstring parameter18No
isPrivateboolean parameterTrueNo
firewallRuleslist parameter[]No
rootUserstring parameterfractalNo
skuNamestring parameterStandard_D4ds_v5No
storageGbinteger parameter128No
coordinatorStorageGbinteger parameter128No
workerStorageGbinteger parameter128No
backupRetentionDaysinteger parameter10No
coordinatorCoresinteger parameter2No
workersCoresinteger parameter4No
nodeCountinteger parameter0No
coordinatorServerEditionstring parameterGeneralPurposeNo
nodeServerEditionstring parameterMemoryOptimizedNo
subnetAddressCidrstring parameter10.1.1.0/27No

Example (fully parameterized):

{
"type": "Storage.PaaS.CosmosDbPostgreSqlDatabase",
"parameters": {
"azureRegion": "",
"storageAutoGrow": "Enabled",
"highAvailabilityMode": "Disabled",
"replicationRole": "Primary",
"version": "18",
"isPrivate": true,
"firewallRules": [],
"rootUser": "fractal",
"skuName": "Standard_D4ds_v5",
"storageGb": 128,
"coordinatorStorageGb": 128,
"workerStorageGb": 128,
"backupRetentionDays": 10,
"coordinatorCores": 2,
"workersCores": 4,
"nodeCount": 0,
"coordinatorServerEdition": "GeneralPurpose",
"nodeServerEdition": "MemoryOptimized",
"subnetAddressCidr": "10.1.1.0/27"
}
}

Storage.PaaS.CosmosDbPostgresSqlCluster

PostgreSQL cluster in Azure Cosmos DB with distributed compute.

ParameterDescriptionExample / possible valuesRequired
azureRegionstring parameter(empty string)No
storageAutoGrowstring parameterEnabledNo
highAvailabilityModestring parameterDisabledNo
replicationRolestring parameterPrimaryNo
versionstring parameter18No
isPrivateboolean parameterTrueNo
firewallRuleslist parameter[]No
rootUserstring parameterfractalNo
skuNamestring parameterStandard_D4ds_v5No
storageGbinteger parameter128No
coordinatorStorageGbinteger parameter128No
workerStorageGbinteger parameter128No
backupRetentionDaysinteger parameter10No
coordinatorCoresinteger parameter2No
workersCoresinteger parameter4No
nodeCountinteger parameter0No
coordinatorServerEditionstring parameterGeneralPurposeNo
nodeServerEditionstring parameterMemoryOptimizedNo
subnetAddressCidrstring parameter10.1.1.0/27No

Example (fully parameterized):

{
"type": "Storage.PaaS.CosmosDbPostgresSqlCluster",
"parameters": {
"azureRegion": "",
"storageAutoGrow": "Enabled",
"highAvailabilityMode": "Disabled",
"replicationRole": "Primary",
"version": "18",
"isPrivate": true,
"firewallRules": [],
"rootUser": "fractal",
"skuName": "Standard_D4ds_v5",
"storageGb": 128,
"coordinatorStorageGb": 128,
"workerStorageGb": 128,
"backupRetentionDays": 10,
"coordinatorCores": 2,
"workersCores": 4,
"nodeCount": 0,
"coordinatorServerEdition": "GeneralPurpose",
"nodeServerEdition": "MemoryOptimized",
"subnetAddressCidr": "10.1.1.0/27"
}
}

Storage.PaaS.CosmosDbSqlDatabase

SQL API database in Azure Cosmos DB.

ParameterDescriptionExample / possible valuesRequired
throughputinteger parameter-1No
maxThroughputinteger parameter2000No

Example (fully parameterized):

{
"type": "Storage.PaaS.CosmosDbSqlDatabase",
"parameters": {
"throughput": -1,
"maxThroughput": 2000
}
}

Storage.PaaS.CosmosDbTable

Table API database in Azure Cosmos DB.

ParameterDescriptionExample / possible valuesRequired
throughputinteger parameter-1No
maxThroughputinteger parameter2000No

Example (fully parameterized):

{
"type": "Storage.PaaS.CosmosDbTable",
"parameters": {
"throughput": -1,
"maxThroughput": 2000
}
}

Storage.PaaS.FileShare

File share within Azure Storage Account for SMB/NFS access.

ParameterDescriptionExample / possible valuesRequired
accessTierstring parameterTransactionOptimizedNo
enabledProtocolsstring parameterSMBNo
metadatamap parameter{} (object)No
rootSquashstring parameter(empty string)No
shareQuotainteger parameter5120No
signedIdentifierslist parameter[] (array)No

Example (fully parameterized):

{
"type": "Storage.PaaS.FileShare",
"parameters": {
"accessTier": "TransactionOptimized",
"enabledProtocols": "SMB",
"metadata": {},
"rootSquash": "",
"shareQuota": 5120,
"signedIdentifiers": []
}
}

Storage.PaaS.FileStorage

Premium file storage in Azure.

ParameterDescriptionExample / possible valuesRequired
accessTierstring parameterTransactionOptimizedNo
enabledProtocolsstring parameterSMBNo
metadatamap parameter{} (object)No
rootSquashstring parameter(empty string)No
shareQuotainteger parameter5120No
signedIdentifierslist parameter[] (array)No

Example (fully parameterized):

{
"type": "Storage.PaaS.FileStorage",
"parameters": {
"accessTier": "TransactionOptimized",
"enabledProtocols": "SMB",
"metadata": {},
"rootSquash": "",
"shareQuota": 5120,
"signedIdentifiers": []
}
}

Storage.PaaS.PostgreSqlDatabase

Database in an Azure PostgreSQL server.

ParameterDescriptionExample / possible valuesRequired
charsetstring parameterUTF8No
collationstring parameteren_US.utf8No

Example (fully parameterized):

{
"type": "Storage.PaaS.PostgreSqlDatabase",
"parameters": {
"charset": "UTF8",
"collation": "en_US.utf8"
}
}

Storage.PaaS.PostgreSqlDbms

Azure Database for PostgreSQL server.

ParameterDescriptionExample / possible valuesRequired
azureRegionstring parameter(empty string)No
storageAutoGrowstring parameterEnabledNo
highAvailabilityModestring parameterDisabledNo
replicationRolestring parameterPrimaryNo
versionstring parameter18No
isPrivateboolean parameterTrueNo
firewallRuleslist parameter[]No
rootUserstring parameterfractalNo
skuNamestring parameterStandard_D4ds_v5No
storageGbinteger parameter128No
coordinatorStorageGbinteger parameter128No
workerStorageGbinteger parameter128No
backupRetentionDaysinteger parameter10No
coordinatorCoresinteger parameter2No
workersCoresinteger parameter4No
nodeCountinteger parameter0No
coordinatorServerEditionstring parameterGeneralPurposeNo
nodeServerEditionstring parameterMemoryOptimizedNo
subnetAddressCidrstring parameter10.1.1.0/27No

Example (fully parameterized):

{
"type": "Storage.PaaS.PostgreSqlDbms",
"parameters": {
"azureRegion": "",
"storageAutoGrow": "Enabled",
"highAvailabilityMode": "Disabled",
"replicationRole": "Primary",
"version": "18",
"isPrivate": true,
"firewallRules": [],
"rootUser": "fractal",
"skuName": "Standard_D4ds_v5",
"storageGb": 128,
"coordinatorStorageGb": 128,
"workerStorageGb": 128,
"backupRetentionDays": 10,
"coordinatorCores": 2,
"workersCores": 4,
"nodeCount": 0,
"coordinatorServerEdition": "GeneralPurpose",
"nodeServerEdition": "MemoryOptimized",
"subnetAddressCidr": "10.1.1.0/27"
}
}

Storage.PaaS.StorageAccount

Azure Storage Account for blobs, files, queues, and tables.

ParameterDescriptionExample / possible valuesRequired
kindstring parameterStorageV2No
azureRegionstring parameterwesteuropeNo
skustring parameterStandard_LRSNo
extendedLocationmap parameter{} (object)No
identitymap parameter{} (object)No
accessTierstring parameterHotNo
allowBlobPublicAccessboolean parameterFalseNo
allowCrossTenantReplicationboolean parameterFalseNo
allowSharedKeyAccessboolean parameterTrueNo
allowedCopyScopestring parameter(string value)No
azureFilesIdentityBasedAuthenticationmap parameter{} (object)No
customDomainmap parameter{} (object)No
defaultToOAuthAuthenticationboolean parameterFalseNo
dnsEndpointTypestring parameterStandardNo
encryptionmap parameter{} (object)No
immutableStorageWithVersioningmap parameter{} (object)No
isHnsEnabledboolean parametertrue or falseNo
isLocalUserEnabledboolean parametertrue or falseNo
isNfsV3Enabledboolean parametertrue or falseNo
isSftpEnabledboolean parametertrue or falseNo
keyPolicymap parameter{} (object)No
largeFileSharesStatestring parameter(string value)No
minimumTlsVersionstring parameterTLS1_2No
networkRuleSetmap parameter{} (object)No
publicNetworkAccessstring parameterEnabledNo
routingPreferencemap parameter{} (object)No
sasPolicymap parameter{} (object)No
supportsHttpsTrafficOnlyboolean parameterTrueNo
fileServicemap parameter{} (object)No
backupmap parameter{} (object)No

Example (fully parameterized):

{
"type": "Storage.PaaS.StorageAccount",
"parameters": {
"kind": "StorageV2",
"azureRegion": "westeurope",
"sku": "Standard_LRS",
"extendedLocation": {},
"identity": {},
"accessTier": "Hot",
"allowBlobPublicAccess": false,
"allowCrossTenantReplication": false,
"allowSharedKeyAccess": true,
"allowedCopyScope": "example-value",
"azureFilesIdentityBasedAuthentication": {},
"customDomain": {},
"defaultToOAuthAuthentication": false,
"dnsEndpointType": "Standard",
"encryption": {},
"immutableStorageWithVersioning": {},
"isHnsEnabled": true,
"isLocalUserEnabled": true,
"isNfsV3Enabled": true,
"isSftpEnabled": true,
"keyPolicy": {},
"largeFileSharesState": "example-value",
"minimumTlsVersion": "TLS1_2",
"networkRuleSet": {},
"publicNetworkAccess": "Enabled",
"routingPreference": {},
"sasPolicy": {},
"supportsHttpsTrafficOnly": true,
"fileService": {},
"backup": {}
}
}

Storage.PaaS.StorageBlobContainer

Blob container within Azure Storage Account.

ParameterDescriptionExample / possible valuesRequired
defaultEncryptionScopestring parameter$account-encryption-keyNo
denyEncryptionScopeOverrideboolean parameterFalseNo
enableNfsV3AllSquashboolean parametertrue or falseNo
enableNfsV3RootSquashboolean parametertrue or falseNo
immutableStorageWithVersioningmap parameter{} (object)No
metadatamap parameter{} (object)No
publicAccessstring parameterNoneNo

Example (fully parameterized):

{
"type": "Storage.PaaS.StorageBlobContainer",
"parameters": {
"defaultEncryptionScope": "$account-encryption-key",
"denyEncryptionScopeOverride": false,
"enableNfsV3AllSquash": true,
"enableNfsV3RootSquash": true,
"immutableStorageWithVersioning": {},
"metadata": {},
"publicAccess": "None"
}
}

Storage.SaaS.Unmanaged

External storage service with custom configuration supplied via secret.

ParameterDescriptionExample / possible valuesRequired
secretNamestring parameter(empty string)No
secretValuestring parameter(string value)Yes

Example (fully parameterized):

{
"type": "Storage.SaaS.Unmanaged",
"parameters": {
"secretName": "",
"secretValue": "example-value"
}
}