Reference: applications.core/gateways@2023-10-01-preview
Detailed reference documentation for applications.core/gateways@2023-10-01-preview
Schema
Top-Level Resource
Properties
| Property | Type | Description |
|---|---|---|
| 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 | Gateway properties (Required) |
| systemData | SystemData | Metadata pertaining to creation and last modification of the resource. (ReadOnly) |
| tags | TrackedResourceTags | Resource tags. |
| type | ‘Applications.Core/gateways’ | The resource type (ReadOnly, DeployTimeConstant) |
GatewayProperties
Properties
| Property | Type | Description |
|---|---|---|
| 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 | 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’ |
| routes | GatewayRoute[] | Routes attached to this Gateway (Required) |
| status | ResourceStatus | Status of a resource. (ReadOnly) |
| tls | GatewayTls | TLS configuration definition for Gateway resource. |
| url | string | URL of the gateway resource. Readonly (ReadOnly) |
GatewayHostname
Properties
| Property | Type | Description |
|---|---|---|
| fullyQualifiedHostname | string | Specify a fully-qualified domain name: myapp.mydomain.com. Mutually exclusive with ‘prefix’ and will take priority if both are defined. |
| prefix | string | Specify a prefix for the hostname: myhostname.myapp.PUBLICHOSTNAMEORIP.nip.io. Mutually exclusive with ‘fullyQualifiedHostname’ and will be overridden if both are defined. |
GatewayRoute
Properties
| Property | Type | Description |
|---|---|---|
| destination | string | The URL or id of the service to route to. Ex - ‘http://myservice’. |
| enableWebsockets | bool | Enables websocket support for the route. Defaults to false. |
| path | string | The path to match the incoming request path on. Ex - /myservice. |
| replacePrefix | string | Optionally update the prefix when sending the request to the service. Ex - replacePrefix: ‘/’ and path: ‘/myservice’ will transform ‘/myservice/myroute’ to ‘/myroute’ |
| timeoutPolicy | GatewayRouteTimeoutPolicy | Gateway route timeout policy |
GatewayRouteTimeoutPolicy
Properties
| Property | Type | Description |
|---|---|---|
| backendRequest | string | The backend request timeout in duration for the route. Cannot be greater than the request timeout. |
| request | string | The request timeout in duration for the route. Defaults to 15 seconds. |
ResourceStatus
Properties
| Property | Type | Description |
|---|---|---|
| compute | EnvironmentCompute | Represents backing compute resource |
| outputResources | OutputResource[] | Properties of an output resource |
| recipe | RecipeStatus | Recipe status at deployment time for a resource. (ReadOnly) |
EnvironmentCompute
- Discriminator: kind
Base Properties
| Property | Type | Description |
|---|---|---|
| identity | IdentitySettings | IdentitySettings is the external identity setting. |
| resourceId | string | The resource id of the compute resource for application environment. |
AzureContainerInstanceCompute
Properties
| Property | Type | Description |
|---|---|---|
| kind | ‘aci’ | Discriminator property for EnvironmentCompute. (Required) |
| resourceGroup | string | The resource group to use for the environment. |
KubernetesCompute
Properties
| Property | Type | Description |
|---|---|---|
| kind | ‘kubernetes’ | Discriminator property for EnvironmentCompute. (Required) |
| namespace | string | The namespace to use for the environment. (Required) |
IdentitySettings
Properties
| Property | Type | Description |
|---|---|---|
| kind | ‘azure.com.workload’ | ‘systemAssigned’ |
| managedIdentity | string[] | The list of user assigned managed identities |
| oidcIssuer | string | The URI for your compute platform’s OIDC issuer |
| resource | string | The resource ID of the provisioned identity |
OutputResource
Properties
| Property | Type | Description |
|---|---|---|
| id | string | The UCP resource ID of the underlying resource. |
| localId | string | The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency relationship. LocalIDs do not have any particular format or meaning beyond being compared to determine dependency relationships. |
| radiusManaged | bool | Determines whether Radius manages the lifecycle of the underlying resource. |
RecipeStatus
Properties
| 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) |
| templateVersion | string | TemplateVersion is the version number of the template. |
GatewayTls
Properties
| 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’ |
| sslPassthrough | bool | If true, gateway lets the https traffic sslPassthrough to the backend servers for decryption. |
SystemData
Properties
| Property | Type | Description |
|---|---|---|
| createdAt | string | The timestamp of resource creation (UTC). |
| createdBy | string | The identity that created the resource. |
| createdByType | ‘Application’ | ‘Key’ |
| lastModifiedAt | string | The timestamp of resource last modification (UTC) |
| lastModifiedBy | string | The identity that last modified the resource. |
| lastModifiedByType | ‘Application’ | ‘Key’ |
TrackedResourceTags
Properties
- none
Additional Properties
- Additional Properties Type: string
Feedback
Was this page helpful?
Glad to hear it! Please feel free to star our repo and join our Discord server to stay up to date with the project.
Sorry to hear that. If you would like to also contribute a suggestion visit and tell us how we can improve.