From 97744ff8dfe8ea8f78cc32e595b6681284b182a2 Mon Sep 17 00:00:00 2001 From: "radius-docs[bot]" <291938785+radius-docs[bot]@users.noreply.github.com> Date: Thu, 2 Jul 2026 13:38:56 +0000 Subject: [PATCH 1/2] docs: synced local 'docs/content/reference/resources/' with remote 'docs/docs/content/reference/resources/' Signed-off-by: radius-docs[bot] <291938785+radius-docs[bot]@users.noreply.github.com> --- .../2023-10-01-preview/applications/index.md | 48 +++---- .../2023-10-01-preview/containers/index.md | 120 +++++++++--------- .../2023-10-01-preview/environments/index.md | 102 +++++++-------- .../2023-10-01-preview/extenders/index.md | 46 +++---- .../2023-10-01-preview/gateways/index.md | 32 ++--- .../2023-10-01-preview/secretstores/index.md | 34 ++--- .../2023-10-01-preview/volumes/index.md | 42 +++--- .../configurationstores/index.md | 40 +++--- .../2023-10-01-preview/pubsubbrokers/index.md | 40 +++--- .../2023-10-01-preview/secretstores/index.md | 38 +++--- .../2023-10-01-preview/statestores/index.md | 40 +++--- .../mongodatabases/index.md | 42 +++--- .../2023-10-01-preview/rediscaches/index.md | 42 +++--- .../2023-10-01-preview/sqldatabases/index.md | 42 +++--- .../rabbitmqqueues/index.md | 42 +++--- .../2025-08-01-preview/applications/index.md | 26 ++-- .../2025-08-01-preview/bicepconfigs/index.md | 24 ++-- .../2025-08-01-preview/environments/index.md | 36 +++--- .../2025-08-01-preview/recipepacks/index.md | 39 ++++-- .../terraformconfigs/index.md | 34 ++--- 20 files changed, 460 insertions(+), 449 deletions(-) diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md index bbeba8df0..e67c6f168 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/applications/index.md @@ -21,11 +21,11 @@ description: "Detailed reference documentation for applications.core/application | **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** | [ApplicationProperties](#applicationproperties) | Application properties
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **properties** | [ApplicationProperties](#applicationproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Applications.Core/applications' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### Extension @@ -43,7 +43,7 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for Extension.
_(Required)_ | +| **kind** | 'aci' | The kind of the resource.
_(Required)_ | | **resourceGroup** | string | The resource group of the application environment.
_(Required)_ | #### DaprSidecarExtension @@ -53,10 +53,10 @@ description: "Detailed reference documentation for applications.core/application | 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. | +| **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' | The Dapr sidecar extension protocol | +| **kind** | 'daprSidecar' | Specifies the extension of the resource
_(Required)_ | +| **protocol** | 'grpc' | 'http' | Specifies the Dapr app-protocol to use for the resource. | #### KubernetesMetadataExtension @@ -64,9 +64,9 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **annotations** | [KubernetesMetadataExtensionAnnotations](#kubernetesmetadataextensionannotations) | Annotations to be applied to the Kubernetes resources output by the resource | -| **kind** | 'kubernetesMetadata' | Discriminator property for Extension.
_(Required)_ | -| **labels** | [KubernetesMetadataExtensionLabels](#kubernetesmetadataextensionlabels) | Labels to be applied to the Kubernetes resources output by the resource | +| **annotations** | [Record](#record) | Annotations to be applied to the Kubernetes resources output by the resource | +| **kind** | 'kubernetesMetadata' | The kind of the resource.
_(Required)_ | +| **labels** | [Record](#record) | Labels to be applied to the Kubernetes resources output by the resource | #### KubernetesNamespaceExtension @@ -74,7 +74,7 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetesNamespace' | Discriminator property for Extension.
_(Required)_ | +| **kind** | 'kubernetesNamespace' | The kind of the resource.
_(Required)_ | | **namespace** | string | The namespace of the application environment.
_(Required)_ | #### ManualScalingExtension @@ -83,11 +83,11 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **kind** | 'manualScaling' | Discriminator property for Extension.
_(Required)_ | +| **kind** | 'manualScaling' | Specifies the extension of the resource
_(Required)_ | | **replicas** | int | Replica count.
_(Required)_ | -### KubernetesMetadataExtensionAnnotations +### Record #### Properties @@ -97,7 +97,7 @@ description: "Detailed reference documentation for applications.core/application * **Additional Properties Type**: string -### KubernetesMetadataExtensionLabels +### Record #### Properties @@ -115,7 +115,7 @@ description: "Detailed reference documentation for applications.core/application |----------|------|-------------| | **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(Required)_ | | **extensions** | [Extension](#extension)[] | The application extension. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | ### ResourceStatus @@ -124,9 +124,9 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -136,7 +136,7 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -145,7 +145,7 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -154,7 +154,7 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -164,7 +164,7 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -200,9 +200,9 @@ description: "Detailed reference documentation for applications.core/application | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md index cfca9759b..4785a1ef5 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/containers/index.md @@ -17,26 +17,26 @@ description: "Detailed reference documentation for applications.core/containers@ |----------|------|-------------| | **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | | **application** | string | Fully qualified resource ID for the application
_(ReadOnly)_ | -| **connections** | [ContainerPropertiesConnections](#containerpropertiesconnections) | Specifies a connection to another resource.
_(ReadOnly)_ | -| **container** | [Container](#container) | Definition of a container
_(ReadOnly)_ | +| **connections** | [Record](#record) | Specifies a connection to another resource.
_(ReadOnly)_ | +| **container** | [Container](#container) | Definition of a container.
_(ReadOnly)_ | | **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(ReadOnly)_ | | **extensions** | [Extension](#extension)[] | Extensions spec of the resource
_(ReadOnly)_ | | **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting.
_(ReadOnly)_ | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers
_(ReadOnly)_ | | **location** | string | The geo-location where the resource lives | | **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [ContainerProperties](#containerproperties) | Container properties
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **resourceProvisioning** | 'internal' | 'manual' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'internal', where Radius manages the lifecycle of the resource internally, and 'manual', where a user manages the resource.
_(ReadOnly)_ | +| **properties** | [ContainerProperties](#containerproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **resourceProvisioning** | 'internal' | 'manual' | Specifies how the underlying container resource is provisioned and managed.
_(ReadOnly)_ | | **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the container
_(ReadOnly)_ | -| **restartPolicy** | 'Always' | 'Never' | 'OnFailure' | Restart policy for the container
_(ReadOnly)_ | -| **runtimes** | [RuntimesProperties](#runtimesproperties) | The properties for runtime configuration
_(ReadOnly)_ | +| **restartPolicy** | 'Always' | 'Never' | 'OnFailure' | The restart policy for the underlying container
_(ReadOnly)_ | +| **runtimes** | [RuntimesProperties](#runtimesproperties) | Specifies Runtime-specific functionality
_(ReadOnly)_ | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Applications.Core/containers' | The resource type
_(ReadOnly, DeployTimeConstant)_ | -### ContainerPropertiesConnections +### Record #### Properties @@ -53,7 +53,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| | **disableDefaultEnvVars** | bool | default environment variable override | -| **iam** | [IamProperties](#iamproperties) | IAM properties | +| **iam** | [IamProperties](#iamproperties) | iam properties | | **source** | string | The source of the connection
_(Required)_ | ### IamProperties @@ -73,16 +73,16 @@ description: "Detailed reference documentation for applications.core/containers@ |----------|------|-------------| | **args** | string[] | Arguments to the entrypoint. Overrides the container image's CMD | | **command** | string[] | Entrypoint array. Overrides the container image's ENTRYPOINT | -| **env** | [ContainerEnv](#containerenv) | environment | +| **env** | [Record](#record) | environment | | **image** | string | The registry and image to download and run in your container
_(Required)_ | -| **imagePullPolicy** | 'Always' | 'IfNotPresent' | 'Never' | The image pull policy for the container | -| **livenessProbe** | [HealthProbeProperties](#healthprobeproperties) | Properties for readiness/liveness probe | -| **ports** | [ContainerPorts](#containerports) | container ports | -| **readinessProbe** | [HealthProbeProperties](#healthprobeproperties) | Properties for readiness/liveness probe | -| **volumes** | [ContainerVolumes](#containervolumes) | container volumes | +| **imagePullPolicy** | 'Always' | 'IfNotPresent' | 'Never' | The pull policy for the container image | +| **livenessProbe** | [HealthProbeProperties](#healthprobeproperties) | liveness probe properties | +| **ports** | [Record](#record) | container ports | +| **readinessProbe** | [HealthProbeProperties](#healthprobeproperties) | readiness probe properties | +| **volumes** | [Record](#record) | container volumes | | **workingDir** | string | Working directory for the container | -### ContainerEnv +### Record #### Properties @@ -107,7 +107,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **secretRef** | [SecretReference](#secretreference) | This secret is used within a recipe. Secrets are encrypted, often have fine-grained access control, auditing and are recommended to be used to hold sensitive data.
_(Required)_ | +| **secretRef** | [SecretReference](#secretreference) | The secret reference
_(Required)_ | ### SecretReference @@ -138,7 +138,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| | **command** | string | Command to execute to probe readiness/liveness
_(Required)_ | -| **kind** | 'exec' | Discriminator property for HealthProbeProperties.
_(Required)_ | +| **kind** | 'exec' | The HealthProbeProperties kind
_(Required)_ | #### HttpGetHealthProbeProperties @@ -147,8 +147,8 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| | **containerPort** | int | The listening port number
_(Required)_ | -| **headers** | [HttpGetHealthProbePropertiesHeaders](#httpgethealthprobepropertiesheaders) | Custom HTTP headers to add to the get request | -| **kind** | 'httpGet' | Discriminator property for HealthProbeProperties.
_(Required)_ | +| **headers** | [Record](#record) | Custom HTTP headers to add to the get request | +| **kind** | 'httpGet' | The HealthProbeProperties kind
_(Required)_ | | **path** | string | The route to make the HTTP request on
_(Required)_ | #### TcpHealthProbeProperties @@ -158,10 +158,10 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| | **containerPort** | int | The listening port number
_(Required)_ | -| **kind** | 'tcp' | Discriminator property for HealthProbeProperties.
_(Required)_ | +| **kind** | 'tcp' | The HealthProbeProperties kind
_(Required)_ | -### HttpGetHealthProbePropertiesHeaders +### Record #### Properties @@ -171,7 +171,7 @@ description: "Detailed reference documentation for applications.core/containers@ * **Additional Properties Type**: string -### ContainerPorts +### Record #### Properties @@ -189,10 +189,10 @@ description: "Detailed reference documentation for applications.core/containers@ |----------|------|-------------| | **containerPort** | int | The listening port number
_(Required)_ | | **port** | int | Specifies the port that will be exposed by this container. Must be set when value different from containerPort is desired | -| **protocol** | 'TCP' | 'UDP' | The protocol in use by the port | +| **protocol** | 'TCP' | 'UDP' | Protocol in use by the port | | **scheme** | string | Specifies the URL scheme of the communication protocol. Consumers can use the scheme to construct a URL. The value defaults to 'http' or 'https' depending on the port value | -### ContainerVolumes +### Record #### Properties @@ -218,8 +218,8 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'ephemeral' | Discriminator property for Volume.
_(Required)_ | -| **managedStore** | 'disk' | 'memory' | The managed store for the ephemeral volume
_(Required)_ | +| **kind** | 'ephemeral' | The Volume kind
_(Required)_ | +| **managedStore** | 'disk' | 'memory' | Backing store for the ephemeral volume
_(Required)_ | #### PersistentVolume @@ -227,8 +227,8 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'persistent' | Discriminator property for Volume.
_(Required)_ | -| **permission** | 'read' | 'write' | The persistent volume permission | +| **kind** | 'persistent' | The Volume kind
_(Required)_ | +| **permission** | 'read' | 'write' | Container read/write access to the volume | | **source** | string | The source of the volume
_(Required)_ | @@ -247,7 +247,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for Extension.
_(Required)_ | +| **kind** | 'aci' | The kind of the resource.
_(Required)_ | | **resourceGroup** | string | The resource group of the application environment.
_(Required)_ | #### DaprSidecarExtension @@ -257,10 +257,10 @@ description: "Detailed reference documentation for applications.core/containers@ | 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. | +| **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' | The Dapr sidecar extension protocol | +| **kind** | 'daprSidecar' | Specifies the extension of the resource
_(Required)_ | +| **protocol** | 'grpc' | 'http' | Specifies the Dapr app-protocol to use for the resource. | #### KubernetesMetadataExtension @@ -268,9 +268,9 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **annotations** | [KubernetesMetadataExtensionAnnotations](#kubernetesmetadataextensionannotations) | Annotations to be applied to the Kubernetes resources output by the resource | -| **kind** | 'kubernetesMetadata' | Discriminator property for Extension.
_(Required)_ | -| **labels** | [KubernetesMetadataExtensionLabels](#kubernetesmetadataextensionlabels) | Labels to be applied to the Kubernetes resources output by the resource | +| **annotations** | [Record](#record) | Annotations to be applied to the Kubernetes resources output by the resource | +| **kind** | 'kubernetesMetadata' | The kind of the resource.
_(Required)_ | +| **labels** | [Record](#record) | Labels to be applied to the Kubernetes resources output by the resource | #### KubernetesNamespaceExtension @@ -278,7 +278,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetesNamespace' | Discriminator property for Extension.
_(Required)_ | +| **kind** | 'kubernetesNamespace' | The kind of the resource.
_(Required)_ | | **namespace** | string | The namespace of the application environment.
_(Required)_ | #### ManualScalingExtension @@ -287,11 +287,11 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'manualScaling' | Discriminator property for Extension.
_(Required)_ | +| **kind** | 'manualScaling' | Specifies the extension of the resource
_(Required)_ | | **replicas** | int | Replica count.
_(Required)_ | -### KubernetesMetadataExtensionAnnotations +### Record #### Properties @@ -301,7 +301,7 @@ description: "Detailed reference documentation for applications.core/containers@ * **Additional Properties Type**: string -### KubernetesMetadataExtensionLabels +### Record #### Properties @@ -317,7 +317,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -329,19 +329,19 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| | **application** | string | Fully qualified resource ID for the application
_(Required)_ | -| **connections** | [ContainerPropertiesConnections](#containerpropertiesconnections) | Specifies a connection to another resource. | -| **container** | [Container](#container) | Definition of a container
_(Required)_ | +| **connections** | [Record](#record) | Specifies a connection to another resource. | +| **container** | [Container](#container) | Definition of a container.
_(Required)_ | | **environment** | string | Fully qualified resource ID for the environment that the application is linked to | | **extensions** | [Extension](#extension)[] | Extensions spec of the resource | -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **resourceProvisioning** | 'internal' | 'manual' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'internal', where Radius manages the lifecycle of the resource internally, and 'manual', where a user manages the resource. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **resourceProvisioning** | 'internal' | 'manual' | Specifies how the underlying container resource is provisioned and managed. | | **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the container | -| **restartPolicy** | 'Always' | 'Never' | 'OnFailure' | Restart policy for the container | -| **runtimes** | [RuntimesProperties](#runtimesproperties) | The properties for runtime configuration | +| **restartPolicy** | 'Always' | 'Never' | 'OnFailure' | The restart policy for the underlying container | +| **runtimes** | [RuntimesProperties](#runtimesproperties) | Specifies Runtime-specific functionality | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -### ContainerPropertiesConnections +### Record #### Properties @@ -365,7 +365,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **aci** | [ACIRuntimeProperties](#aciruntimeproperties) | The runtime configuration properties for Kubernetes | +| **aci** | [ACIRuntimeProperties](#aciruntimeproperties) | The runtime configuration properties for ACI | | **kubernetes** | [KubernetesRuntimeProperties](#kubernetesruntimeproperties) | The runtime configuration properties for Kubernetes | ### ACIRuntimeProperties @@ -401,9 +401,9 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -413,7 +413,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -422,7 +422,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -431,7 +431,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -466,9 +466,9 @@ description: "Detailed reference documentation for applications.core/containers@ | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md index 5b98d9c92..384f60c41 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/environments/index.md @@ -16,19 +16,19 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| | **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource
_(ReadOnly)_ | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource used by application environment.
_(ReadOnly)_ | | **extensions** | [Extension](#extension)[] | The environment extension.
_(ReadOnly)_ | | **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](#environmentproperties) | Environment properties
_(Required)_ | -| **providers** | [Providers](#providers) | The Cloud providers configuration.
_(ReadOnly)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **properties** | [EnvironmentProperties](#environmentproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **providers** | [Providers](#providers) | Cloud providers configuration for the environment.
_(ReadOnly)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **recipeConfig** | [RecipeConfigProperties](#recipeconfigproperties) | Configuration for Recipes. Defines how each type of Recipe should be configured and run.
_(ReadOnly)_ | -| **recipes** | [EnvironmentPropertiesRecipes](#environmentpropertiesrecipes) | Specifies Recipes linked to the Environment.
_(ReadOnly)_ | +| **recipes** | [Record](#record) | Specifies Recipes linked to the Environment.
_(ReadOnly)_ | | **simulated** | bool | Simulated environment.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Applications.Core/environments' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### EnvironmentCompute @@ -39,7 +39,7 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -48,7 +48,7 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -57,7 +57,7 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -67,7 +67,7 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -87,7 +87,7 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for Extension.
_(Required)_ | +| **kind** | 'aci' | The kind of the resource.
_(Required)_ | | **resourceGroup** | string | The resource group of the application environment.
_(Required)_ | #### DaprSidecarExtension @@ -97,10 +97,10 @@ description: "Detailed reference documentation for applications.core/environment | 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. | +| **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' | The Dapr sidecar extension protocol | +| **kind** | 'daprSidecar' | Specifies the extension of the resource
_(Required)_ | +| **protocol** | 'grpc' | 'http' | Specifies the Dapr app-protocol to use for the resource. | #### KubernetesMetadataExtension @@ -108,9 +108,9 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **annotations** | [KubernetesMetadataExtensionAnnotations](#kubernetesmetadataextensionannotations) | Annotations to be applied to the Kubernetes resources output by the resource | -| **kind** | 'kubernetesMetadata' | Discriminator property for Extension.
_(Required)_ | -| **labels** | [KubernetesMetadataExtensionLabels](#kubernetesmetadataextensionlabels) | Labels to be applied to the Kubernetes resources output by the resource | +| **annotations** | [Record](#record) | Annotations to be applied to the Kubernetes resources output by the resource | +| **kind** | 'kubernetesMetadata' | The kind of the resource.
_(Required)_ | +| **labels** | [Record](#record) | Labels to be applied to the Kubernetes resources output by the resource | #### KubernetesNamespaceExtension @@ -118,7 +118,7 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetesNamespace' | Discriminator property for Extension.
_(Required)_ | +| **kind** | 'kubernetesNamespace' | The kind of the resource.
_(Required)_ | | **namespace** | string | The namespace of the application environment.
_(Required)_ | #### ManualScalingExtension @@ -127,11 +127,11 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **kind** | 'manualScaling' | Discriminator property for Extension.
_(Required)_ | +| **kind** | 'manualScaling' | Specifies the extension of the resource
_(Required)_ | | **replicas** | int | Replica count.
_(Required)_ | -### KubernetesMetadataExtensionAnnotations +### Record #### Properties @@ -141,7 +141,7 @@ description: "Detailed reference documentation for applications.core/environment * **Additional Properties Type**: string -### KubernetesMetadataExtensionLabels +### Record #### Properties @@ -157,12 +157,12 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource
_(Required)_ | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource used by application environment.
_(Required)_ | | **extensions** | [Extension](#extension)[] | The environment extension. | -| **providers** | [Providers](#providers) | The Cloud providers configuration. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **providers** | [Providers](#providers) | Cloud providers configuration for the environment. | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **recipeConfig** | [RecipeConfigProperties](#recipeconfigproperties) | Configuration for Recipes. Defines how each type of Recipe should be configured and run. | -| **recipes** | [EnvironmentPropertiesRecipes](#environmentpropertiesrecipes) | Specifies Recipes linked to the Environment. | +| **recipes** | [Record](#record) | Specifies Recipes linked to the Environment. | | **simulated** | bool | Simulated environment. | ### Providers @@ -171,8 +171,8 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **aws** | [ProvidersAws](#providersaws) | The AWS cloud provider definition. | -| **azure** | [ProvidersAzure](#providersazure) | The Azure cloud provider definition. | +| **aws** | [ProvidersAws](#providersaws) | The AWS cloud provider configuration. | +| **azure** | [ProvidersAzure](#providersazure) | The Azure cloud provider configuration. | ### ProvidersAws @@ -197,8 +197,8 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| | **bicep** | [BicepConfigProperties](#bicepconfigproperties) | Configuration for Bicep Recipes. Controls how Bicep plans and applies templates as part of Recipe deployment. | -| **env** | [EnvironmentVariables](#environmentvariables) | The environment variables injected during Terraform Recipe execution for the recipes in the environment. | -| **envSecrets** | [RecipeConfigPropertiesEnvSecrets](#recipeconfigpropertiesenvsecrets) | Environment variables containing sensitive information can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource. | +| **env** | [EnvironmentVariables](#environmentvariables) | Environment variables injected during recipe execution for the recipes in the environment, currently supported for Terraform recipes. | +| **envSecrets** | [Record](#record) | Environment variables containing sensitive information can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource. | | **terraform** | [TerraformConfigProperties](#terraformconfigproperties) | Configuration for Terraform Recipes. Controls how Terraform plans and applies templates as part of Recipe deployment. | ### BicepConfigProperties @@ -207,9 +207,9 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **authentication** | [BicepConfigPropertiesAuthentication](#bicepconfigpropertiesauthentication) | Authentication information used to access private bicep registries, which is a map of registry hostname to secret config that contains credential information. | +| **authentication** | [Record](#record) | Authentication information used to access private bicep registries, which is a map of registry hostname to secret config that contains credential information. | -### BicepConfigPropertiesAuthentication +### Record #### Properties @@ -237,7 +237,7 @@ description: "Detailed reference documentation for applications.core/environment * **Additional Properties Type**: string -### RecipeConfigPropertiesEnvSecrets +### Record #### Properties @@ -263,7 +263,7 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| | **authentication** | [AuthConfig](#authconfig) | Authentication information used to access private Terraform module sources. Supported module sources: Git. | -| **providers** | [TerraformConfigPropertiesProviders](#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. | +| **providers** | [Record](#record) | 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 @@ -279,9 +279,9 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **pat** | [GitAuthConfigPat](#gitauthconfigpat) | Personal Access Token (PAT) configuration used to authenticate to Git platforms. | +| **pat** | [Record](#record) | Personal Access Token (PAT) configuration used to authenticate to Git platforms. | -### GitAuthConfigPat +### Record #### Properties @@ -299,7 +299,7 @@ description: "Detailed reference documentation for applications.core/environment |----------|------|-------------| | **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 +### Record #### Properties @@ -315,12 +315,12 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **secrets** | [ProviderConfigPropertiesSecrets](#providerconfigpropertiessecrets) | Sensitive data in provider configuration can be stored as secrets. The secrets are stored in Applications.Core/SecretStores resource. | +| **secrets** | [Record](#record) | 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 +### Record #### Properties @@ -330,7 +330,7 @@ description: "Detailed reference documentation for applications.core/environment * **Additional Properties Type**: [SecretReference](#secretreference) -### EnvironmentPropertiesRecipes +### Record #### Properties @@ -338,9 +338,9 @@ description: "Detailed reference documentation for applications.core/environment #### Additional Properties -* **Additional Properties Type**: [DictionaryOfRecipeProperties](#dictionaryofrecipeproperties) +* **Additional Properties Type**: [Record](#record) -### DictionaryOfRecipeProperties +### Record #### Properties @@ -358,7 +358,7 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **parameters** | [RecipePropertiesParameters](#recipepropertiesparameters) | Key/value parameters to pass to the recipe template at deployment. | +| **parameters** | [Record](#record) | Key/value parameters to pass to the recipe template at deployment. | | **templatePath** | string | Path to the template provided by the recipe. Currently only link to Azure Container Registry is supported.
_(Required)_ | #### BicepRecipeProperties @@ -368,7 +368,7 @@ description: "Detailed reference documentation for applications.core/environment | 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)_ | +| **templateKind** | 'bicep' | The Bicep template kind.
_(Required)_ | #### TerraformRecipeProperties @@ -376,11 +376,11 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **templateKind** | 'terraform' | Discriminator property for RecipeProperties.
_(Required)_ | +| **templateKind** | 'terraform' | The Terraform template kind.
_(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. | -### RecipePropertiesParameters +### Record #### Properties @@ -390,7 +390,7 @@ description: "Detailed reference documentation for applications.core/environment * **Additional Properties Type**: any -### EnvironmentPropertiesRecipes +### Record #### Properties @@ -398,9 +398,9 @@ description: "Detailed reference documentation for applications.core/environment #### Additional Properties -* **Additional Properties Type**: [DictionaryOfRecipeProperties](#dictionaryofrecipeproperties) +* **Additional Properties Type**: [Record](#record) -### DictionaryOfRecipeProperties +### Record #### Properties @@ -421,9 +421,9 @@ description: "Detailed reference documentation for applications.core/environment | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md index 1766b07a3..d3e23d39a 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/extenders/index.md @@ -21,14 +21,14 @@ description: "Detailed reference documentation for applications.core/extenders@2 | **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** | [ExtenderProperties](#extenderproperties) | ExtenderResource portable resource properties
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values.
_(ReadOnly)_ | -| **secrets** | [ExtenderPropertiesSecrets](#extenderpropertiessecrets) | The secrets for referenced resource
_(ReadOnly)_ | +| **properties** | [ExtenderProperties](#extenderproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the extender portable resource
_(ReadOnly)_ | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | +| **secrets** | [Record](#record) | The secrets for referenced resource
_(ReadOnly)_ | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Applications.Core/extenders' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### ExtenderProperties @@ -39,10 +39,10 @@ description: "Detailed reference documentation for applications.core/extenders@2 |----------|------|-------------| | **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | | **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | -| **secrets** | [ExtenderPropertiesSecrets](#extenderpropertiessecrets) | The secrets for referenced resource | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the extender portable resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | +| **secrets** | [Record](#record) | The secrets for referenced resource | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | #### Additional Properties @@ -55,9 +55,9 @@ description: "Detailed reference documentation for applications.core/extenders@2 | Property | Type | Description | |----------|------|-------------| | **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [RecipeParameters](#recipeparameters) | Key/value parameters to pass into the recipe at deployment | +| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | -### RecipeParameters +### Record #### Properties @@ -67,7 +67,7 @@ description: "Detailed reference documentation for applications.core/extenders@2 * **Additional Properties Type**: any -### ExtenderPropertiesSecrets +### Record #### Properties @@ -83,9 +83,9 @@ description: "Detailed reference documentation for applications.core/extenders@2 | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -95,7 +95,7 @@ description: "Detailed reference documentation for applications.core/extenders@2 | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -104,7 +104,7 @@ description: "Detailed reference documentation for applications.core/extenders@2 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -113,7 +113,7 @@ description: "Detailed reference documentation for applications.core/extenders@2 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -123,7 +123,7 @@ description: "Detailed reference documentation for applications.core/extenders@2 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -148,7 +148,7 @@ description: "Detailed reference documentation for applications.core/extenders@2 | **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | | **templateVersion** | string | TemplateVersion is the version number of the template. | -### ExtenderPropertiesSecrets +### Record #### Properties @@ -169,9 +169,9 @@ description: "Detailed reference documentation for applications.core/extenders@2 | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md index 03e589e1b..1bc233411 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/gateways/index.md @@ -23,13 +23,13 @@ description: "Detailed reference documentation for applications.core/gateways@20 | **internal** | bool | Sets Gateway to not be exposed externally (no public IP address associated). Defaults to false (exposed to internet).
_(ReadOnly)_ | | **location** | string | The geo-location where the resource lives | | **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | -| **properties** | [GatewayProperties](#gatewayproperties) | Gateway properties
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **properties** | [GatewayProperties](#gatewayproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **routes** | [GatewayRoute](#gatewayroute)[] | Routes attached to this Gateway
_(ReadOnly)_ | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **tls** | [GatewayTls](#gatewaytls) | TLS configuration definition for Gateway resource.
_(ReadOnly)_ | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | +| **tls** | [GatewayTls](#gatewaytls) | TLS configuration for the Gateway.
_(ReadOnly)_ | | **type** | 'Applications.Core/gateways' | The resource type
_(ReadOnly, DeployTimeConstant)_ | | **url** | string | URL of the gateway resource. Readonly
_(ReadOnly)_ | @@ -52,10 +52,10 @@ description: "Detailed reference documentation for applications.core/gateways@20 | **environment** | string | Fully qualified resource ID for the environment that the application is linked to | | **hostname** | [GatewayHostname](#gatewayhostname) | Declare hostname information for the Gateway. Leaving the hostname empty auto-assigns one: mygateway.myapp.PUBLICHOSTNAMEORIP.nip.io. | | **internal** | bool | Sets Gateway to not be exposed externally (no public IP address associated). Defaults to false (exposed to internet). | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **routes** | [GatewayRoute](#gatewayroute)[] | Routes attached to this Gateway
_(Required)_ | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **tls** | [GatewayTls](#gatewaytls) | TLS configuration definition for Gateway resource. | +| **tls** | [GatewayTls](#gatewaytls) | TLS configuration for the Gateway. | | **url** | string | URL of the gateway resource. Readonly
_(ReadOnly)_ | ### GatewayRoute @@ -68,7 +68,7 @@ description: "Detailed reference documentation for applications.core/gateways@20 | **enableWebsockets** | bool | Enables websocket support for the route. Defaults to false. | | **path** | string | The path to match the incoming request path on. Ex - /myservice. | | **replacePrefix** | string | Optionally update the prefix when sending the request to the service. Ex - replacePrefix: '/' and path: '/myservice' will transform '/myservice/myroute' to '/myroute' | -| **timeoutPolicy** | [GatewayRouteTimeoutPolicy](#gatewayroutetimeoutpolicy) | Gateway route timeout policy | +| **timeoutPolicy** | [GatewayRouteTimeoutPolicy](#gatewayroutetimeoutpolicy) | The timeout policy for the route. | ### GatewayRouteTimeoutPolicy @@ -85,9 +85,9 @@ description: "Detailed reference documentation for applications.core/gateways@20 | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -97,7 +97,7 @@ description: "Detailed reference documentation for applications.core/gateways@20 | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -106,7 +106,7 @@ description: "Detailed reference documentation for applications.core/gateways@20 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -115,7 +115,7 @@ description: "Detailed reference documentation for applications.core/gateways@20 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -125,7 +125,7 @@ description: "Detailed reference documentation for applications.core/gateways@20 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -171,9 +171,9 @@ description: "Detailed reference documentation for applications.core/gateways@20 | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md index bfbb29f56..f58038865 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/secretstores/index.md @@ -19,9 +19,9 @@ description: "Detailed reference documentation for applications.core/secretstore | **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** | [SecretStoreProperties](#secretstoreproperties) | The properties of SecretStore
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **properties** | [SecretStoreProperties](#secretstoreproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Applications.Core/secretStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### SecretStoreProperties @@ -31,14 +31,14 @@ description: "Detailed reference documentation for applications.core/secretstore | Property | Type | Description | |----------|------|-------------| | **application** | string | Fully qualified resource ID for the application | -| **data** | [SecretStorePropertiesData](#secretstorepropertiesdata) | An object to represent key-value type secrets
_(Required)_ | +| **data** | [Record](#record) | An object to represent key-value type secrets
_(Required)_ | | **environment** | string | Fully qualified resource ID for the environment that the application is linked to | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **resource** | string | The resource id of external secret store. | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **type** | 'awsIRSA' | 'azureWorkloadIdentity' | 'basicAuthentication' | 'certificate' | 'generic' | The type of SecretStore data | +| **type** | 'awsIRSA' | 'azureWorkloadIdentity' | 'basicAuthentication' | 'certificate' | 'generic' | The type of secret store data | -### SecretStorePropertiesData +### Record #### Properties @@ -54,9 +54,9 @@ description: "Detailed reference documentation for applications.core/secretstore | Property | Type | Description | |----------|------|-------------| -| **encoding** | 'base64' | 'raw' | The type of SecretValue Encoding | +| **encoding** | 'base64' | 'raw' | The encoding of value | | **value** | string | The value of secret. | -| **valueFrom** | [ValueFromProperties](#valuefromproperties) | The Secret value source properties | +| **valueFrom** | [ValueFromProperties](#valuefromproperties) | The referenced secret in properties.resource | ### ValueFromProperties @@ -73,9 +73,9 @@ description: "Detailed reference documentation for applications.core/secretstore | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -85,7 +85,7 @@ description: "Detailed reference documentation for applications.core/secretstore | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -94,7 +94,7 @@ description: "Detailed reference documentation for applications.core/secretstore | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -103,7 +103,7 @@ description: "Detailed reference documentation for applications.core/secretstore | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -113,7 +113,7 @@ description: "Detailed reference documentation for applications.core/secretstore | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -149,9 +149,9 @@ description: "Detailed reference documentation for applications.core/secretstore | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md index 5c8f68fb2..15a9744e9 100644 --- a/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md +++ b/docs/content/reference/resources/applications/applications.core/2023-10-01-preview/volumes/index.md @@ -19,9 +19,9 @@ description: "Detailed reference documentation for applications.core/volumes@202 | **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** | [VolumeProperties](#volumeproperties) | Volume properties
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **properties** | [VolumeProperties](#volumeproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Applications.Core/volumes' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### VolumeProperties @@ -34,7 +34,7 @@ description: "Detailed reference documentation for applications.core/volumes@202 |----------|------|-------------| | **application** | string | Fully qualified resource ID for the application
_(Required)_ | | **environment** | string | Fully qualified resource ID for the environment that the application is linked to | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | #### AzureKeyVaultVolumeProperties @@ -43,11 +43,11 @@ description: "Detailed reference documentation for applications.core/volumes@202 | Property | Type | Description | |----------|------|-------------| -| **certificates** | [AzureKeyVaultVolumePropertiesCertificates](#azurekeyvaultvolumepropertiescertificates) | The KeyVault certificates that this volume exposes | -| **keys** | [AzureKeyVaultVolumePropertiesKeys](#azurekeyvaultvolumepropertieskeys) | The KeyVault keys that this volume exposes | -| **kind** | 'azure.com.keyvault' | Discriminator property for VolumeProperties.
_(Required)_ | +| **certificates** | [Record](#record) | The KeyVault certificates that this volume exposes | +| **keys** | [Record](#record) | The KeyVault keys that this volume exposes | +| **kind** | 'azure.com.keyvault' | The Azure Key Vault Volume kind
_(Required)_ | | **resource** | string | The ID of the keyvault to use for this volume resource
_(Required)_ | -| **secrets** | [AzureKeyVaultVolumePropertiesSecrets](#azurekeyvaultvolumepropertiessecrets) | The KeyVault secrets that this volume exposes | +| **secrets** | [Record](#record) | The KeyVault secrets that this volume exposes | ### ResourceStatus @@ -56,9 +56,9 @@ description: "Detailed reference documentation for applications.core/volumes@202 | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -68,7 +68,7 @@ description: "Detailed reference documentation for applications.core/volumes@202 | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -77,7 +77,7 @@ description: "Detailed reference documentation for applications.core/volumes@202 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -86,7 +86,7 @@ description: "Detailed reference documentation for applications.core/volumes@202 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -96,7 +96,7 @@ description: "Detailed reference documentation for applications.core/volumes@202 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -121,7 +121,7 @@ description: "Detailed reference documentation for applications.core/volumes@202 | **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(Required)_ | | **templateVersion** | string | TemplateVersion is the version number of the template. | -### AzureKeyVaultVolumePropertiesCertificates +### Record #### Properties @@ -138,13 +138,13 @@ description: "Detailed reference documentation for applications.core/volumes@202 | Property | Type | Description | |----------|------|-------------| | **alias** | string | File name when written to disk | -| **certType** | 'certificate' | 'privatekey' | 'publickey' | Represents certificate types | +| **certType** | 'certificate' | 'privatekey' | 'publickey' | Certificate object type to be downloaded - the certificate itself, private key or public key of the certificate | | **encoding** | 'base64' | 'hex' | 'utf-8' | Encoding format. Default utf-8 | -| **format** | 'pem' | 'pfx' | Represents certificate formats | +| **format** | 'pem' | 'pfx' | Certificate format. Default pem | | **name** | string | The name of the certificate
_(Required)_ | | **version** | string | Certificate version | -### AzureKeyVaultVolumePropertiesKeys +### Record #### Properties @@ -164,7 +164,7 @@ description: "Detailed reference documentation for applications.core/volumes@202 | **name** | string | The name of the key
_(Required)_ | | **version** | string | Key version | -### AzureKeyVaultVolumePropertiesSecrets +### Record #### Properties @@ -196,9 +196,9 @@ description: "Detailed reference documentation for applications.core/volumes@202 | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/configurationstores/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/configurationstores/index.md index f3065e71c..64215d401 100644 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/configurationstores/index.md +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/configurationstores/index.md @@ -19,9 +19,9 @@ description: "Detailed reference documentation for applications.dapr/configurati | **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** | [DaprConfigurationStoreProperties](#daprconfigurationstoreproperties) | Dapr configuration store portable resource properties
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **properties** | [DaprConfigurationStoreProperties](#daprconfigurationstoreproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Applications.Dapr/configurationStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### DaprConfigurationStoreProperties @@ -31,13 +31,13 @@ description: "Detailed reference documentation for applications.dapr/configurati | Property | Type | Description | |----------|------|-------------| | **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **auth** | [DaprResourceAuth](#daprresourceauth) | Authentication properties for a Dapr component object | +| **auth** | [DaprResourceAuth](#daprresourceauth) | The name of the Dapr component to be used as a secret store | | **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(ReadOnly)_ | | **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **metadata** | [DaprConfigurationStorePropertiesMetadata](#daprconfigurationstorepropertiesmetadata) | The metadata for Dapr resource which must match the values specified in Dapr component spec | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **metadata** | [Record](#record) | The metadata for Dapr resource which must match the values specified in Dapr component spec | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | | **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the configuration store | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | | **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | @@ -51,7 +51,7 @@ description: "Detailed reference documentation for applications.dapr/configurati |----------|------|-------------| | **secretStore** | string | Secret store to fetch secrets from | -### DaprConfigurationStorePropertiesMetadata +### Record #### Properties @@ -67,7 +67,7 @@ description: "Detailed reference documentation for applications.dapr/configurati | Property | Type | Description | |----------|------|-------------| -| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component. | +| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component | | **value** | string | The plain text value of the metadata | ### MetadataValueFromSecret @@ -86,9 +86,9 @@ description: "Detailed reference documentation for applications.dapr/configurati | Property | Type | Description | |----------|------|-------------| | **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [RecipeParameters](#recipeparameters) | Key/value parameters to pass into the recipe at deployment | +| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | -### RecipeParameters +### Record #### Properties @@ -112,9 +112,9 @@ description: "Detailed reference documentation for applications.dapr/configurati | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -124,7 +124,7 @@ description: "Detailed reference documentation for applications.dapr/configurati | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -133,7 +133,7 @@ description: "Detailed reference documentation for applications.dapr/configurati | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -142,7 +142,7 @@ description: "Detailed reference documentation for applications.dapr/configurati | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -152,7 +152,7 @@ description: "Detailed reference documentation for applications.dapr/configurati | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -188,9 +188,9 @@ description: "Detailed reference documentation for applications.dapr/configurati | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md index 58a77b4f1..309bbe037 100644 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/pubsubbrokers/index.md @@ -19,9 +19,9 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | **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** | [DaprPubSubBrokerProperties](#daprpubsubbrokerproperties) | Dapr PubSubBroker portable resource properties
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **properties** | [DaprPubSubBrokerProperties](#daprpubsubbrokerproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Applications.Dapr/pubSubBrokers' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### DaprPubSubBrokerProperties @@ -31,13 +31,13 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| | **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **auth** | [DaprResourceAuth](#daprresourceauth) | Authentication properties for a Dapr component object | +| **auth** | [DaprResourceAuth](#daprresourceauth) | The name of the Dapr component to be used as a secret store | | **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(ReadOnly)_ | | **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **metadata** | [DaprPubSubBrokerPropertiesMetadata](#daprpubsubbrokerpropertiesmetadata) | The metadata for Dapr resource which must match the values specified in Dapr component spec | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **metadata** | [Record](#record) | The metadata for Dapr resource which must match the values specified in Dapr component spec | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | | **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the pubSubBroker | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | | **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | @@ -51,7 +51,7 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke |----------|------|-------------| | **secretStore** | string | Secret store to fetch secrets from | -### DaprPubSubBrokerPropertiesMetadata +### Record #### Properties @@ -67,7 +67,7 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| -| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component. | +| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component | | **value** | string | The plain text value of the metadata | ### MetadataValueFromSecret @@ -86,9 +86,9 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| | **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [RecipeParameters](#recipeparameters) | Key/value parameters to pass into the recipe at deployment | +| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | -### RecipeParameters +### Record #### Properties @@ -112,9 +112,9 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -124,7 +124,7 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -133,7 +133,7 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -142,7 +142,7 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -152,7 +152,7 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -188,9 +188,9 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md index 9227138f8..0cfb61b65 100644 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/secretstores/index.md @@ -19,9 +19,9 @@ description: "Detailed reference documentation for applications.dapr/secretstore | **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** | [DaprSecretStoreProperties](#daprsecretstoreproperties) | Dapr SecretStore portable resource properties
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **properties** | [DaprSecretStoreProperties](#daprsecretstoreproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Applications.Dapr/secretStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### DaprSecretStoreProperties @@ -33,15 +33,15 @@ description: "Detailed reference documentation for applications.dapr/secretstore | **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | | **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(ReadOnly)_ | | **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **metadata** | [DaprSecretStorePropertiesMetadata](#daprsecretstorepropertiesmetadata) | The metadata for Dapr resource which must match the values specified in Dapr component spec | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **metadata** | [Record](#record) | The metadata for Dapr resource which must match the values specified in Dapr component spec | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | | **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | | **version** | string | Dapr component version | -### DaprSecretStorePropertiesMetadata +### Record #### Properties @@ -57,7 +57,7 @@ description: "Detailed reference documentation for applications.dapr/secretstore | Property | Type | Description | |----------|------|-------------| -| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component. | +| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component | | **value** | string | The plain text value of the metadata | ### MetadataValueFromSecret @@ -76,9 +76,9 @@ description: "Detailed reference documentation for applications.dapr/secretstore | Property | Type | Description | |----------|------|-------------| | **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [RecipeParameters](#recipeparameters) | Key/value parameters to pass into the recipe at deployment | +| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | -### RecipeParameters +### Record #### Properties @@ -94,9 +94,9 @@ description: "Detailed reference documentation for applications.dapr/secretstore | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -106,7 +106,7 @@ description: "Detailed reference documentation for applications.dapr/secretstore | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -115,7 +115,7 @@ description: "Detailed reference documentation for applications.dapr/secretstore | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -124,7 +124,7 @@ description: "Detailed reference documentation for applications.dapr/secretstore | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -134,7 +134,7 @@ description: "Detailed reference documentation for applications.dapr/secretstore | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -170,9 +170,9 @@ description: "Detailed reference documentation for applications.dapr/secretstore | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md index f007106d6..e5d0c5acd 100644 --- a/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md +++ b/docs/content/reference/resources/applications/applications.dapr/2023-10-01-preview/statestores/index.md @@ -19,9 +19,9 @@ description: "Detailed reference documentation for applications.dapr/statestores | **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** | [DaprStateStoreProperties](#daprstatestoreproperties) | Dapr StateStore portable resource properties
_(Required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **properties** | [DaprStateStoreProperties](#daprstatestoreproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Applications.Dapr/stateStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### DaprStateStoreProperties @@ -31,13 +31,13 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| | **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | -| **auth** | [DaprResourceAuth](#daprresourceauth) | Authentication properties for a Dapr component object | +| **auth** | [DaprResourceAuth](#daprresourceauth) | The name of the Dapr component to be used as a secret store | | **componentName** | string | The name of the Dapr component object. Use this value in your code when interacting with the Dapr client to use the Dapr component.
_(ReadOnly)_ | | **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | -| **metadata** | [DaprStateStorePropertiesMetadata](#daprstatestorepropertiesmetadata) | The metadata for Dapr resource which must match the values specified in Dapr component spec | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **metadata** | [Record](#record) | The metadata for Dapr resource which must match the values specified in Dapr component spec | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | | **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the state store | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | | **type** | string | Dapr component type which must matches the format used by Dapr Kubernetes configuration format | @@ -51,7 +51,7 @@ description: "Detailed reference documentation for applications.dapr/statestores |----------|------|-------------| | **secretStore** | string | Secret store to fetch secrets from | -### DaprStateStorePropertiesMetadata +### Record #### Properties @@ -67,7 +67,7 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| -| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component. | +| **secretKeyRef** | [MetadataValueFromSecret](#metadatavaluefromsecret) | A reference of a value in a secret store component | | **value** | string | The plain text value of the metadata | ### MetadataValueFromSecret @@ -86,9 +86,9 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| | **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [RecipeParameters](#recipeparameters) | Key/value parameters to pass into the recipe at deployment | +| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | -### RecipeParameters +### Record #### Properties @@ -112,9 +112,9 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -124,7 +124,7 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -133,7 +133,7 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -142,7 +142,7 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -152,7 +152,7 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -188,9 +188,9 @@ description: "Detailed reference documentation for applications.dapr/statestores | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md index 5dfad2704..006680c03 100644 --- a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md +++ b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/mongodatabases/index.md @@ -24,15 +24,15 @@ description: "Detailed reference documentation for applications.datastores/mongo | **location** | string | The geo-location where the resource lives | | **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | | **port** | int | Port value of the target Mongo database
_(ReadOnly)_ | -| **properties** | [MongoDatabaseProperties](#mongodatabaseproperties) | MongoDatabase portable resource properties
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values.
_(ReadOnly)_ | +| **properties** | [MongoDatabaseProperties](#mongodatabaseproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource
_(ReadOnly)_ | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | | **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the MongoDB resource
_(ReadOnly)_ | -| **secrets** | [MongoDatabaseSecrets](#mongodatabasesecrets) | The secret values for the given MongoDatabase resource
_(ReadOnly)_ | +| **secrets** | [MongoDatabaseSecrets](#mongodatabasesecrets) | Secret values provided for the resource
_(ReadOnly)_ | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Applications.Datastores/mongoDatabases' | The resource type
_(ReadOnly, DeployTimeConstant)_ | | **username** | string | Username to use when connecting to the target Mongo database
_(ReadOnly)_ | @@ -47,11 +47,11 @@ description: "Detailed reference documentation for applications.datastores/mongo | **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | | **host** | string | Host name of the target Mongo database | | **port** | int | Port value of the target Mongo database | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | | **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the MongoDB resource | -| **secrets** | [MongoDatabaseSecrets](#mongodatabasesecrets) | The secret values for the given MongoDatabase resource | +| **secrets** | [MongoDatabaseSecrets](#mongodatabasesecrets) | Secret values provided for the resource | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | | **username** | string | Username to use when connecting to the target Mongo database | @@ -62,9 +62,9 @@ description: "Detailed reference documentation for applications.datastores/mongo | Property | Type | Description | |----------|------|-------------| | **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [RecipeParameters](#recipeparameters) | Key/value parameters to pass into the recipe at deployment | +| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | -### RecipeParameters +### Record #### Properties @@ -97,9 +97,9 @@ description: "Detailed reference documentation for applications.datastores/mongo | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -109,7 +109,7 @@ description: "Detailed reference documentation for applications.datastores/mongo | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -118,7 +118,7 @@ description: "Detailed reference documentation for applications.datastores/mongo | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -127,7 +127,7 @@ description: "Detailed reference documentation for applications.datastores/mongo | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -137,7 +137,7 @@ description: "Detailed reference documentation for applications.datastores/mongo | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -173,9 +173,9 @@ description: "Detailed reference documentation for applications.datastores/mongo | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md index 2d60102f9..3cc824f1b 100644 --- a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md +++ b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/rediscaches/index.md @@ -23,15 +23,15 @@ description: "Detailed reference documentation for applications.datastores/redis | **location** | string | The geo-location where the resource lives | | **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | | **port** | int | The port value of the target Redis cache
_(ReadOnly)_ | -| **properties** | [RedisCacheProperties](#rediscacheproperties) | RedisCache portable resource properties
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values.
_(ReadOnly)_ | +| **properties** | [RedisCacheProperties](#rediscacheproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource
_(ReadOnly)_ | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | | **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the Redis resource
_(ReadOnly)_ | -| **secrets** | [RedisCacheSecrets](#rediscachesecrets) | The secret values for the given RedisCache resource
_(ReadOnly)_ | +| **secrets** | [RedisCacheSecrets](#rediscachesecrets) | Secrets provided by resource
_(ReadOnly)_ | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **tls** | bool | Specifies whether to enable SSL connections to the Redis cache
_(ReadOnly)_ | | **type** | 'Applications.Datastores/redisCaches' | The resource type
_(ReadOnly, DeployTimeConstant)_ | | **username** | string | The username for Redis cache
_(ReadOnly)_ | @@ -46,11 +46,11 @@ description: "Detailed reference documentation for applications.datastores/redis | **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | | **host** | string | The host name of the target Redis cache | | **port** | int | The port value of the target Redis cache | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | | **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the Redis resource | -| **secrets** | [RedisCacheSecrets](#rediscachesecrets) | The secret values for the given RedisCache resource | +| **secrets** | [RedisCacheSecrets](#rediscachesecrets) | Secrets provided by resource | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | | **tls** | bool | Specifies whether to enable SSL connections to the Redis cache | | **username** | string | The username for Redis cache | @@ -62,9 +62,9 @@ description: "Detailed reference documentation for applications.datastores/redis | Property | Type | Description | |----------|------|-------------| | **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [RecipeParameters](#recipeparameters) | Key/value parameters to pass into the recipe at deployment | +| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | -### RecipeParameters +### Record #### Properties @@ -98,9 +98,9 @@ description: "Detailed reference documentation for applications.datastores/redis | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -110,7 +110,7 @@ description: "Detailed reference documentation for applications.datastores/redis | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -119,7 +119,7 @@ description: "Detailed reference documentation for applications.datastores/redis | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -128,7 +128,7 @@ description: "Detailed reference documentation for applications.datastores/redis | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -138,7 +138,7 @@ description: "Detailed reference documentation for applications.datastores/redis | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -174,9 +174,9 @@ description: "Detailed reference documentation for applications.datastores/redis | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md index 33f66b59a..119939474 100644 --- a/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md +++ b/docs/content/reference/resources/applications/applications.datastores/2023-10-01-preview/sqldatabases/index.md @@ -23,16 +23,16 @@ description: "Detailed reference documentation for applications.datastores/sqlda | **location** | string | The geo-location where the resource lives | | **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | | **port** | int | Port value of the target Sql database
_(ReadOnly)_ | -| **properties** | [SqlDatabaseProperties](#sqldatabaseproperties) | SqlDatabase properties
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values.
_(ReadOnly)_ | +| **properties** | [SqlDatabaseProperties](#sqldatabaseproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource
_(ReadOnly)_ | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | | **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the SqlDatabase resource
_(ReadOnly)_ | -| **secrets** | [SqlDatabaseSecrets](#sqldatabasesecrets) | The secret values for the given SqlDatabase resource
_(ReadOnly)_ | +| **secrets** | [SqlDatabaseSecrets](#sqldatabasesecrets) | Secret values provided for the resource
_(ReadOnly)_ | | **server** | string | The fully qualified domain name of the Sql database.
_(ReadOnly)_ | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Applications.Datastores/sqlDatabases' | The resource type
_(ReadOnly, DeployTimeConstant)_ | | **username** | string | Username to use when connecting to the target Sql database
_(ReadOnly)_ | @@ -46,11 +46,11 @@ description: "Detailed reference documentation for applications.datastores/sqlda | **database** | string | The name of the Sql database. | | **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | | **port** | int | Port value of the target Sql database | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | | **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the SqlDatabase resource | -| **secrets** | [SqlDatabaseSecrets](#sqldatabasesecrets) | The secret values for the given SqlDatabase resource | +| **secrets** | [SqlDatabaseSecrets](#sqldatabasesecrets) | Secret values provided for the resource | | **server** | string | The fully qualified domain name of the Sql database. | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | | **username** | string | Username to use when connecting to the target Sql database | @@ -62,9 +62,9 @@ description: "Detailed reference documentation for applications.datastores/sqlda | Property | Type | Description | |----------|------|-------------| | **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [RecipeParameters](#recipeparameters) | Key/value parameters to pass into the recipe at deployment | +| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | -### RecipeParameters +### Record #### Properties @@ -97,9 +97,9 @@ description: "Detailed reference documentation for applications.datastores/sqlda | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -109,7 +109,7 @@ description: "Detailed reference documentation for applications.datastores/sqlda | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -118,7 +118,7 @@ description: "Detailed reference documentation for applications.datastores/sqlda | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -127,7 +127,7 @@ description: "Detailed reference documentation for applications.datastores/sqlda | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -137,7 +137,7 @@ description: "Detailed reference documentation for applications.datastores/sqlda | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -173,9 +173,9 @@ description: "Detailed reference documentation for applications.datastores/sqlda | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md b/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md index 4d0986cea..08a912ac3 100644 --- a/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md +++ b/docs/content/reference/resources/applications/applications.messaging/2023-10-01-preview/rabbitmqqueues/index.md @@ -23,16 +23,16 @@ description: "Detailed reference documentation for applications.messaging/rabbit | **location** | string | The geo-location where the resource lives | | **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | | **port** | int | The port of the RabbitMQ instance. Defaults to 5672
_(ReadOnly)_ | -| **properties** | [RabbitMQQueueProperties](#rabbitmqqueueproperties) | RabbitMQQueue portable resource properties
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **properties** | [RabbitMQQueueProperties](#rabbitmqqueueproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **queue** | string | The name of the queue
_(ReadOnly)_ | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource
_(ReadOnly)_ | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values.
_(ReadOnly)_ | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource
_(ReadOnly)_ | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed.
_(ReadOnly)_ | | **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the rabbitMQ resource
_(ReadOnly)_ | -| **secrets** | [RabbitMQSecrets](#rabbitmqsecrets) | The connection secrets properties to the RabbitMQ instance
_(ReadOnly)_ | +| **secrets** | [RabbitMQSecrets](#rabbitmqsecrets) | The secrets to connect to the RabbitMQ instance
_(ReadOnly)_ | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **tls** | bool | Specifies whether to use SSL when connecting to the RabbitMQ instance
_(ReadOnly)_ | | **type** | 'Applications.Messaging/rabbitMQQueues' | The resource type
_(ReadOnly, DeployTimeConstant)_ | | **username** | string | The username to use when connecting to the RabbitMQ instance
_(ReadOnly)_ | @@ -48,12 +48,12 @@ description: "Detailed reference documentation for applications.messaging/rabbit | **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | | **host** | string | The hostname of the RabbitMQ instance | | **port** | int | The port of the RabbitMQ instance. Defaults to 5672 | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **queue** | string | The name of the queue | -| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for a portable resource | -| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. | +| **recipe** | [Recipe](#recipe) | The recipe used to automatically deploy underlying infrastructure for the resource | +| **resourceProvisioning** | 'manual' | 'recipe' | Specifies how the underlying service/resource is provisioned and managed. | | **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the rabbitMQ resource | -| **secrets** | [RabbitMQSecrets](#rabbitmqsecrets) | The connection secrets properties to the RabbitMQ instance | +| **secrets** | [RabbitMQSecrets](#rabbitmqsecrets) | The secrets to connect to the RabbitMQ instance | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | | **tls** | bool | Specifies whether to use SSL when connecting to the RabbitMQ instance | | **username** | string | The username to use when connecting to the RabbitMQ instance | @@ -66,9 +66,9 @@ description: "Detailed reference documentation for applications.messaging/rabbit | Property | Type | Description | |----------|------|-------------| | **name** | string | The name of the recipe within the environment to use
_(Required)_ | -| **parameters** | [RecipeParameters](#recipeparameters) | Key/value parameters to pass into the recipe at deployment | +| **parameters** | [Record](#record) | Key/value parameters to pass into the recipe at deployment | -### RecipeParameters +### Record #### Properties @@ -101,9 +101,9 @@ description: "Detailed reference documentation for applications.messaging/rabbit | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -113,7 +113,7 @@ description: "Detailed reference documentation for applications.messaging/rabbit | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -122,7 +122,7 @@ description: "Detailed reference documentation for applications.messaging/rabbit | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -131,7 +131,7 @@ description: "Detailed reference documentation for applications.messaging/rabbit | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -141,7 +141,7 @@ description: "Detailed reference documentation for applications.messaging/rabbit | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -177,9 +177,9 @@ description: "Detailed reference documentation for applications.messaging/rabbit | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/applications/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/applications/index.md index c00732c45..ac0850131 100644 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/applications/index.md +++ b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/applications/index.md @@ -20,11 +20,11 @@ description: "Detailed reference documentation for radius.core/applications@2025 | **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** | [ApplicationProperties](#applicationproperties) | Application properties
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **properties** | [ApplicationProperties](#applicationproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Radius.Core/applications' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### ApplicationProperties @@ -34,7 +34,7 @@ description: "Detailed reference documentation for radius.core/applications@2025 | Property | Type | Description | |----------|------|-------------| | **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | ### ResourceStatus @@ -43,9 +43,9 @@ description: "Detailed reference documentation for radius.core/applications@2025 | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | +| **compute** | [EnvironmentCompute](#environmentcompute) | The compute resource associated with the resource. | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | +| **recipe** | [RecipeStatus](#recipestatus) | The recipe data at the time of deployment
_(ReadOnly)_ | ### EnvironmentCompute @@ -55,7 +55,7 @@ description: "Detailed reference documentation for radius.core/applications@2025 | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | Configuration for supported external identity providers | | **resourceId** | string | The resource id of the compute resource for application environment. | #### AzureContainerInstanceCompute @@ -64,7 +64,7 @@ description: "Detailed reference documentation for radius.core/applications@2025 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'aci' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'aci' | The Azure container instance compute kind
_(Required)_ | | **resourceGroup** | string | The resource group to use for the environment. | #### KubernetesCompute @@ -73,7 +73,7 @@ description: "Detailed reference documentation for radius.core/applications@2025 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **kind** | 'kubernetes' | The Kubernetes compute kind
_(Required)_ | | **namespace** | string | The namespace to use for the environment.
_(Required)_ | @@ -83,7 +83,7 @@ description: "Detailed reference documentation for radius.core/applications@2025 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -119,9 +119,9 @@ description: "Detailed reference documentation for radius.core/applications@2025 | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepconfigs/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepconfigs/index.md index 0e11a149f..85f06ce17 100644 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepconfigs/index.md +++ b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/bicepconfigs/index.md @@ -19,12 +19,12 @@ description: "Detailed reference documentation for radius.core/bicepconfigs@2025 | **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** | [BicepConfigProperties](#bicepconfigproperties) | Bicep configuration properties.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **properties** | [BicepConfigProperties](#bicepconfigproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **referencedBy** | string[] | Environments that reference this Bicep configuration.
_(ReadOnly)_ | -| **registryAuthentications** | [BicepConfigPropertiesRegistryAuthentications](#bicepconfigpropertiesregistryauthentications) | Authentication configuration for private Bicep registries, keyed by registry hostname (e.g. 'corp.acr.io'). The Bicep driver looks up credentials by the host parsed from the recipe template path.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **registryAuthentications** | [Record](#record) | Authentication configuration for private Bicep registries, keyed by registry hostname (e.g. 'corp.acr.io'). The Bicep driver looks up credentials by the host parsed from the recipe template path.
_(ReadOnly)_ | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Radius.Core/bicepConfigs' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### BicepConfigProperties @@ -33,11 +33,11 @@ description: "Detailed reference documentation for radius.core/bicepconfigs@2025 | Property | Type | Description | |----------|------|-------------| -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **referencedBy** | string[] | Environments that reference this Bicep configuration.
_(ReadOnly)_ | -| **registryAuthentications** | [BicepConfigPropertiesRegistryAuthentications](#bicepconfigpropertiesregistryauthentications) | Authentication configuration for private Bicep registries, keyed by registry hostname (e.g. 'corp.acr.io'). The Bicep driver looks up credentials by the host parsed from the recipe template path. | +| **registryAuthentications** | [Record](#record) | Authentication configuration for private Bicep registries, keyed by registry hostname (e.g. 'corp.acr.io'). The Bicep driver looks up credentials by the host parsed from the recipe template path. | -### BicepConfigPropertiesRegistryAuthentications +### Record #### Properties @@ -53,13 +53,13 @@ description: "Detailed reference documentation for radius.core/bicepconfigs@2025 | Property | Type | Description | |----------|------|-------------| -| **authenticationMethod** | 'AwsIrsa' | 'AzureWI' | 'BasicAuth' | Supported authentication methods for private Bicep registries. | +| **authenticationMethod** | 'AwsIrsa' | 'AzureWI' | 'BasicAuth' | The authentication method to use. Supported values: BasicAuth, AzureWI, AwsIrsa. | | **awsIamRoleArn** | string | AWS IAM Role ARN for IRSA authentication. Required when authenticationMethod is 'AwsIrsa'. | | **azureWiClientId** | string | Azure Workload Identity client ID. Required when authenticationMethod is 'AzureWI'. | | **azureWiTenantId** | string | Azure Workload Identity tenant ID. Required when authenticationMethod is 'AzureWI'. | | **basicAuthSecretId** | string | The ID of an Applications.Core/SecretStore resource containing username and password for BasicAuth. Required when authenticationMethod is 'BasicAuth'. | -### BicepConfigPropertiesRegistryAuthentications +### Record #### Properties @@ -80,9 +80,9 @@ description: "Detailed reference documentation for radius.core/bicepconfigs@2025 | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/environments/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/environments/index.md index 5c959d381..8f34659d7 100644 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/environments/index.md +++ b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/environments/index.md @@ -20,14 +20,14 @@ description: "Detailed reference documentation for radius.core/environments@2025 | **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](#environmentproperties) | Environment properties
_(Required)_ | -| **providers** | [Providers](#providers) |
_(ReadOnly)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **properties** | [EnvironmentProperties](#environmentproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **providers** | [Providers](#providers) | Cloud provider configuration for the environment.
_(ReadOnly)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **recipePacks** | string[] | List of Recipe Pack resource IDs linked to this environment.
_(ReadOnly)_ | -| **recipeParameters** | [EnvironmentPropertiesRecipeParameters](#environmentpropertiesrecipeparameters) | Recipe specific parameters that apply to all resources of a given type in this environment.
_(ReadOnly)_ | +| **recipeParameters** | [Record](#record) | Recipe specific parameters that apply to all resources of a given type in this environment.
_(ReadOnly)_ | | **simulated** | bool | Simulated environment.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **terraformConfig** | string | Resource ID of a Radius.Core/terraformConfigs resource providing Terraform recipe settings.
_(ReadOnly)_ | | **type** | 'Radius.Core/environments' | The resource type
_(ReadOnly, DeployTimeConstant)_ | @@ -38,10 +38,10 @@ description: "Detailed reference documentation for radius.core/environments@2025 | Property | Type | Description | |----------|------|-------------| | **bicepConfig** | string | Resource ID of a Radius.Core/bicepConfigs resource providing Bicep recipe settings. | -| **providers** | [Providers](#providers) | | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **providers** | [Providers](#providers) | Cloud provider configuration for the environment. | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **recipePacks** | string[] | List of Recipe Pack resource IDs linked to this environment. | -| **recipeParameters** | [EnvironmentPropertiesRecipeParameters](#environmentpropertiesrecipeparameters) | Recipe specific parameters that apply to all resources of a given type in this environment. | +| **recipeParameters** | [Record](#record) | Recipe specific parameters that apply to all resources of a given type in this environment. | | **simulated** | bool | Simulated environment. | | **terraformConfig** | string | Resource ID of a Radius.Core/terraformConfigs resource providing Terraform recipe settings. | @@ -51,9 +51,9 @@ description: "Detailed reference documentation for radius.core/environments@2025 | Property | Type | Description | |----------|------|-------------| -| **aws** | [ProvidersAws](#providersaws) | The AWS cloud provider definition. | -| **azure** | [ProvidersAzure](#providersazure) | The Azure cloud provider definition. | -| **kubernetes** | [ProvidersKubernetes](#providerskubernetes) | | +| **aws** | [ProvidersAws](#providersaws) | The AWS cloud provider configuration. | +| **azure** | [ProvidersAzure](#providersazure) | The Azure cloud provider configuration. | +| **kubernetes** | [ProvidersKubernetes](#providerskubernetes) | The Kubernetes provider configuration. | ### ProvidersAws @@ -70,7 +70,7 @@ description: "Detailed reference documentation for radius.core/environments@2025 | Property | Type | Description | |----------|------|-------------| -| **identity** | [IdentitySettings](#identitysettings) | IdentitySettings is the external identity setting. | +| **identity** | [IdentitySettings](#identitysettings) | External identity settings (moved from compute). | | **resourceGroupName** | string | Optional resource group name. | | **subscriptionId** | string | Azure subscription ID hosting deployed resources.
_(Required)_ | @@ -80,7 +80,7 @@ description: "Detailed reference documentation for radius.core/environments@2025 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | +| **kind** | 'azure.com.workload' | 'systemAssigned' | 'systemAssignedUserAssigned' | 'undefined' | 'userAssigned' | kind of identity setting
_(Required)_ | | **managedIdentity** | string[] | The list of user assigned managed identities | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -93,7 +93,7 @@ description: "Detailed reference documentation for radius.core/environments@2025 |----------|------|-------------| | **namespace** | string | Kubernetes namespace to deploy workloads into.
_(Required)_ | -### EnvironmentPropertiesRecipeParameters +### Record #### Properties @@ -113,7 +113,7 @@ description: "Detailed reference documentation for radius.core/environments@2025 * **Additional Properties Type**: any -### EnvironmentPropertiesRecipeParameters +### Record #### Properties @@ -144,9 +144,9 @@ description: "Detailed reference documentation for radius.core/environments@2025 | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/recipepacks/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/recipepacks/index.md index 9f12739e1..c32badd05 100644 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/recipepacks/index.md +++ b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/recipepacks/index.md @@ -19,12 +19,12 @@ description: "Detailed reference documentation for radius.core/recipepacks@2025- | **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** | [RecipePackProperties](#recipepackproperties) | Recipe Pack properties
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipes** | [RecipePackPropertiesRecipes](#recipepackpropertiesrecipes) | Map of resource types to their recipe configurations
_(ReadOnly)_ | +| **properties** | [RecipePackProperties](#recipepackproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation
_(ReadOnly)_ | +| **recipes** | [Record](#record) | Map of resource types to their recipe configurations
_(ReadOnly)_ | | **referencedBy** | string[] | List of environment IDs that reference this recipe pack
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | | **type** | 'Radius.Core/recipePacks' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### RecipePackProperties @@ -33,11 +33,11 @@ description: "Detailed reference documentation for radius.core/recipepacks@2025- | Property | Type | Description | |----------|------|-------------| -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | -| **recipes** | [RecipePackPropertiesRecipes](#recipepackpropertiesrecipes) | Map of resource types to their recipe configurations
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation
_(ReadOnly)_ | +| **recipes** | [Record](#record) | Map of resource types to their recipe configurations
_(Required)_ | | **referencedBy** | string[] | List of environment IDs that reference this recipe pack
_(ReadOnly)_ | -### RecipePackPropertiesRecipes +### Record #### Properties @@ -53,12 +53,23 @@ description: "Detailed reference documentation for radius.core/recipepacks@2025- | Property | Type | Description | |----------|------|-------------| -| **kind** | 'bicep' | 'terraform' | The type of recipe
_(Required)_ | -| **parameters** | [RecipeDefinitionParameters](#recipedefinitionparameters) | Parameters to pass to the recipe | +| **kind** | 'bicep' | 'terraform' | The type of recipe (e.g., Terraform, Bicep)
_(Required)_ | +| **outputs** | [Record](#record) | Map of resource type property names to module output names. Used for recipes that point directly at a Bicep or Terraform module to map the module's outputs onto the resource's properties. | +| **parameters** | [Record](#record) | Parameters to pass to the recipe | | **plainHttp** | bool | Connect to the source using HTTP (not HTTPS). This should be used when the source is known not to support HTTPS, for example in a locally hosted registry for Bicep recipes. Defaults to false (use HTTPS/TLS) | | **source** | string | The source of the recipe. For Bicep recipes this is the OCI registry reference. For Terraform recipes this is the module source.
_(Required)_ | -### RecipeDefinitionParameters +### Record + +#### Properties + +* **none** + +#### Additional Properties + +* **Additional Properties Type**: string + +### Record #### Properties @@ -68,7 +79,7 @@ description: "Detailed reference documentation for radius.core/recipepacks@2025- * **Additional Properties Type**: any -### RecipePackPropertiesRecipes +### Record #### Properties @@ -89,9 +100,9 @@ description: "Detailed reference documentation for radius.core/recipepacks@2025- | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties diff --git a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformconfigs/index.md b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformconfigs/index.md index 1798e5d0e..766d9c789 100644 --- a/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformconfigs/index.md +++ b/docs/content/reference/resources/radius/radius.core/2025-08-01-preview/terraformconfigs/index.md @@ -16,19 +16,19 @@ description: "Detailed reference documentation for radius.core/terraformconfigs@ | Property | Type | Description | |----------|------|-------------| | **apiVersion** | '2025-08-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | -| **env** | [TerraformConfigPropertiesEnv](#terraformconfigpropertiesenv) | Environment variables injected during Terraform recipe execution.
_(ReadOnly)_ | +| **env** | [Record](#record) | Environment variables injected during Terraform recipe execution.
_(ReadOnly)_ | | **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** | [TerraformConfigProperties](#terraformconfigproperties) | Terraform configuration properties.
_(Required)_ | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **properties** | [TerraformConfigProperties](#terraformconfigproperties) | The resource-specific properties for this resource.
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **referencedBy** | string[] | Environments that reference this Terraform configuration.
_(ReadOnly)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | -| **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **terraformrc** | [TerraformrcConfig](#terraformrcconfig) | Terraform CLI configuration file (.terraformrc) settings. See https://developer.hashicorp.com/terraform/cli/config for details.
_(ReadOnly)_ | +| **systemData** | [SystemData](#systemdata) | Azure Resource Manager metadata containing createdBy and modifiedBy information.
_(ReadOnly)_ | +| **tags** | [Record](#record) | Resource tags. | +| **terraformrc** | [TerraformrcConfig](#terraformrcconfig) | Terraform CLI configuration file settings. Maps directly to the Terraform CLI configuration file (.terraformrc).
_(ReadOnly)_ | | **type** | 'Radius.Core/terraformConfigs' | The resource type
_(ReadOnly, DeployTimeConstant)_ | -### TerraformConfigPropertiesEnv +### Record #### Properties @@ -44,12 +44,12 @@ description: "Detailed reference documentation for radius.core/terraformconfigs@ | Property | Type | Description | |----------|------|-------------| -| **env** | [TerraformConfigPropertiesEnv](#terraformconfigpropertiesenv) | Environment variables injected during Terraform recipe execution. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **env** | [Record](#record) | Environment variables injected during Terraform recipe execution. | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | The status of the asynchronous operation.
_(ReadOnly)_ | | **referencedBy** | string[] | Environments that reference this Terraform configuration.
_(ReadOnly)_ | -| **terraformrc** | [TerraformrcConfig](#terraformrcconfig) | Terraform CLI configuration file (.terraformrc) settings. See https://developer.hashicorp.com/terraform/cli/config for details. | +| **terraformrc** | [TerraformrcConfig](#terraformrcconfig) | Terraform CLI configuration file settings. Maps directly to the Terraform CLI configuration file (.terraformrc). | -### TerraformConfigPropertiesEnv +### Record #### Properties @@ -65,10 +65,10 @@ description: "Detailed reference documentation for radius.core/terraformconfigs@ | Property | Type | Description | |----------|------|-------------| -| **credentials** | [TerraformrcConfigCredentials](#terraformrcconfigcredentials) | Credentials for authenticating to private Terraform registries (HTTP-based, e.g. app.terraform.io). Map of registry hostname to credential configuration. Rendered as native `credentials "hostname" {}` blocks in the generated .terraformrc. Note: this is for Terraform CLI registry auth (HTTP), not for Git-based module sources; Git auth is a separate mechanism. | -| **providerInstallation** | [TerraformProviderInstallation](#terraformproviderinstallation) | Provider installation configuration for Terraform CLI. | +| **credentials** | [Record](#record) | Credentials for authenticating to private Terraform registries (HTTP-based, e.g. app.terraform.io). Map of registry hostname to credential configuration. Rendered as native `credentials "hostname" {}` blocks in the generated .terraformrc. Note: this is for Terraform CLI registry auth (HTTP), not for Git-based module sources; Git auth is a separate mechanism. | +| **providerInstallation** | [TerraformProviderInstallation](#terraformproviderinstallation) | Provider installation configuration. Specifies the location of providers via network mirrors or direct downloads. | -### TerraformrcConfigCredentials +### Record #### Properties @@ -93,7 +93,7 @@ description: "Detailed reference documentation for radius.core/terraformconfigs@ | Property | Type | Description | |----------|------|-------------| | **direct** | [TerraformProviderDirect](#terraformproviderdirect) | Direct provider installation configuration. | -| **networkMirror** | [TerraformProviderMirror](#terraformprovidermirror) | Network mirror configuration for Terraform providers. | +| **networkMirror** | [TerraformProviderMirror](#terraformprovidermirror) | Network mirror configuration for downloading providers. | ### TerraformProviderDirect @@ -125,9 +125,9 @@ description: "Detailed reference documentation for radius.core/terraformconfigs@ | **createdByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | | **lastModifiedAt** | string | The timestamp of resource last modification (UTC) | | **lastModifiedBy** | string | The identity that last modified the resource. | -| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that created the resource. | +| **lastModifiedByType** | 'Application' | 'Key' | 'ManagedIdentity' | 'User' | The type of identity that last modified the resource. | -### TrackedResourceTags +### Record #### Properties From 962afb545cdfa7b40c1c8175e5cf25b3229bea00 Mon Sep 17 00:00:00 2001 From: "radius-docs[bot]" <291938785+radius-docs[bot]@users.noreply.github.com> Date: Thu, 2 Jul 2026 13:39:03 +0000 Subject: [PATCH 2/2] docs: synced local 'docs/content/reference/cli/' with remote 'docs/docs/content/reference/cli/' Signed-off-by: radius-docs[bot] <291938785+radius-docs[bot]@users.noreply.github.com> --- docs/content/reference/cli/rad.md | 2 + .../reference/cli/rad_resource_expose.md | 4 ++ .../reference/cli/rad_resource_logs.md | 6 +- docs/content/reference/cli/rad_shutdown.md | 55 ++++++++++++++++++ docs/content/reference/cli/rad_startup.md | 56 +++++++++++++++++++ 5 files changed, 122 insertions(+), 1 deletion(-) create mode 100644 docs/content/reference/cli/rad_shutdown.md create mode 100644 docs/content/reference/cli/rad_startup.md diff --git a/docs/content/reference/cli/rad.md b/docs/content/reference/cli/rad.md index 2f69cf95b..83c8780e3 100644 --- a/docs/content/reference/cli/rad.md +++ b/docs/content/reference/cli/rad.md @@ -40,6 +40,8 @@ Radius CLI * [rad resource-type]({{< ref rad_resource-type.md >}}) - Manage resource types * [rad rollback]({{< ref rad_rollback.md >}}) - Rolls back Radius for a given platform * [rad run]({{< ref rad_run.md >}}) - Run an application +* [rad shutdown]({{< ref rad_shutdown.md >}}) - Back up Radius state and prepare for shutdown +* [rad startup]({{< ref rad_startup.md >}}) - Restore Radius state after startup * [rad uninstall]({{< ref rad_uninstall.md >}}) - Uninstall Radius for a specific platform * [rad upgrade]({{< ref rad_upgrade.md >}}) - Upgrades Radius for a given platform * [rad version]({{< ref rad_version.md >}}) - Prints the versions of the rad CLI and the Radius Control Plane diff --git a/docs/content/reference/cli/rad_resource_expose.md b/docs/content/reference/cli/rad_resource_expose.md index b175d28e7..d47c2b1dd 100644 --- a/docs/content/reference/cli/rad_resource_expose.md +++ b/docs/content/reference/cli/rad_resource_expose.md @@ -27,6 +27,9 @@ rad resource expose [type] [resource] [flags] # expose port 80 on the 'orders' resource of the 'icecream-store' application # on local port 5000 rad resource expose --application icecream-store Applications.Core/containers orders --port 5000 --remote-port 80 + +# expose port 80 using the preview resource type 'Radius.Compute/containers' +rad resource expose --application icecream-store Radius.Compute/containers orders --port 5000 --remote-port 80 --preview ``` ### Options @@ -35,6 +38,7 @@ rad resource expose --application icecream-store Applications.Core/containers or -g, --group string The resource group name -h, --help help for expose -p, --port int specify the local port (default -1) + --preview Use the Radius.Core preview implementation (can also be set via RADIUS_PREVIEW=true) --remote-port int specify the remote port (default -1) --replica string specify the replica to expose -r, --resource string The resource name diff --git a/docs/content/reference/cli/rad_resource_logs.md b/docs/content/reference/cli/rad_resource_logs.md index 4db84a921..e7559fb04 100644 --- a/docs/content/reference/cli/rad_resource_logs.md +++ b/docs/content/reference/cli/rad_resource_logs.md @@ -12,7 +12,7 @@ Read logs from a running containers resource ### Synopsis -Reads logs from a running resource. Currently only supports the resource type 'Applications.Core/containers'. +Reads logs from a running resource. Supports the resource type 'Applications.Core/containers', or 'Radius.Compute/containers' when the '--preview' flag is set. This command allows you to access logs of a deployed application and output those logs to the local console. 'rad resource logs' will output all currently available logs for the resource and then exit. @@ -39,6 +39,9 @@ rad resource logs Applications.Core/containers orders --application icecream-sto # read logs from the 'daprd' sidecar container of the 'orders' resource of the 'icecream-store' application rad resource logs Applications.Core/containers orders --application icecream-store --container daprd + +# read logs from the 'orders' resource using the preview resource type 'Radius.Compute/containers' +rad resource logs Radius.Compute/containers orders --application icecream-store --preview ``` ### Options @@ -48,6 +51,7 @@ rad resource logs Applications.Core/containers orders --application icecream-sto -f, --follow specify that logs should be stream until the command is canceled -g, --group string The resource group name -h, --help help for logs + --preview Use the Radius.Core preview implementation (can also be set via RADIUS_PREVIEW=true) --replica string specify the replica to collect logs from ``` diff --git a/docs/content/reference/cli/rad_shutdown.md b/docs/content/reference/cli/rad_shutdown.md new file mode 100644 index 000000000..3aa3905cb --- /dev/null +++ b/docs/content/reference/cli/rad_shutdown.md @@ -0,0 +1,55 @@ +--- +type: docs +title: "rad shutdown CLI reference" +linkTitle: "rad shutdown" +slug: rad_shutdown +url: /reference/cli/rad_shutdown/ +description: "Details on the rad shutdown Radius CLI command" +--- +## rad shutdown + +Back up Radius state and prepare for shutdown + +### Synopsis + +Back up all durable Radius state for the current workspace. + +Dumps the control-plane PostgreSQL databases and exports the Terraform recipe state Secrets, +commits them to the radius-state git orphan branch, and pushes to the remote when one is +configured. The state can be restored into a fresh control plane with 'rad startup'. + +This command does not delete the cluster or uninstall Radius. + +``` +rad shutdown [flags] +``` + +### Examples + +``` + +# Back up state for the current workspace +rad shutdown + +# Back up state for a specific workspace +rad shutdown --workspace my-workspace +``` + +### Options + +``` + -h, --help help for shutdown + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") + -o, --output string output format (supported formats are json, table) (default "table") +``` + +### SEE ALSO + +* [rad]({{< ref rad.md >}}) - Radius CLI + diff --git a/docs/content/reference/cli/rad_startup.md b/docs/content/reference/cli/rad_startup.md new file mode 100644 index 000000000..46131f329 --- /dev/null +++ b/docs/content/reference/cli/rad_startup.md @@ -0,0 +1,56 @@ +--- +type: docs +title: "rad startup CLI reference" +linkTitle: "rad startup" +slug: rad_startup +url: /reference/cli/rad_startup/ +description: "Details on the rad startup Radius CLI command" +--- +## rad startup + +Restore Radius state after startup + +### Synopsis + +Restore durable Radius state for the current workspace. + +Opens the radius-state git orphan branch, waits for the control-plane PostgreSQL instance to be +ready, restores the control-plane databases, and re-creates the Terraform recipe state Secrets. +Run this after Radius is installed on a fresh cluster to resume from the state saved by +'rad shutdown'. + +This command does not create the cluster or install Radius. + +``` +rad startup [flags] +``` + +### Examples + +``` + +# Restore state for the current workspace +rad startup + +# Restore state for a specific workspace +rad startup --workspace my-workspace +``` + +### Options + +``` + -h, --help help for startup + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") + -o, --output string output format (supported formats are json, table) (default "table") +``` + +### SEE ALSO + +* [rad]({{< ref rad.md >}}) - Radius CLI +