From b60df3da6b500108f0f46c45fc54df012eccb952 Mon Sep 17 00:00:00 2001 From: Shruthi Kumar Date: Tue, 13 Aug 2024 08:12:52 -0700 Subject: [PATCH 1/2] Upmerge edge with latest v0.36 changes (#1178) * Update docs for v0.36.0 Signed-off-by: sk593 * Update auto-generated documentation (#1151) * Autogenerate reference docs Signed-off-by: rad-ci-bot * Update en-custom.txt Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --------- Signed-off-by: rad-ci-bot Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Co-authored-by: rad-ci-bot Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: sk593 * Add HowTo tutorial to configure Terraform Custom Provider (#1162) * add howto doc for tf custom provider config * unsaved files * update per comments * update for conflicts * extra space * extra space * further comments * capitalizing Environment * one more change --------- Signed-off-by: Lakshmi Javadekar <103459615+lakshmimsft@users.noreply.github.com> Signed-off-by: sk593 * correct highlight (#1164) Signed-off-by: sk593 * Update index.md (#1160) Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: sk593 * Add envSecrets block to HowTo Custom Provider tutorial (#1166) * adding envSecrets * updated per suggestion Signed-off-by: sk593 * removing port input in config (#1167) Signed-off-by: sk593 * revert Signed-off-by: sk593 * fix spellcheck Signed-off-by: sk593 * Update docs/layouts/partials/hooks/body-end.html Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> --------- Signed-off-by: sk593 Signed-off-by: rad-ci-bot Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Signed-off-by: Lakshmi Javadekar <103459615+lakshmimsft@users.noreply.github.com> Co-authored-by: Radius CI Bot Co-authored-by: rad-ci-bot <103787451+rad-ci-bot@users.noreply.github.com> Co-authored-by: rad-ci-bot Co-authored-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com> Co-authored-by: Lakshmi Javadekar <103459615+lakshmimsft@users.noreply.github.com> --- .github/config/en-custom.txt | 8 ++ .../terraform/howto-custom-provider/index.md | 87 ++++++++++++++++++ .../snippets/env-complete.bicep | 80 +++++++++++++++++ .../howto-custom-provider/snippets/env.bicep | 71 +++++++++++++++ .../snippets/postgres.tf | 89 +++++++++++++++++++ docs/content/tutorials/tutorial-dapr/index.md | 2 +- 6 files changed, 336 insertions(+), 1 deletion(-) create mode 100644 docs/content/guides/recipes/terraform/howto-custom-provider/index.md create mode 100644 docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env-complete.bicep create mode 100644 docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env.bicep create mode 100644 docs/content/guides/recipes/terraform/howto-custom-provider/snippets/postgres.tf diff --git a/.github/config/en-custom.txt b/.github/config/en-custom.txt index 9aa34b40d..104c612b9 100644 --- a/.github/config/en-custom.txt +++ b/.github/config/en-custom.txt @@ -1251,6 +1251,14 @@ ServiceAccounts pluggable envSecrets RecipeConfigPropertiesEnvSecrets +ProviderConfigPropertiesSecrets +SecretReference +cyrilgdn +secretStore +postgreSQL +postgresenvSecrets +RecipeConfigPropertiesEnvSecrets SecretReference ProviderConfigPropertiesSecrets irsa +postgres \ No newline at end of file diff --git a/docs/content/guides/recipes/terraform/howto-custom-provider/index.md b/docs/content/guides/recipes/terraform/howto-custom-provider/index.md new file mode 100644 index 000000000..2835a24f4 --- /dev/null +++ b/docs/content/guides/recipes/terraform/howto-custom-provider/index.md @@ -0,0 +1,87 @@ +--- +type: docs +title: "How-To: Configure custom Terraform Providers" +linkTitle: "Custom Terraform Providers" +description: "Learn how to setup your Radius Environment with custom Terraform Providers and deploy Recipes." +weight: 500 +categories: "How-To" +aliases : ["/guides/recipes/terraform/howto-custom-provider"] +tags: ["recipes", "terraform"] +--- + +This how-to guide will describe how to: + +- Configure a custom [Terraform provider](https://registry.terraform.io/browse/providers) in a Radius Environment. +- Configure credentials to authenticate into the Terraform provider. +- Consume the Terraform modules from a custom Terraform provider and use it in a Terraform recipe. + +In this example you're going to configure a [PostgreSQL Terraform provider](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs) in a Radius Environment and deploy a Recipe. + +### Prerequisites + +Before you get started, you'll need to make sure you have the following tools and resources: + +- [rad CLI]({{< ref "installation#step-1-install-the-rad-cli" >}}) +- [Radius Bicep VSCode extension]({{< ref "installation#step-2-install-the-vs-code-extension" >}}) +- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) +- [Radius initialized with `rad init`]({{< ref howto-environment >}}) +- [Recipes overview]({{< ref "/guides/recipes/overview" >}}) + +## Step 1: Define a secretStore resource for the custom provider + +Configure a [Radius Secret Store]({{< ref "/guides/author-apps/secrets/overview" >}}) with any sensitive information needed as input configuration for the custom Terraform Provider. Define the namespace for the cluster that will contain your [Kubernetes Secret](https://kubernetes.io/docs/concepts/configuration/secret/) with the `resource` property. + +> While this example shows a Radius-managed secret store where Radius creates the underlying secrets infrastructure, you can also bring your own existing secrets. Refer to the [secrets documentation]({{< ref "/guides/author-apps/secrets/overview" >}}) for more information. + +Create a Bicep file `env.bicep` with the secretStore resource: + +{{< rad file="snippets/env.bicep" embed=true marker="//SECRETSTORE" >}} + +> In this example, you're creating a secret with keys `username` and `password` as sensitive data required to authenticate into the Terraform Provider `cyrilgdn/postgresql`. + +## Step 2: Configure Terraform Provider + +`recipeConfig/terraform/providers` allows you to setup configurations for one or multiple Terraform Providers. For more information refer to the [Radius Environment schema]({{< ref environment-schema >}}) page. + +In your `env.bicep` file add an Environment resource, along with Recipe configuration which leverages properties from the previously defined secret store. In this example you're also passing in `host` and `port` as environment variables to highlight use cases where, depending on provider configuration requirements, users can pass environment variables as plain text and as secret values in `envSecrets` block to the Terraform recipes runtime. + +{{< rad file="snippets/env.bicep" embed=true marker="//ENV" >}} + +## Step 3: Define a Terraform Recipe + +Create a Terraform recipe which deploys a PostgreSQL database instance using custom Terraform provider `cyrilgdn/postgresql`. + +{{< rad file="snippets/postgres.tf" embed=true marker="//ENV" >}} + +## Step 4: Add a Terraform Recipe to the Environment + +Update your Environment with the Terraform Recipe. + +{{< rad file="snippets/env-complete.bicep" embed=true marker="//ENV" markdownConfig="{linenos=table,hl_lines=[\"37-45\"],linenostart=30,lineNos=false}" >}} + +## Step 5: Deploy your Radius Environment + +Deploy your new Radius Environment passing in values for `username` and `password` needed to authenticate into the provider. The superuser for this PostgreSQL Recipe is `postgres` which is the expected input for `username`: + +```bash +rad deploy ./env.bicep -p username=****** -p password=****** +``` + +## Done + +Your Radius Environment is now configured with a custom Terraform Provider which you can use to deploy Radius Terraform Recipes. For more information on Radius Recipes visit the [Recipes overview page]({{< ref "/guides/recipes/overview" >}}). + +## Cleanup + +You can delete the Radius Environment by running the following command: + +```bash +rad env delete my-env +``` + +## Further reading + +- [Recipes overview]({{< ref "/guides/recipes/overview" >}}) +- [Radius Environments]({{< ref "/guides/deploy-apps/environments/overview" >}}) +- [`rad recipe CLI reference`]({{< ref rad_recipe >}}) +- [`rad env CLI reference`]({{< ref rad_env >}}) \ No newline at end of file diff --git a/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env-complete.bicep b/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env-complete.bicep new file mode 100644 index 000000000..5d163c92c --- /dev/null +++ b/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env-complete.bicep @@ -0,0 +1,80 @@ +//SECRETSTORE +import radius as radius + +@description('username for postgres db') +@secure() +param username string + +@description('password for postgres db') +@secure() +param password string + +resource pgsSecretStore 'Applications.Core/secretStores@2023-10-01-preview' = { + name: 'my-secret-store' + properties: { + resource: 'my-secret-namespace/my-secret-store' + type: 'generic' + data: { + username: { + value: username + } + password: { + value: password + } + host: { + value: 'my-postgres-host' + } + } + } +} +//SECRETSTORE + +//ENV +resource env 'Applications.Core/environments@2023-10-01-preview' = { + name: 'my-env' + properties: { + compute: { + kind: 'kubernetes' + resourceId: 'self' + namespace: 'my-namespace' + } + recipeConfig: { + terraform: { + providers: { + postgresql: [ { + sslmode: 'disable' + secrets: { + username: { + source: pgsSecretStore.id + key: username + } + password: { + source: pgsSecretStore.id + key: password + } + } + } ] + } + } + env: { + PGPORT: '5432' + } + envSecrets: { + PGHOST: { + source: pgsSecretStore.id + key: 'host' + } + } + } + recipes: { + 'Applications.Core/extenders': { + defaultpostgres: { + templateKind: 'terraform' + // Recipe template path + templatePath: 'git::https://github.com/my-org/my-repo' + } + } + } + } +} +//ENV diff --git a/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env.bicep b/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env.bicep new file mode 100644 index 000000000..baa2814bd --- /dev/null +++ b/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/env.bicep @@ -0,0 +1,71 @@ +//SECRETSTORE +import radius as radius + +@description('username for PostgreSQL db') +@secure() +param username string + +@description('password for PostgreSQL db') +@secure() +param password string + +resource pgsSecretStore 'Applications.Core/secretStores@2023-10-01-preview' = { + name: 'my-secret-store' + properties: { + resource: 'my-secret-namespace/my-secret-store' + type: 'generic' + data: { + username: { + value: username + } + password: { + value: password + } + host: { + value: 'my-postgres-host' + } + } + } +} +//SECRETSTORE + +//ENV +resource env 'Applications.Core/environments@2023-10-01-preview' = { + name: 'my-env' + properties: { + compute: { + kind: 'kubernetes' + resourceId: 'self' + namespace: 'my-namespace' + } + recipeConfig: { + terraform: { + providers: { + postgresql: [ { + sslmode: 'disable' + secrets: { + username: { + source: pgsSecretStore.id + key: username + } + password: { + source: pgsSecretStore.id + key: password + } + } + } ] + } + } + env: { + PGPORT: '5432' + } + envSecrets: { + PGHOST: { + source: pgsSecretStore.id + key: 'host' + } + } + } + } +} +//ENV diff --git a/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/postgres.tf b/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/postgres.tf new file mode 100644 index 000000000..422147ba0 --- /dev/null +++ b/docs/content/guides/recipes/terraform/howto-custom-provider/snippets/postgres.tf @@ -0,0 +1,89 @@ +terraform { + required_providers { + kubernetes = { + source = "hashicorp/kubernetes" + version = ">= 2.0" + } + postgresql = { + source = "cyrilgdn/postgresql" + version = "1.16.0" + } + } +} + +variable "context" { + description = "This variable contains Radius recipe context." + type = any +} + +variable "password" { + description = "The password for the PostgreSQL database" + type = string +} + +resource "kubernetes_deployment" "postgres" { + metadata { + name = "postgres" + namespace = var.context.runtime.kubernetes.namespace + } + + spec { + selector { + match_labels = { + app = "postgres" + } + } + + template { + metadata { + labels = { + app = "postgres" + } + } + + spec { + container { + image = "postgres:latest" + name = "postgres" + + env { + name = "POSTGRES_PASSWORD" + value = var.password + } + + port { + container_port = 5432 + } + } + } + } + } +} + +resource "kubernetes_service" "postgres" { + metadata { + name = "postgres" + namespace = var.context.runtime.kubernetes.namespace + } + + spec { + selector = { + app = "postgres" + } + + port { + port = 5432 + target_port = 5432 + } + } +} + +resource "time_sleep" "wait_20_seconds" { + depends_on = [kubernetes_service.postgres] + create_duration = "20s" +} + +resource "postgresql_database" "pg_db_test" { + depends_on = [time_sleep.wait_20_seconds] + name = "pg_db_test" +} diff --git a/docs/content/tutorials/tutorial-dapr/index.md b/docs/content/tutorials/tutorial-dapr/index.md index fedb7020e..37962f7e5 100644 --- a/docs/content/tutorials/tutorial-dapr/index.md +++ b/docs/content/tutorials/tutorial-dapr/index.md @@ -14,7 +14,7 @@ This tutorial will teach you the following about Dapr: - How to use Radius to deploy a Dapr microservices sample application for an online shop - How [Dapr and Radius]({{< ref "guides/author-apps/dapr" >}}) seamlessly work together -For more details on the app and access to the source code, visit the `tutorials/dapr` directory in the [samples repo](https://github.com/radius-project/samples). +For more details on the app and access to the source code, visit the `samples/dapr` directory in the [samples repo](https://github.com/radius-project/samples). ## Prerequisites From 20533660ecb7256d533fe9d9fdd0ae81e077ccf1 Mon Sep 17 00:00:00 2001 From: rad-ci-bot <103787451+rad-ci-bot@users.noreply.github.com> Date: Tue, 13 Aug 2024 13:24:56 -0700 Subject: [PATCH 2/2] Update auto-generated documentation (#1191) * Autogenerate reference docs Signed-off-by: rad-ci-bot * update spellcheck Signed-off-by: sk593 --------- Signed-off-by: rad-ci-bot Signed-off-by: sk593 Co-authored-by: rad-ci-bot Co-authored-by: sk593 --- .github/config/en-custom.txt | 4 +- .../2023-10-01-preview/applications/index.md | 46 +++++------ .../2023-10-01-preview/containers/index.md | 80 +++++++++---------- .../2023-10-01-preview/environments/index.md | 52 ++++++------ .../2023-10-01-preview/extenders/index.md | 41 ++++------ .../2023-10-01-preview/gateways/index.md | 36 ++++----- .../2023-10-01-preview/secretstores/index.md | 60 ++++---------- .../2023-10-01-preview/volumes/index.md | 42 +++++----- .../2023-10-01-preview/pubsubbrokers/index.md | 38 ++++----- .../2023-10-01-preview/secretstores/index.md | 36 ++++----- .../2023-10-01-preview/statestores/index.md | 38 ++++----- .../mongodatabases/index.md | 52 +++++------- .../2023-10-01-preview/rediscaches/index.md | 53 +++++------- .../2023-10-01-preview/sqldatabases/index.md | 52 +++++------- .../rabbitmqqueues/index.md | 52 +++++------- 15 files changed, 293 insertions(+), 389 deletions(-) diff --git a/.github/config/en-custom.txt b/.github/config/en-custom.txt index 104c612b9..3cbab33e9 100644 --- a/.github/config/en-custom.txt +++ b/.github/config/en-custom.txt @@ -1261,4 +1261,6 @@ RecipeConfigPropertiesEnvSecrets SecretReference ProviderConfigPropertiesSecrets irsa -postgres \ No newline at end of file +postgres +ReadOnly +DeployTimeConstant \ No newline at end of file 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 45ce360ab..551fb15e1 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 @@ -15,14 +15,14 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [ApplicationProperties](#applicationproperties) | Application properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [ApplicationProperties](#applicationproperties) | Application properties
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | | **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **type** | 'Applications.Core/applications' | The resource type
_(read-only, deploy-time constant)_ | +| **type** | 'Applications.Core/applications' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### ApplicationProperties @@ -30,10 +30,10 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **environment** | string | Fully qualified resource ID for the environment that the application is linked to
_(required)_ | +| **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' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | ### Extension @@ -50,10 +50,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)_ | +| **appId** | string | The Dapr appId. Specifies the identifier used by Dapr for service invocation.
_(Required)_ | | **appPort** | int | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. | | **config** | string | Specifies the Dapr configuration to use for the resource. | -| **kind** | 'daprSidecar' | Discriminator property for Extension.
_(required)_ | +| **kind** | 'daprSidecar' | Discriminator property for Extension.
_(Required)_ | | **protocol** | 'grpc' | 'http' | The Dapr sidecar extension protocol | #### KubernetesMetadataExtension @@ -63,7 +63,7 @@ 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)_ | +| **kind** | 'kubernetesMetadata' | Discriminator property for Extension.
_(Required)_ | | **labels** | [KubernetesMetadataExtensionLabels](#kubernetesmetadataextensionlabels) | Labels to be applied to the Kubernetes resources output by the resource | #### KubernetesNamespaceExtension @@ -72,8 +72,8 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetesNamespace' | Discriminator property for Extension.
_(required)_ | -| **namespace** | string | The namespace of the application environment.
_(required)_ | +| **kind** | 'kubernetesNamespace' | Discriminator property for Extension.
_(Required)_ | +| **namespace** | string | The namespace of the application environment.
_(Required)_ | #### ManualScalingExtension @@ -81,8 +81,8 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **kind** | 'manualScaling' | Discriminator property for Extension.
_(required)_ | -| **replicas** | int | Replica count.
_(required)_ | +| **kind** | 'manualScaling' | Discriminator property for Extension.
_(Required)_ | +| **replicas** | int | Replica count.
_(Required)_ | ### KubernetesMetadataExtensionAnnotations @@ -113,7 +113,7 @@ description: "Detailed reference documentation for applications.core/application |----------|------|-------------| | **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | ### EnvironmentCompute @@ -132,8 +132,8 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### IdentitySettings @@ -142,7 +142,7 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -162,8 +162,8 @@ description: "Detailed reference documentation for applications.core/application | Property | Type | Description | |----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | +| **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. | ### SystemData 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 f86be1c4d..763f4befa 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 @@ -15,14 +15,14 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [ContainerProperties](#containerproperties) | Container properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [ContainerProperties](#containerproperties) | Container properties
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | | **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **type** | 'Applications.Core/containers' | The resource type
_(read-only, deploy-time constant)_ | +| **type** | 'Applications.Core/containers' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### ContainerProperties @@ -30,18 +30,18 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application
_(required)_ | +| **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)_ | +| **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' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | '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. | | **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 | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | ### ContainerPropertiesConnections @@ -61,7 +61,7 @@ description: "Detailed reference documentation for applications.core/containers@ |----------|------|-------------| | **disableDefaultEnvVars** | bool | default environment variable override | | **iam** | [IamProperties](#iamproperties) | IAM properties | -| **source** | string | The source of the connection
_(required)_ | +| **source** | string | The source of the connection
_(Required)_ | ### IamProperties @@ -69,7 +69,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure' | The kind of IAM provider to configure
_(required)_ | +| **kind** | 'azure' | The kind of IAM provider to configure
_(Required)_ | | **roles** | string[] | RBAC permissions to be assigned on the source resource | ### Container @@ -81,7 +81,7 @@ 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 | -| **image** | string | The registry and image to download and run in your container
_(required)_ | +| **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 | @@ -118,8 +118,8 @@ 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)_ | +| **command** | string | Command to execute to probe readiness/liveness
_(Required)_ | +| **kind** | 'exec' | Discriminator property for HealthProbeProperties.
_(Required)_ | #### HttpGetHealthProbeProperties @@ -127,10 +127,10 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **containerPort** | int | The listening port number
_(required)_ | +| **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)_ | -| **path** | string | The route to make the HTTP request on
_(required)_ | +| **kind** | 'httpGet' | Discriminator property for HealthProbeProperties.
_(Required)_ | +| **path** | string | The route to make the HTTP request on
_(Required)_ | #### TcpHealthProbeProperties @@ -138,8 +138,8 @@ 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)_ | +| **containerPort** | int | The listening port number
_(Required)_ | +| **kind** | 'tcp' | Discriminator property for HealthProbeProperties.
_(Required)_ | ### HttpGetHealthProbePropertiesHeaders @@ -168,7 +168,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **containerPort** | int | The listening port number
_(required)_ | +| **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 | | **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 | @@ -199,8 +199,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' | Discriminator property for Volume.
_(Required)_ | +| **managedStore** | 'disk' | 'memory' | The managed store for the ephemeral volume
_(Required)_ | #### PersistentVolume @@ -208,9 +208,9 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'persistent' | Discriminator property for Volume.
_(required)_ | +| **kind** | 'persistent' | Discriminator property for Volume.
_(Required)_ | | **permission** | 'read' | 'write' | The persistent volume permission | -| **source** | string | The source of the volume
_(required)_ | +| **source** | string | The source of the volume
_(Required)_ | ### Extension @@ -228,10 +228,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)_ | +| **appId** | string | The Dapr appId. Specifies the identifier used by Dapr for service invocation.
_(Required)_ | | **appPort** | int | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. | | **config** | string | Specifies the Dapr configuration to use for the resource. | -| **kind** | 'daprSidecar' | Discriminator property for Extension.
_(required)_ | +| **kind** | 'daprSidecar' | Discriminator property for Extension.
_(Required)_ | | **protocol** | 'grpc' | 'http' | The Dapr sidecar extension protocol | #### KubernetesMetadataExtension @@ -241,7 +241,7 @@ 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)_ | +| **kind** | 'kubernetesMetadata' | Discriminator property for Extension.
_(Required)_ | | **labels** | [KubernetesMetadataExtensionLabels](#kubernetesmetadataextensionlabels) | Labels to be applied to the Kubernetes resources output by the resource | #### KubernetesNamespaceExtension @@ -250,8 +250,8 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetesNamespace' | Discriminator property for Extension.
_(required)_ | -| **namespace** | string | The namespace of the application environment.
_(required)_ | +| **kind** | 'kubernetesNamespace' | Discriminator property for Extension.
_(Required)_ | +| **namespace** | string | The namespace of the application environment.
_(Required)_ | #### ManualScalingExtension @@ -259,8 +259,8 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'manualScaling' | Discriminator property for Extension.
_(required)_ | -| **replicas** | int | Replica count.
_(required)_ | +| **kind** | 'manualScaling' | Discriminator property for Extension.
_(Required)_ | +| **replicas** | int | Replica count.
_(Required)_ | ### KubernetesMetadataExtensionAnnotations @@ -289,7 +289,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -299,7 +299,7 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(required)_ | +| **id** | string | Resource id of an existing resource
_(Required)_ | ### RuntimesProperties @@ -336,7 +336,7 @@ description: "Detailed reference documentation for applications.core/containers@ |----------|------|-------------| | **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | ### EnvironmentCompute @@ -355,8 +355,8 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### OutputResource @@ -375,8 +375,8 @@ description: "Detailed reference documentation for applications.core/containers@ | Property | Type | Description | |----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | +| **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. | ### SystemData 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 583d6359e..7a7361947 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 @@ -15,14 +15,14 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [EnvironmentProperties](#environmentproperties) | Environment properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [EnvironmentProperties](#environmentproperties) | Environment properties
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | | **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **type** | 'Applications.Core/environments' | The resource type
_(read-only, deploy-time constant)_ | +| **type** | 'Applications.Core/environments' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### EnvironmentProperties @@ -30,10 +30,10 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource
_(required)_ | +| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource
_(Required)_ | | **extensions** | [Extension](#extension)[] | The environment extension. | | **providers** | [Providers](#providers) | The Cloud providers configuration. | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(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. | | **simulated** | bool | Simulated environment. | @@ -55,8 +55,8 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### IdentitySettings @@ -65,7 +65,7 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -84,10 +84,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)_ | +| **appId** | string | The Dapr appId. Specifies the identifier used by Dapr for service invocation.
_(Required)_ | | **appPort** | int | The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar. | | **config** | string | Specifies the Dapr configuration to use for the resource. | -| **kind** | 'daprSidecar' | Discriminator property for Extension.
_(required)_ | +| **kind** | 'daprSidecar' | Discriminator property for Extension.
_(Required)_ | | **protocol** | 'grpc' | 'http' | The Dapr sidecar extension protocol | #### KubernetesMetadataExtension @@ -97,7 +97,7 @@ 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)_ | +| **kind** | 'kubernetesMetadata' | Discriminator property for Extension.
_(Required)_ | | **labels** | [KubernetesMetadataExtensionLabels](#kubernetesmetadataextensionlabels) | Labels to be applied to the Kubernetes resources output by the resource | #### KubernetesNamespaceExtension @@ -106,8 +106,8 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetesNamespace' | Discriminator property for Extension.
_(required)_ | -| **namespace** | string | The namespace of the application environment.
_(required)_ | +| **kind** | 'kubernetesNamespace' | Discriminator property for Extension.
_(Required)_ | +| **namespace** | string | The namespace of the application environment.
_(Required)_ | #### ManualScalingExtension @@ -115,8 +115,8 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **kind** | 'manualScaling' | Discriminator property for Extension.
_(required)_ | -| **replicas** | int | Replica count.
_(required)_ | +| **kind** | 'manualScaling' | Discriminator property for Extension.
_(Required)_ | +| **replicas** | int | Replica count.
_(Required)_ | ### KubernetesMetadataExtensionAnnotations @@ -154,7 +154,7 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **scope** | string | Target scope for AWS resources to be deployed into. For example: '/planes/aws/aws/accounts/000000000000/regions/us-west-2'.
_(required)_ | +| **scope** | string | Target scope for AWS resources to be deployed into. For example: '/planes/aws/aws/accounts/000000000000/regions/us-west-2'.
_(Required)_ | ### ProvidersAzure @@ -162,7 +162,7 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **scope** | string | Target scope for Azure resources to be deployed into. For example: '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup'.
_(required)_ | +| **scope** | string | Target scope for Azure resources to be deployed into. For example: '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup'.
_(Required)_ | ### RecipeConfigProperties @@ -200,8 +200,8 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **key** | string | The key for the secret in the secret store.
_(required)_ | -| **source** | string | The ID of an Applications.Core/SecretStore resource containing sensitive data required for recipe execution.
_(required)_ | +| **key** | string | The key for the secret in the secret store.
_(Required)_ | +| **source** | string | The ID of an Applications.Core/SecretStore resource containing sensitive data required for recipe execution.
_(Required)_ | ### TerraformConfigProperties @@ -306,7 +306,7 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| | **parameters** | any | Any object | -| **templatePath** | string | Path to the template provided by the recipe. Currently only link to Azure Container Registry is supported.
_(required)_ | +| **templatePath** | string | Path to the template provided by the recipe. Currently only link to Azure Container Registry is supported.
_(Required)_ | #### BicepRecipeProperties @@ -315,7 +315,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' | Discriminator property for RecipeProperties.
_(Required)_ | #### TerraformRecipeProperties @@ -323,7 +323,7 @@ description: "Detailed reference documentation for applications.core/environment | Property | Type | Description | |----------|------|-------------| -| **templateKind** | 'terraform' | Discriminator property for RecipeProperties.
_(required)_ | +| **templateKind** | 'terraform' | Discriminator property for RecipeProperties.
_(Required)_ | | **templateVersion** | string | Version of the template to deploy. For Terraform recipes using a module registry this is required, but must be omitted for other module sources. | 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 72dc81067..43761158f 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 @@ -15,21 +15,14 @@ description: "Detailed reference documentation for applications.core/extenders@2 | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [ExtenderProperties](#extenderproperties) | ExtenderResource portable resource properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [ExtenderProperties](#extenderproperties) | ExtenderResource portable resource properties
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | | **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **type** | 'Applications.Core/extenders' | The resource type
_(read-only, deploy-time constant)_ | - -### Function listSecrets (Applications.Core/extenders@2023-10-01-preview) - -* **Resource**: Applications.Core/extenders -* **ApiVersion**: 2023-10-01-preview -* **Input**: any -* **Output**: any +| **type** | 'Applications.Core/extenders' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### ExtenderProperties @@ -38,12 +31,12 @@ description: "Detailed reference documentation for applications.core/extenders@2 | Property | Type | Description | |----------|------|-------------| | **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' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(Required)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | '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** | any | Any object | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | #### Additional Properties * **Additional Properties Type**: any @@ -54,7 +47,7 @@ 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)_ | +| **name** | string | The name of the recipe within the environment to use
_(Required)_ | | **parameters** | any | Any object | ### ResourceStatus @@ -65,7 +58,7 @@ description: "Detailed reference documentation for applications.core/extenders@2 |----------|------|-------------| | **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | ### EnvironmentCompute @@ -84,8 +77,8 @@ description: "Detailed reference documentation for applications.core/extenders@2 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### IdentitySettings @@ -94,7 +87,7 @@ description: "Detailed reference documentation for applications.core/extenders@2 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -114,8 +107,8 @@ description: "Detailed reference documentation for applications.core/extenders@2 | Property | Type | Description | |----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | +| **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. | ### SystemData 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 997423295..11cd5f303 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 @@ -15,14 +15,14 @@ description: "Detailed reference documentation for applications.core/gateways@20 | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [GatewayProperties](#gatewayproperties) | Gateway properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [GatewayProperties](#gatewayproperties) | Gateway properties
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | | **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **type** | 'Applications.Core/gateways' | The resource type
_(read-only, deploy-time constant)_ | +| **type** | 'Applications.Core/gateways' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### GatewayProperties @@ -30,15 +30,15 @@ description: "Detailed reference documentation for applications.core/gateways@20 | Property | Type | Description | |----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application
_(required)_ | +| **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 | | **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' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | -| **routes** | [GatewayRoute](#gatewayroute)[] | Routes attached to this Gateway
_(required)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(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. | -| **url** | string | URL of the gateway resource. Readonly
_(read-only)_ | +| **url** | string | URL of the gateway resource. Readonly
_(ReadOnly)_ | ### GatewayHostname @@ -68,7 +68,7 @@ description: "Detailed reference documentation for applications.core/gateways@20 |----------|------|-------------| | **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | ### EnvironmentCompute @@ -87,8 +87,8 @@ description: "Detailed reference documentation for applications.core/gateways@20 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### IdentitySettings @@ -97,7 +97,7 @@ description: "Detailed reference documentation for applications.core/gateways@20 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -117,8 +117,8 @@ description: "Detailed reference documentation for applications.core/gateways@20 | Property | Type | Description | |----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | +| **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. | ### GatewayTls 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 66d726653..dfa045b42 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 @@ -15,21 +15,14 @@ description: "Detailed reference documentation for applications.core/secretstore | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [SecretStoreProperties](#secretstoreproperties) | The properties of SecretStore
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [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. | -| **type** | 'Applications.Core/secretStores' | The resource type
_(read-only, deploy-time constant)_ | - -### Function listSecrets (Applications.Core/secretStores@2023-10-01-preview) - -* **Resource**: Applications.Core/secretStores -* **ApiVersion**: 2023-10-01-preview -* **Input**: any -* **Output**: [SecretStoreListSecretsResult](#secretstorelistsecretsresult) +| **type** | 'Applications.Core/secretStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### SecretStoreProperties @@ -38,11 +31,11 @@ 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** | [SecretStorePropertiesData](#secretstorepropertiesdata) | 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' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | | **resource** | string | The resource id of external secret store. | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | | **type** | 'certificate' | 'generic' | The type of SecretStore data | ### SecretStorePropertiesData @@ -71,7 +64,7 @@ description: "Detailed reference documentation for applications.core/secretstore | Property | Type | Description | |----------|------|-------------| -| **name** | string | The name of the referenced secret.
_(required)_ | +| **name** | string | The name of the referenced secret.
_(Required)_ | | **version** | string | The version of the referenced secret. | ### ResourceStatus @@ -82,7 +75,7 @@ description: "Detailed reference documentation for applications.core/secretstore |----------|------|-------------| | **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | ### EnvironmentCompute @@ -101,8 +94,8 @@ description: "Detailed reference documentation for applications.core/secretstore | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### IdentitySettings @@ -111,7 +104,7 @@ description: "Detailed reference documentation for applications.core/secretstore | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -131,8 +124,8 @@ description: "Detailed reference documentation for applications.core/secretstore | Property | Type | Description | |----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | +| **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. | ### SystemData @@ -158,22 +151,3 @@ description: "Detailed reference documentation for applications.core/secretstore * **Additional Properties Type**: string -### SecretStoreListSecretsResult - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **data** | [SecretStoreListSecretsResultData](#secretstorelistsecretsresultdata) | An object to represent key-value type secrets
_(read-only)_ | -| **type** | 'certificate' | 'generic' | The type of SecretStore data
_(read-only)_ | - -### SecretStoreListSecretsResultData - -#### Properties - -* **none** - -#### Additional Properties - -* **Additional Properties Type**: [SecretValueProperties](#secretvalueproperties) - 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 05737c5ee..efd14d00f 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 @@ -15,14 +15,14 @@ description: "Detailed reference documentation for applications.core/volumes@202 | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [VolumeProperties](#volumeproperties) | Volume properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [VolumeProperties](#volumeproperties) | Volume properties
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | | **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **type** | 'Applications.Core/volumes' | The resource type
_(read-only, deploy-time constant)_ | +| **type** | 'Applications.Core/volumes' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### VolumeProperties @@ -32,10 +32,10 @@ description: "Detailed reference documentation for applications.core/volumes@202 | Property | Type | Description | |----------|------|-------------| -| **application** | string | Fully qualified resource ID for the application
_(required)_ | +| **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' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(ReadOnly)_ | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | #### AzureKeyVaultVolumeProperties @@ -45,8 +45,8 @@ description: "Detailed reference documentation for applications.core/volumes@202 |----------|------|-------------| | **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)_ | -| **resource** | string | The ID of the keyvault to use for this volume resource
_(required)_ | +| **kind** | 'azure.com.keyvault' | Discriminator property for VolumeProperties.
_(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 | @@ -58,7 +58,7 @@ description: "Detailed reference documentation for applications.core/volumes@202 |----------|------|-------------| | **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | ### EnvironmentCompute @@ -77,8 +77,8 @@ description: "Detailed reference documentation for applications.core/volumes@202 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### IdentitySettings @@ -87,7 +87,7 @@ description: "Detailed reference documentation for applications.core/volumes@202 | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -107,8 +107,8 @@ description: "Detailed reference documentation for applications.core/volumes@202 | Property | Type | Description | |----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | +| **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 @@ -131,7 +131,7 @@ description: "Detailed reference documentation for applications.core/volumes@202 | **certType** | 'certificate' | 'privatekey' | 'publickey' | Represents certificate types | | **encoding** | 'base64' | 'hex' | 'utf-8' | Represents secret encodings | | **format** | 'pem' | 'pfx' | Represents certificate formats | -| **name** | string | The name of the certificate
_(required)_ | +| **name** | string | The name of the certificate
_(Required)_ | | **version** | string | Certificate version | ### AzureKeyVaultVolumePropertiesKeys @@ -151,7 +151,7 @@ description: "Detailed reference documentation for applications.core/volumes@202 | Property | Type | Description | |----------|------|-------------| | **alias** | string | File name when written to disk | -| **name** | string | The name of the key
_(required)_ | +| **name** | string | The name of the key
_(Required)_ | | **version** | string | Key version | ### AzureKeyVaultVolumePropertiesSecrets @@ -172,7 +172,7 @@ description: "Detailed reference documentation for applications.core/volumes@202 |----------|------|-------------| | **alias** | string | File name when written to disk | | **encoding** | 'base64' | 'hex' | 'utf-8' | Represents secret encodings | -| **name** | string | The name of the secret
_(required)_ | +| **name** | string | The name of the secret
_(Required)_ | | **version** | string | secret version | ### SystemData 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 52b42ff89..a9838e939 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 @@ -15,14 +15,14 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [DaprPubSubBrokerProperties](#daprpubsubbrokerproperties) | Dapr PubSubBroker portable resource properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [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. | -| **type** | 'Applications.Dapr/pubSubBrokers' | The resource type
_(read-only, deploy-time constant)_ | +| **type** | 'Applications.Dapr/pubSubBrokers' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### DaprPubSubBrokerProperties @@ -31,14 +31,14 @@ 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) | -| **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.
_(read-only)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(required)_ | +| **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** | any | Any object | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | '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. | | **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the pubSubBroker | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **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 | @@ -48,7 +48,7 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **name** | string | The name of the recipe within the environment to use
_(Required)_ | | **parameters** | any | Any object | ### ResourceReference @@ -57,7 +57,7 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(required)_ | +| **id** | string | Resource id of an existing resource
_(Required)_ | ### ResourceStatus @@ -67,7 +67,7 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke |----------|------|-------------| | **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | ### EnvironmentCompute @@ -86,8 +86,8 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### IdentitySettings @@ -96,7 +96,7 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -116,8 +116,8 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke | Property | Type | Description | |----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | +| **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. | ### SystemData 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 53bd81046..0f47923b2 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 @@ -15,14 +15,14 @@ description: "Detailed reference documentation for applications.dapr/secretstore | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [DaprSecretStoreProperties](#daprsecretstoreproperties) | Dapr SecretStore portable resource properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [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. | -| **type** | 'Applications.Dapr/secretStores' | The resource type
_(read-only, deploy-time constant)_ | +| **type** | 'Applications.Dapr/secretStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### DaprSecretStoreProperties @@ -31,13 +31,13 @@ description: "Detailed reference documentation for applications.dapr/secretstore | Property | Type | Description | |----------|------|-------------| | **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.
_(read-only)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(required)_ | +| **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** | any | Any object | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | '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. | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **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 | @@ -47,7 +47,7 @@ description: "Detailed reference documentation for applications.dapr/secretstore | Property | Type | Description | |----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **name** | string | The name of the recipe within the environment to use
_(Required)_ | | **parameters** | any | Any object | ### ResourceStatus @@ -58,7 +58,7 @@ description: "Detailed reference documentation for applications.dapr/secretstore |----------|------|-------------| | **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | ### EnvironmentCompute @@ -77,8 +77,8 @@ description: "Detailed reference documentation for applications.dapr/secretstore | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### IdentitySettings @@ -87,7 +87,7 @@ description: "Detailed reference documentation for applications.dapr/secretstore | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -107,8 +107,8 @@ description: "Detailed reference documentation for applications.dapr/secretstore | Property | Type | Description | |----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | +| **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. | ### SystemData 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 98c5c8559..cab18c1b2 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 @@ -15,14 +15,14 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [DaprStateStoreProperties](#daprstatestoreproperties) | Dapr StateStore portable resource properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [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. | -| **type** | 'Applications.Dapr/stateStores' | The resource type
_(read-only, deploy-time constant)_ | +| **type** | 'Applications.Dapr/stateStores' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### DaprStateStoreProperties @@ -31,14 +31,14 @@ 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) | -| **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.
_(read-only)_ | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(required)_ | +| **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** | any | Any object | -| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | '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. | | **resources** | [ResourceReference](#resourcereference)[] | A collection of references to resources associated with the state store | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **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 | @@ -48,7 +48,7 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **name** | string | The name of the recipe within the environment to use
_(Required)_ | | **parameters** | any | Any object | ### ResourceReference @@ -57,7 +57,7 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(required)_ | +| **id** | string | Resource id of an existing resource
_(Required)_ | ### ResourceStatus @@ -67,7 +67,7 @@ description: "Detailed reference documentation for applications.dapr/statestores |----------|------|-------------| | **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | ### EnvironmentCompute @@ -86,8 +86,8 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### IdentitySettings @@ -96,7 +96,7 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -116,8 +116,8 @@ description: "Detailed reference documentation for applications.dapr/statestores | Property | Type | Description | |----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | +| **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. | ### SystemData 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 e1c3e2674..8b18c0064 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 @@ -15,21 +15,14 @@ description: "Detailed reference documentation for applications.datastores/mongo | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [MongoDatabaseProperties](#mongodatabaseproperties) | MongoDatabase portable resource properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [MongoDatabaseProperties](#mongodatabaseproperties) | MongoDatabase portable resource properties
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | | **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **type** | 'Applications.Datastores/mongoDatabases' | The resource type
_(read-only, deploy-time constant)_ | - -### Function listSecrets (Applications.Datastores/mongoDatabases@2023-10-01-preview) - -* **Resource**: Applications.Datastores/mongoDatabases -* **ApiVersion**: 2023-10-01-preview -* **Input**: any -* **Output**: [MongoDatabaseListSecretsResult](#mongodatabaselistsecretsresult) +| **type** | 'Applications.Datastores/mongoDatabases' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### MongoDatabaseProperties @@ -39,15 +32,15 @@ description: "Detailed reference documentation for applications.datastores/mongo |----------|------|-------------| | **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | | **database** | string | Database name of the target Mongo database | -| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to
_(required)_ | +| **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' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | '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. | | **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the MongoDB resource | | **secrets** | [MongoDatabaseSecrets](#mongodatabasesecrets) | The secret values for the given MongoDatabase resource | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | | **username** | string | Username to use when connecting to the target Mongo database | ### Recipe @@ -56,7 +49,7 @@ description: "Detailed reference documentation for applications.datastores/mongo | Property | Type | Description | |----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **name** | string | The name of the recipe within the environment to use
_(Required)_ | | **parameters** | any | Any object | ### ResourceReference @@ -65,7 +58,7 @@ description: "Detailed reference documentation for applications.datastores/mongo | Property | Type | Description | |----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(required)_ | +| **id** | string | Resource id of an existing resource
_(Required)_ | ### MongoDatabaseSecrets @@ -84,7 +77,7 @@ description: "Detailed reference documentation for applications.datastores/mongo |----------|------|-------------| | **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | ### EnvironmentCompute @@ -103,8 +96,8 @@ description: "Detailed reference documentation for applications.datastores/mongo | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### IdentitySettings @@ -113,7 +106,7 @@ description: "Detailed reference documentation for applications.datastores/mongo | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -133,8 +126,8 @@ description: "Detailed reference documentation for applications.datastores/mongo | Property | Type | Description | |----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | +| **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. | ### SystemData @@ -160,12 +153,3 @@ description: "Detailed reference documentation for applications.datastores/mongo * **Additional Properties Type**: string -### MongoDatabaseListSecretsResult - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **connectionString** | string | Connection string used to connect to the target Mongo database
_(read-only)_ | -| **password** | string | Password to use when connecting to the target Mongo database
_(read-only)_ | - 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 df5d257cc..ffdf1cbf3 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 @@ -15,21 +15,14 @@ description: "Detailed reference documentation for applications.datastores/redis | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [RedisCacheProperties](#rediscacheproperties) | RedisCache portable resource properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [RedisCacheProperties](#rediscacheproperties) | RedisCache portable resource properties
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | | **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **type** | 'Applications.Datastores/redisCaches' | The resource type
_(read-only, deploy-time constant)_ | - -### Function listSecrets (Applications.Datastores/redisCaches@2023-10-01-preview) - -* **Resource**: Applications.Datastores/redisCaches -* **ApiVersion**: 2023-10-01-preview -* **Input**: any -* **Output**: [RedisCacheListSecretsResult](#rediscachelistsecretsresult) +| **type** | 'Applications.Datastores/redisCaches' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### RedisCacheProperties @@ -38,15 +31,15 @@ description: "Detailed reference documentation for applications.datastores/redis | Property | Type | Description | |----------|------|-------------| | **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)_ | +| **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' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | '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. | | **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the Redis resource | | **secrets** | [RedisCacheSecrets](#rediscachesecrets) | The secret values for the given RedisCache resource | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **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 | @@ -56,7 +49,7 @@ description: "Detailed reference documentation for applications.datastores/redis | Property | Type | Description | |----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **name** | string | The name of the recipe within the environment to use
_(Required)_ | | **parameters** | any | Any object | ### ResourceReference @@ -65,7 +58,7 @@ description: "Detailed reference documentation for applications.datastores/redis | Property | Type | Description | |----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(required)_ | +| **id** | string | Resource id of an existing resource
_(Required)_ | ### RedisCacheSecrets @@ -85,7 +78,7 @@ description: "Detailed reference documentation for applications.datastores/redis |----------|------|-------------| | **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | ### EnvironmentCompute @@ -104,8 +97,8 @@ description: "Detailed reference documentation for applications.datastores/redis | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### IdentitySettings @@ -114,7 +107,7 @@ description: "Detailed reference documentation for applications.datastores/redis | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -134,8 +127,8 @@ description: "Detailed reference documentation for applications.datastores/redis | Property | Type | Description | |----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | +| **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. | ### SystemData @@ -161,13 +154,3 @@ description: "Detailed reference documentation for applications.datastores/redis * **Additional Properties Type**: string -### RedisCacheListSecretsResult - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **connectionString** | string | The connection string used to connect to the Redis cache
_(read-only)_ | -| **password** | string | The password for this Redis cache instance
_(read-only)_ | -| **url** | string | The URL used to connect to the Redis cache
_(read-only)_ | - 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 a291bb0a5..82f0ab0cc 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 @@ -15,21 +15,14 @@ description: "Detailed reference documentation for applications.datastores/sqlda | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [SqlDatabaseProperties](#sqldatabaseproperties) | SqlDatabase properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [SqlDatabaseProperties](#sqldatabaseproperties) | SqlDatabase properties
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | | **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **type** | 'Applications.Datastores/sqlDatabases' | The resource type
_(read-only, deploy-time constant)_ | - -### Function listSecrets (Applications.Datastores/sqlDatabases@2023-10-01-preview) - -* **Resource**: Applications.Datastores/sqlDatabases -* **ApiVersion**: 2023-10-01-preview -* **Input**: any -* **Output**: [SqlDatabaseListSecretsResult](#sqldatabaselistsecretsresult) +| **type** | 'Applications.Datastores/sqlDatabases' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### SqlDatabaseProperties @@ -39,15 +32,15 @@ description: "Detailed reference documentation for applications.datastores/sqlda |----------|------|-------------| | **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) | | **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)_ | +| **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' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | '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. | | **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the SqlDatabase resource | | **secrets** | [SqlDatabaseSecrets](#sqldatabasesecrets) | The secret values for the given SqlDatabase resource | | **server** | string | The fully qualified domain name of the Sql database. | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(ReadOnly)_ | | **username** | string | Username to use when connecting to the target Sql database | ### Recipe @@ -56,7 +49,7 @@ description: "Detailed reference documentation for applications.datastores/sqlda | Property | Type | Description | |----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **name** | string | The name of the recipe within the environment to use
_(Required)_ | | **parameters** | any | Any object | ### ResourceReference @@ -65,7 +58,7 @@ description: "Detailed reference documentation for applications.datastores/sqlda | Property | Type | Description | |----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(required)_ | +| **id** | string | Resource id of an existing resource
_(Required)_ | ### SqlDatabaseSecrets @@ -84,7 +77,7 @@ description: "Detailed reference documentation for applications.datastores/sqlda |----------|------|-------------| | **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | ### EnvironmentCompute @@ -103,8 +96,8 @@ description: "Detailed reference documentation for applications.datastores/sqlda | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### IdentitySettings @@ -113,7 +106,7 @@ description: "Detailed reference documentation for applications.datastores/sqlda | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -133,8 +126,8 @@ description: "Detailed reference documentation for applications.datastores/sqlda | Property | Type | Description | |----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | +| **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. | ### SystemData @@ -160,12 +153,3 @@ description: "Detailed reference documentation for applications.datastores/sqlda * **Additional Properties Type**: string -### SqlDatabaseListSecretsResult - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **connectionString** | string | Connection string used to connect to the target Sql database
_(read-only)_ | -| **password** | string | Password to use when connecting to the target Sql database
_(read-only)_ | - 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 83cab1dc9..0c4509db1 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 @@ -15,21 +15,14 @@ description: "Detailed reference documentation for applications.messaging/rabbit | Property | Type | Description | |----------|------|-------------| -| **apiVersion** | '2023-10-01-preview' | The resource api version
_(read-only, deploy-time constant)_ | -| **id** | string | The resource id
_(read-only, deploy-time constant)_ | -| **location** | string | The geo-location where the resource lives
_(required)_ | -| **name** | string | The resource name
_(required, deploy-time constant)_ | -| **properties** | [RabbitMQQueueProperties](#rabbitmqqueueproperties) | RabbitMQQueue portable resource properties
_(required)_ | -| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(read-only)_ | +| **apiVersion** | '2023-10-01-preview' | The resource api version
_(ReadOnly, DeployTimeConstant)_ | +| **id** | string | The resource id
_(ReadOnly, DeployTimeConstant)_ | +| **location** | string | The geo-location where the resource lives | +| **name** | string | The resource name
_(Required, DeployTimeConstant, Identifier)_ | +| **properties** | [RabbitMQQueueProperties](#rabbitmqqueueproperties) | RabbitMQQueue portable resource properties
_(Required)_ | +| **systemData** | [SystemData](#systemdata) | Metadata pertaining to creation and last modification of the resource.
_(ReadOnly)_ | | **tags** | [TrackedResourceTags](#trackedresourcetags) | Resource tags. | -| **type** | 'Applications.Messaging/rabbitMQQueues' | The resource type
_(read-only, deploy-time constant)_ | - -### Function listSecrets (Applications.Messaging/rabbitMQQueues@2023-10-01-preview) - -* **Resource**: Applications.Messaging/rabbitMQQueues -* **ApiVersion**: 2023-10-01-preview -* **Input**: any -* **Output**: [RabbitMQListSecretsResult](#rabbitmqlistsecretsresult) +| **type** | 'Applications.Messaging/rabbitMQQueues' | The resource type
_(ReadOnly, DeployTimeConstant)_ | ### RabbitMQQueueProperties @@ -38,16 +31,16 @@ description: "Detailed reference documentation for applications.messaging/rabbit | Property | Type | Description | |----------|------|-------------| | **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)_ | +| **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' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(read-only)_ | +| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called
_(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. | | **resources** | [ResourceReference](#resourcereference)[] | List of the resource IDs that support the rabbitMQ resource | | **secrets** | [RabbitMQSecrets](#rabbitmqsecrets) | The connection secrets properties to the RabbitMQ instance | -| **status** | [ResourceStatus](#resourcestatus) | Status of a resource.
_(read-only)_ | +| **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 | | **vHost** | string | The RabbitMQ virtual host (vHost) the client will connect to. Defaults to no vHost. | @@ -58,7 +51,7 @@ description: "Detailed reference documentation for applications.messaging/rabbit | Property | Type | Description | |----------|------|-------------| -| **name** | string | The name of the recipe within the environment to use
_(required)_ | +| **name** | string | The name of the recipe within the environment to use
_(Required)_ | | **parameters** | any | Any object | ### ResourceReference @@ -67,7 +60,7 @@ description: "Detailed reference documentation for applications.messaging/rabbit | Property | Type | Description | |----------|------|-------------| -| **id** | string | Resource id of an existing resource
_(required)_ | +| **id** | string | Resource id of an existing resource
_(Required)_ | ### RabbitMQSecrets @@ -86,7 +79,7 @@ description: "Detailed reference documentation for applications.messaging/rabbit |----------|------|-------------| | **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource | | **outputResources** | [OutputResource](#outputresource)[] | Properties of an output resource | -| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(read-only)_ | +| **recipe** | [RecipeStatus](#recipestatus) | Recipe status at deployment time for a resource.
_(ReadOnly)_ | ### EnvironmentCompute @@ -105,8 +98,8 @@ description: "Detailed reference documentation for applications.messaging/rabbit | Property | Type | Description | |----------|------|-------------| -| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(required)_ | -| **namespace** | string | The namespace to use for the environment.
_(required)_ | +| **kind** | 'kubernetes' | Discriminator property for EnvironmentCompute.
_(Required)_ | +| **namespace** | string | The namespace to use for the environment.
_(Required)_ | ### IdentitySettings @@ -115,7 +108,7 @@ description: "Detailed reference documentation for applications.messaging/rabbit | Property | Type | Description | |----------|------|-------------| -| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(required)_ | +| **kind** | 'azure.com.workload' | 'undefined' | IdentitySettingKind is the kind of supported external identity setting
_(Required)_ | | **oidcIssuer** | string | The URI for your compute platform's OIDC issuer | | **resource** | string | The resource ID of the provisioned identity | @@ -135,8 +128,8 @@ description: "Detailed reference documentation for applications.messaging/rabbit | Property | Type | Description | |----------|------|-------------| -| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(required)_ | -| **templatePath** | string | TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
_(required)_ | +| **templateKind** | string | TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
_(Required)_ | +| **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. | ### SystemData @@ -162,12 +155,3 @@ description: "Detailed reference documentation for applications.messaging/rabbit * **Additional Properties Type**: string -### RabbitMQListSecretsResult - -#### Properties - -| Property | Type | Description | -|----------|------|-------------| -| **password** | string | The password used to connect to the RabbitMQ instance
_(read-only)_ | -| **uri** | string | The connection URI of the RabbitMQ instance. Generated automatically from host, port, SSL, username, password, and vhost. Can be overridden with a custom value
_(read-only)_ | -