Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update auto-generated documentation #1257

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ description: "Detailed reference documentation for applications.core/application
|----------|------|-------------|
| **environment** | string | Fully qualified resource ID for the environment that the application is linked to <br />_(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 <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **status** | [ResourceStatus](#resourcestatus) | Status of a resource. <br />_(ReadOnly)_ |

### Extension
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ description: "Detailed reference documentation for applications.core/containers@
| **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 <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(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 |
Expand Down Expand Up @@ -69,7 +69,7 @@ description: "Detailed reference documentation for applications.core/containers@

| Property | Type | Description |
|----------|------|-------------|
| **kind** | 'azure' | The kind of IAM provider to configure <br />_(Required)_ |
| **kind** | 'azure' | 'string' | The kind of IAM provider to configure <br />_(Required)_ |
| **roles** | string[] | RBAC permissions to be assigned on the source resource |

### Container
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ description: "Detailed reference documentation for applications.core/environment
| **compute** | [EnvironmentCompute](#environmentcompute) | Represents backing compute resource <br />_(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 <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(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. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ description: "Detailed reference documentation for applications.core/extenders@2
|----------|------|-------------|
| **application** | string | Fully qualified resource ID for the application that the portable resource is consumed by (if applicable) |
| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to <br />_(Required)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(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 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ description: "Detailed reference documentation for applications.core/gateways@20
| **environment** | string | Fully qualified resource ID for the environment that the application is linked to |
| **hostname** | [GatewayHostname](#gatewayhostname) | Declare hostname information for the Gateway. Leaving the hostname empty auto-assigns one: mygateway.myapp.PUBLICHOSTNAMEORIP.nip.io. |
| **internal** | bool | Sets Gateway to not be exposed externally (no public IP address associated). Defaults to false (exposed to internet). |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **routes** | [GatewayRoute](#gatewayroute)[] | Routes attached to this Gateway <br />_(Required)_ |
| **status** | [ResourceStatus](#resourcestatus) | Status of a resource. <br />_(ReadOnly)_ |
| **tls** | [GatewayTls](#gatewaytls) | TLS configuration definition for Gateway resource. |
Expand Down Expand Up @@ -128,7 +128,7 @@ description: "Detailed reference documentation for applications.core/gateways@20
| Property | Type | Description |
|----------|------|-------------|
| **certificateFrom** | string | The resource id for the secret containing the TLS certificate and key for the gateway. |
| **minimumProtocolVersion** | '1.2' | '1.3' | Tls Minimum versions for Gateway resource. |
| **minimumProtocolVersion** | '1.2' | '1.3' | TLS minimum protocol version (defaults to 1.2). |
| **sslPassthrough** | bool | If true, gateway lets the https traffic sslPassthrough to the backend servers for decryption. |

### SystemData
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ description: "Detailed reference documentation for applications.core/secretstore
| **application** | string | Fully qualified resource ID for the application |
| **data** | [SecretStorePropertiesData](#secretstorepropertiesdata) | An object to represent key-value type secrets <br />_(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 <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **resource** | string | The resource id of external secret store. |
| **status** | [ResourceStatus](#resourcestatus) | Status of a resource. <br />_(ReadOnly)_ |
| **type** | 'awsIRSA' | 'azureWorkloadIdentity' | 'basicAuthentication' | 'certificate' | 'generic' | The type of SecretStore data |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ description: "Detailed reference documentation for applications.core/volumes@202
|----------|------|-------------|
| **application** | string | Fully qualified resource ID for the application <br />_(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 <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **status** | [ResourceStatus](#resourcestatus) | Status of a resource. <br />_(ReadOnly)_ |

#### AzureKeyVaultVolumeProperties
Expand Down Expand Up @@ -129,7 +129,7 @@ description: "Detailed reference documentation for applications.core/volumes@202
|----------|------|-------------|
| **alias** | string | File name when written to disk |
| **certType** | 'certificate' | 'privatekey' | 'publickey' | Represents certificate types |
| **encoding** | 'base64' | 'hex' | 'utf-8' | Represents secret encodings |
| **encoding** | 'base64' | 'hex' | 'utf-8' | Encoding format. Default utf-8 |
| **format** | 'pem' | 'pfx' | Represents certificate formats |
| **name** | string | The name of the certificate <br />_(Required)_ |
| **version** | string | Certificate version |
Expand Down Expand Up @@ -171,7 +171,7 @@ description: "Detailed reference documentation for applications.core/volumes@202
| Property | Type | Description |
|----------|------|-------------|
| **alias** | string | File name when written to disk |
| **encoding** | 'base64' | 'hex' | 'utf-8' | Represents secret encodings |
| **encoding** | 'base64' | 'hex' | 'utf-8' | Encoding format. Default utf-8 |
| **name** | string | The name of the secret <br />_(Required)_ |
| **version** | string | secret version |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ description: "Detailed reference documentation for applications.dapr/configurati
| **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. <br />_(ReadOnly)_ |
| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to <br />_(Required)_ |
| **metadata** | [DaprConfigurationStorePropertiesMetadata](#daprconfigurationstorepropertiesmetadata) | The metadata for Dapr resource which must match the values specified in Dapr component spec |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(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 configuration store |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ description: "Detailed reference documentation for applications.dapr/pubsubbroke
| **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. <br />_(ReadOnly)_ |
| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to <br />_(Required)_ |
| **metadata** | [DaprPubSubBrokerPropertiesMetadata](#daprpubsubbrokerpropertiesmetadata) | The metadata for Dapr resource which must match the values specified in Dapr component spec |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(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 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ description: "Detailed reference documentation for applications.dapr/secretstore
| **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. <br />_(ReadOnly)_ |
| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to <br />_(Required)_ |
| **metadata** | [DaprSecretStorePropertiesMetadata](#daprsecretstorepropertiesmetadata) | The metadata for Dapr resource which must match the values specified in Dapr component spec |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(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. <br />_(ReadOnly)_ |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ description: "Detailed reference documentation for applications.dapr/statestores
| **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. <br />_(ReadOnly)_ |
| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to <br />_(Required)_ |
| **metadata** | [DaprStateStorePropertiesMetadata](#daprstatestorepropertiesmetadata) | The metadata for Dapr resource which must match the values specified in Dapr component spec |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(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 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ description: "Detailed reference documentation for applications.datastores/mongo
| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to <br />_(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 <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(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 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ description: "Detailed reference documentation for applications.datastores/redis
| **environment** | string | Fully qualified resource ID for the environment that the portable resource is linked to <br />_(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 <br />_(ReadOnly)_ |
| **provisioningState** | 'Accepted' | 'Canceled' | 'Creating' | 'Deleting' | 'Failed' | 'Provisioning' | 'Succeeded' | 'Updating' | Provisioning state of the resource at the time the operation was called <br />_(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 |
Expand Down
Loading
Loading