1. Packages
  2. Azure Native
  3. API Docs
  4. appplatform
  5. getGateway
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.appplatform.getGateway

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Get the Spring Cloud Gateway and its properties.

Uses Azure REST API version 2024-01-01-preview.

Other available API versions: 2023-05-01-preview, 2023-07-01-preview, 2023-09-01-preview, 2023-11-01-preview, 2023-12-01, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native appplatform [ApiVersion]. See the version guide for details.

Using getGateway

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGateway(args: GetGatewayArgs, opts?: InvokeOptions): Promise<GetGatewayResult>
function getGatewayOutput(args: GetGatewayOutputArgs, opts?: InvokeOptions): Output<GetGatewayResult>
Copy
def get_gateway(gateway_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                service_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetGatewayResult
def get_gateway_output(gateway_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                service_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetGatewayResult]
Copy
func LookupGateway(ctx *Context, args *LookupGatewayArgs, opts ...InvokeOption) (*LookupGatewayResult, error)
func LookupGatewayOutput(ctx *Context, args *LookupGatewayOutputArgs, opts ...InvokeOption) LookupGatewayResultOutput
Copy

> Note: This function is named LookupGateway in the Go SDK.

public static class GetGateway 
{
    public static Task<GetGatewayResult> InvokeAsync(GetGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
public static Output<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:appplatform:getGateway
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of Spring Cloud Gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
GatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of Spring Cloud Gateway.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of Spring Cloud Gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.
gatewayName
This property is required.
Changes to this property will trigger replacement.
string
The name of Spring Cloud Gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
gateway_name
This property is required.
Changes to this property will trigger replacement.
str
The name of Spring Cloud Gateway.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Service resource.
gatewayName
This property is required.
Changes to this property will trigger replacement.
String
The name of Spring Cloud Gateway.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.

getGateway Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource Id for the resource.
Name string
The name of the resource.
Properties Pulumi.AzureNative.AppPlatform.Outputs.GatewayPropertiesResponse
Spring Cloud Gateway properties payload
SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
Sku Pulumi.AzureNative.AppPlatform.Outputs.SkuResponse
Sku of the Spring Cloud Gateway resource
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource Id for the resource.
Name string
The name of the resource.
Properties GatewayPropertiesResponse
Spring Cloud Gateway properties payload
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
Sku SkuResponse
Sku of the Spring Cloud Gateway resource
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource Id for the resource.
name String
The name of the resource.
properties GatewayPropertiesResponse
Spring Cloud Gateway properties payload
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.
sku SkuResponse
Sku of the Spring Cloud Gateway resource
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource Id for the resource.
name string
The name of the resource.
properties GatewayPropertiesResponse
Spring Cloud Gateway properties payload
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource.
sku SkuResponse
Sku of the Spring Cloud Gateway resource
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource Id for the resource.
name str
The name of the resource.
properties GatewayPropertiesResponse
Spring Cloud Gateway properties payload
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource.
sku SkuResponse
Sku of the Spring Cloud Gateway resource
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource Id for the resource.
name String
The name of the resource.
properties Property Map
Spring Cloud Gateway properties payload
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.
sku Property Map
Sku of the Spring Cloud Gateway resource

Supporting Types

ApmReferenceResponse

ResourceId This property is required. string
Resource Id of the APM
ResourceId This property is required. string
Resource Id of the APM
resourceId This property is required. String
Resource Id of the APM
resourceId This property is required. string
Resource Id of the APM
resource_id This property is required. str
Resource Id of the APM
resourceId This property is required. String
Resource Id of the APM

GatewayApiMetadataPropertiesResponse

Description string
Detailed description of the APIs available on the Gateway instance (default: Generated OpenAPI 3 document that describes the API routes configured.)
Documentation string
Location of additional documentation for the APIs available on the Gateway instance
ServerUrl string
Base URL that API consumers will use to access APIs on the Gateway instance.
Title string
Title describing the context of the APIs available on the Gateway instance (default: Spring Cloud Gateway for K8S)
Version string
Version of APIs available on this Gateway instance (default: unspecified).
Description string
Detailed description of the APIs available on the Gateway instance (default: Generated OpenAPI 3 document that describes the API routes configured.)
Documentation string
Location of additional documentation for the APIs available on the Gateway instance
ServerUrl string
Base URL that API consumers will use to access APIs on the Gateway instance.
Title string
Title describing the context of the APIs available on the Gateway instance (default: Spring Cloud Gateway for K8S)
Version string
Version of APIs available on this Gateway instance (default: unspecified).
description String
Detailed description of the APIs available on the Gateway instance (default: Generated OpenAPI 3 document that describes the API routes configured.)
documentation String
Location of additional documentation for the APIs available on the Gateway instance
serverUrl String
Base URL that API consumers will use to access APIs on the Gateway instance.
title String
Title describing the context of the APIs available on the Gateway instance (default: Spring Cloud Gateway for K8S)
version String
Version of APIs available on this Gateway instance (default: unspecified).
description string
Detailed description of the APIs available on the Gateway instance (default: Generated OpenAPI 3 document that describes the API routes configured.)
documentation string
Location of additional documentation for the APIs available on the Gateway instance
serverUrl string
Base URL that API consumers will use to access APIs on the Gateway instance.
title string
Title describing the context of the APIs available on the Gateway instance (default: Spring Cloud Gateway for K8S)
version string
Version of APIs available on this Gateway instance (default: unspecified).
description str
Detailed description of the APIs available on the Gateway instance (default: Generated OpenAPI 3 document that describes the API routes configured.)
documentation str
Location of additional documentation for the APIs available on the Gateway instance
server_url str
Base URL that API consumers will use to access APIs on the Gateway instance.
title str
Title describing the context of the APIs available on the Gateway instance (default: Spring Cloud Gateway for K8S)
version str
Version of APIs available on this Gateway instance (default: unspecified).
description String
Detailed description of the APIs available on the Gateway instance (default: Generated OpenAPI 3 document that describes the API routes configured.)
documentation String
Location of additional documentation for the APIs available on the Gateway instance
serverUrl String
Base URL that API consumers will use to access APIs on the Gateway instance.
title String
Title describing the context of the APIs available on the Gateway instance (default: Spring Cloud Gateway for K8S)
version String
Version of APIs available on this Gateway instance (default: unspecified).

GatewayCorsPropertiesResponse

AllowCredentials bool
Whether user credentials are supported on cross-site requests. Valid values: true, false.
AllowedHeaders List<string>
Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
AllowedMethods List<string>
Allowed HTTP methods on cross-site requests. The special value * allows all methods. If not set, GET and HEAD are allowed by default.
AllowedOriginPatterns List<string>
Allowed origin patterns to make cross-site requests.
AllowedOrigins List<string>
Allowed origins to make cross-site requests. The special value * allows all domains.
ExposedHeaders List<string>
HTTP response headers to expose for cross-site requests.
MaxAge int
How long, in seconds, the response from a pre-flight request can be cached by clients.
AllowCredentials bool
Whether user credentials are supported on cross-site requests. Valid values: true, false.
AllowedHeaders []string
Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
AllowedMethods []string
Allowed HTTP methods on cross-site requests. The special value * allows all methods. If not set, GET and HEAD are allowed by default.
AllowedOriginPatterns []string
Allowed origin patterns to make cross-site requests.
AllowedOrigins []string
Allowed origins to make cross-site requests. The special value * allows all domains.
ExposedHeaders []string
HTTP response headers to expose for cross-site requests.
MaxAge int
How long, in seconds, the response from a pre-flight request can be cached by clients.
allowCredentials Boolean
Whether user credentials are supported on cross-site requests. Valid values: true, false.
allowedHeaders List<String>
Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
allowedMethods List<String>
Allowed HTTP methods on cross-site requests. The special value * allows all methods. If not set, GET and HEAD are allowed by default.
allowedOriginPatterns List<String>
Allowed origin patterns to make cross-site requests.
allowedOrigins List<String>
Allowed origins to make cross-site requests. The special value * allows all domains.
exposedHeaders List<String>
HTTP response headers to expose for cross-site requests.
maxAge Integer
How long, in seconds, the response from a pre-flight request can be cached by clients.
allowCredentials boolean
Whether user credentials are supported on cross-site requests. Valid values: true, false.
allowedHeaders string[]
Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
allowedMethods string[]
Allowed HTTP methods on cross-site requests. The special value * allows all methods. If not set, GET and HEAD are allowed by default.
allowedOriginPatterns string[]
Allowed origin patterns to make cross-site requests.
allowedOrigins string[]
Allowed origins to make cross-site requests. The special value * allows all domains.
exposedHeaders string[]
HTTP response headers to expose for cross-site requests.
maxAge number
How long, in seconds, the response from a pre-flight request can be cached by clients.
allow_credentials bool
Whether user credentials are supported on cross-site requests. Valid values: true, false.
allowed_headers Sequence[str]
Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
allowed_methods Sequence[str]
Allowed HTTP methods on cross-site requests. The special value * allows all methods. If not set, GET and HEAD are allowed by default.
allowed_origin_patterns Sequence[str]
Allowed origin patterns to make cross-site requests.
allowed_origins Sequence[str]
Allowed origins to make cross-site requests. The special value * allows all domains.
exposed_headers Sequence[str]
HTTP response headers to expose for cross-site requests.
max_age int
How long, in seconds, the response from a pre-flight request can be cached by clients.
allowCredentials Boolean
Whether user credentials are supported on cross-site requests. Valid values: true, false.
allowedHeaders List<String>
Allowed headers in cross-site requests. The special value * allows actual requests to send any header.
allowedMethods List<String>
Allowed HTTP methods on cross-site requests. The special value * allows all methods. If not set, GET and HEAD are allowed by default.
allowedOriginPatterns List<String>
Allowed origin patterns to make cross-site requests.
allowedOrigins List<String>
Allowed origins to make cross-site requests. The special value * allows all domains.
exposedHeaders List<String>
HTTP response headers to expose for cross-site requests.
maxAge Number
How long, in seconds, the response from a pre-flight request can be cached by clients.

GatewayInstanceResponse

Name This property is required. string
Name of the Spring Cloud Gateway instance
Status This property is required. string
Status of the Spring Cloud Gateway instance
Name This property is required. string
Name of the Spring Cloud Gateway instance
Status This property is required. string
Status of the Spring Cloud Gateway instance
name This property is required. String
Name of the Spring Cloud Gateway instance
status This property is required. String
Status of the Spring Cloud Gateway instance
name This property is required. string
Name of the Spring Cloud Gateway instance
status This property is required. string
Status of the Spring Cloud Gateway instance
name This property is required. str
Name of the Spring Cloud Gateway instance
status This property is required. str
Status of the Spring Cloud Gateway instance
name This property is required. String
Name of the Spring Cloud Gateway instance
status This property is required. String
Status of the Spring Cloud Gateway instance

GatewayLocalResponseCachePerInstancePropertiesResponse

Size string
Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries
TimeToLive string
Time before a cached entry is expired (300s, 5m, 1h...)
Size string
Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries
TimeToLive string
Time before a cached entry is expired (300s, 5m, 1h...)
size String
Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries
timeToLive String
Time before a cached entry is expired (300s, 5m, 1h...)
size string
Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries
timeToLive string
Time before a cached entry is expired (300s, 5m, 1h...)
size str
Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries
time_to_live str
Time before a cached entry is expired (300s, 5m, 1h...)
size String
Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries
timeToLive String
Time before a cached entry is expired (300s, 5m, 1h...)

GatewayLocalResponseCachePerRoutePropertiesResponse

Size string
Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
TimeToLive string
Time before a cached entry is expired (300s, 5m, 1h...)
Size string
Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
TimeToLive string
Time before a cached entry is expired (300s, 5m, 1h...)
size String
Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
timeToLive String
Time before a cached entry is expired (300s, 5m, 1h...)
size string
Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
timeToLive string
Time before a cached entry is expired (300s, 5m, 1h...)
size str
Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
time_to_live str
Time before a cached entry is expired (300s, 5m, 1h...)
size String
Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries.
timeToLive String
Time before a cached entry is expired (300s, 5m, 1h...)

GatewayOperatorPropertiesResponse

Instances This property is required. List<Pulumi.AzureNative.AppPlatform.Inputs.GatewayInstanceResponse>
Collection of instances belong to Spring Cloud Gateway operator.
ResourceRequests This property is required. Pulumi.AzureNative.AppPlatform.Inputs.GatewayOperatorResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
Instances This property is required. []GatewayInstanceResponse
Collection of instances belong to Spring Cloud Gateway operator.
ResourceRequests This property is required. GatewayOperatorResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
instances This property is required. List<GatewayInstanceResponse>
Collection of instances belong to Spring Cloud Gateway operator.
resourceRequests This property is required. GatewayOperatorResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
instances This property is required. GatewayInstanceResponse[]
Collection of instances belong to Spring Cloud Gateway operator.
resourceRequests This property is required. GatewayOperatorResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
instances This property is required. Sequence[GatewayInstanceResponse]
Collection of instances belong to Spring Cloud Gateway operator.
resource_requests This property is required. GatewayOperatorResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
instances This property is required. List<Property Map>
Collection of instances belong to Spring Cloud Gateway operator.
resourceRequests This property is required. Property Map
The requested resource quantity for required CPU and Memory.

GatewayOperatorResourceRequestsResponse

Cpu This property is required. string
Cpu allocated to each Spring Cloud Gateway Operator instance.
InstanceCount This property is required. int
Instance count of the Spring Cloud Gateway Operator.
Memory This property is required. string
Memory allocated to each Spring Cloud Gateway Operator instance.
Cpu This property is required. string
Cpu allocated to each Spring Cloud Gateway Operator instance.
InstanceCount This property is required. int
Instance count of the Spring Cloud Gateway Operator.
Memory This property is required. string
Memory allocated to each Spring Cloud Gateway Operator instance.
cpu This property is required. String
Cpu allocated to each Spring Cloud Gateway Operator instance.
instanceCount This property is required. Integer
Instance count of the Spring Cloud Gateway Operator.
memory This property is required. String
Memory allocated to each Spring Cloud Gateway Operator instance.
cpu This property is required. string
Cpu allocated to each Spring Cloud Gateway Operator instance.
instanceCount This property is required. number
Instance count of the Spring Cloud Gateway Operator.
memory This property is required. string
Memory allocated to each Spring Cloud Gateway Operator instance.
cpu This property is required. str
Cpu allocated to each Spring Cloud Gateway Operator instance.
instance_count This property is required. int
Instance count of the Spring Cloud Gateway Operator.
memory This property is required. str
Memory allocated to each Spring Cloud Gateway Operator instance.
cpu This property is required. String
Cpu allocated to each Spring Cloud Gateway Operator instance.
instanceCount This property is required. Number
Instance count of the Spring Cloud Gateway Operator.
memory This property is required. String
Memory allocated to each Spring Cloud Gateway Operator instance.

GatewayPropertiesResponse

Instances This property is required. List<Pulumi.AzureNative.AppPlatform.Inputs.GatewayInstanceResponse>
Collection of instances belong to Spring Cloud Gateway.
OperatorProperties This property is required. Pulumi.AzureNative.AppPlatform.Inputs.GatewayOperatorPropertiesResponse
Properties of the Spring Cloud Gateway Operator.
ProvisioningState This property is required. string
State of the Spring Cloud Gateway.
Url This property is required. string
URL of the Spring Cloud Gateway, exposed when 'public' is true.
AddonConfigs Dictionary<string, object>
Collection of addons for Spring Cloud Gateway
ApiMetadataProperties Pulumi.AzureNative.AppPlatform.Inputs.GatewayApiMetadataPropertiesResponse
API metadata property for Spring Cloud Gateway
ApmTypes List<string>
Collection of APM type used in Spring Cloud Gateway
Apms List<Pulumi.AzureNative.AppPlatform.Inputs.ApmReferenceResponse>
Collection of ApmReferences in service level
ClientAuth Pulumi.AzureNative.AppPlatform.Inputs.GatewayPropertiesResponseClientAuth
Client-Certification Authentication.
CorsProperties Pulumi.AzureNative.AppPlatform.Inputs.GatewayCorsPropertiesResponse
Cross-Origin Resource Sharing property
EnvironmentVariables Pulumi.AzureNative.AppPlatform.Inputs.GatewayPropertiesResponseEnvironmentVariables
Environment variables of Spring Cloud Gateway
HttpsOnly bool
Indicate if only https is allowed.
Public bool
Indicates whether the Spring Cloud Gateway exposes endpoint.
ResourceRequests Pulumi.AzureNative.AppPlatform.Inputs.GatewayResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
ResponseCacheProperties Pulumi.AzureNative.AppPlatform.Inputs.GatewayLocalResponseCachePerInstancePropertiesResponse | Pulumi.AzureNative.AppPlatform.Inputs.GatewayLocalResponseCachePerRoutePropertiesResponse
The properties to configure different types of response cache for Spring Cloud Gateway.
SsoProperties Pulumi.AzureNative.AppPlatform.Inputs.SsoPropertiesResponse
Single sign-on related configuration
Instances This property is required. []GatewayInstanceResponse
Collection of instances belong to Spring Cloud Gateway.
OperatorProperties This property is required. GatewayOperatorPropertiesResponse
Properties of the Spring Cloud Gateway Operator.
ProvisioningState This property is required. string
State of the Spring Cloud Gateway.
Url This property is required. string
URL of the Spring Cloud Gateway, exposed when 'public' is true.
AddonConfigs map[string]interface{}
Collection of addons for Spring Cloud Gateway
ApiMetadataProperties GatewayApiMetadataPropertiesResponse
API metadata property for Spring Cloud Gateway
ApmTypes []string
Collection of APM type used in Spring Cloud Gateway
Apms []ApmReferenceResponse
Collection of ApmReferences in service level
ClientAuth GatewayPropertiesResponseClientAuth
Client-Certification Authentication.
CorsProperties GatewayCorsPropertiesResponse
Cross-Origin Resource Sharing property
EnvironmentVariables GatewayPropertiesResponseEnvironmentVariables
Environment variables of Spring Cloud Gateway
HttpsOnly bool
Indicate if only https is allowed.
Public bool
Indicates whether the Spring Cloud Gateway exposes endpoint.
ResourceRequests GatewayResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
ResponseCacheProperties GatewayLocalResponseCachePerInstancePropertiesResponse | GatewayLocalResponseCachePerRoutePropertiesResponse
The properties to configure different types of response cache for Spring Cloud Gateway.
SsoProperties SsoPropertiesResponse
Single sign-on related configuration
instances This property is required. List<GatewayInstanceResponse>
Collection of instances belong to Spring Cloud Gateway.
operatorProperties This property is required. GatewayOperatorPropertiesResponse
Properties of the Spring Cloud Gateway Operator.
provisioningState This property is required. String
State of the Spring Cloud Gateway.
url This property is required. String
URL of the Spring Cloud Gateway, exposed when 'public' is true.
addonConfigs Map<String,Object>
Collection of addons for Spring Cloud Gateway
apiMetadataProperties GatewayApiMetadataPropertiesResponse
API metadata property for Spring Cloud Gateway
apmTypes List<String>
Collection of APM type used in Spring Cloud Gateway
apms List<ApmReferenceResponse>
Collection of ApmReferences in service level
clientAuth GatewayPropertiesResponseClientAuth
Client-Certification Authentication.
corsProperties GatewayCorsPropertiesResponse
Cross-Origin Resource Sharing property
environmentVariables GatewayPropertiesResponseEnvironmentVariables
Environment variables of Spring Cloud Gateway
httpsOnly Boolean
Indicate if only https is allowed.
public_ Boolean
Indicates whether the Spring Cloud Gateway exposes endpoint.
resourceRequests GatewayResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
responseCacheProperties GatewayLocalResponseCachePerInstancePropertiesResponse | GatewayLocalResponseCachePerRoutePropertiesResponse
The properties to configure different types of response cache for Spring Cloud Gateway.
ssoProperties SsoPropertiesResponse
Single sign-on related configuration
instances This property is required. GatewayInstanceResponse[]
Collection of instances belong to Spring Cloud Gateway.
operatorProperties This property is required. GatewayOperatorPropertiesResponse
Properties of the Spring Cloud Gateway Operator.
provisioningState This property is required. string
State of the Spring Cloud Gateway.
url This property is required. string
URL of the Spring Cloud Gateway, exposed when 'public' is true.
addonConfigs {[key: string]: any}
Collection of addons for Spring Cloud Gateway
apiMetadataProperties GatewayApiMetadataPropertiesResponse
API metadata property for Spring Cloud Gateway
apmTypes string[]
Collection of APM type used in Spring Cloud Gateway
apms ApmReferenceResponse[]
Collection of ApmReferences in service level
clientAuth GatewayPropertiesResponseClientAuth
Client-Certification Authentication.
corsProperties GatewayCorsPropertiesResponse
Cross-Origin Resource Sharing property
environmentVariables GatewayPropertiesResponseEnvironmentVariables
Environment variables of Spring Cloud Gateway
httpsOnly boolean
Indicate if only https is allowed.
public boolean
Indicates whether the Spring Cloud Gateway exposes endpoint.
resourceRequests GatewayResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
responseCacheProperties GatewayLocalResponseCachePerInstancePropertiesResponse | GatewayLocalResponseCachePerRoutePropertiesResponse
The properties to configure different types of response cache for Spring Cloud Gateway.
ssoProperties SsoPropertiesResponse
Single sign-on related configuration
instances This property is required. Sequence[GatewayInstanceResponse]
Collection of instances belong to Spring Cloud Gateway.
operator_properties This property is required. GatewayOperatorPropertiesResponse
Properties of the Spring Cloud Gateway Operator.
provisioning_state This property is required. str
State of the Spring Cloud Gateway.
url This property is required. str
URL of the Spring Cloud Gateway, exposed when 'public' is true.
addon_configs Mapping[str, Any]
Collection of addons for Spring Cloud Gateway
api_metadata_properties GatewayApiMetadataPropertiesResponse
API metadata property for Spring Cloud Gateway
apm_types Sequence[str]
Collection of APM type used in Spring Cloud Gateway
apms Sequence[ApmReferenceResponse]
Collection of ApmReferences in service level
client_auth GatewayPropertiesResponseClientAuth
Client-Certification Authentication.
cors_properties GatewayCorsPropertiesResponse
Cross-Origin Resource Sharing property
environment_variables GatewayPropertiesResponseEnvironmentVariables
Environment variables of Spring Cloud Gateway
https_only bool
Indicate if only https is allowed.
public bool
Indicates whether the Spring Cloud Gateway exposes endpoint.
resource_requests GatewayResourceRequestsResponse
The requested resource quantity for required CPU and Memory.
response_cache_properties GatewayLocalResponseCachePerInstancePropertiesResponse | GatewayLocalResponseCachePerRoutePropertiesResponse
The properties to configure different types of response cache for Spring Cloud Gateway.
sso_properties SsoPropertiesResponse
Single sign-on related configuration
instances This property is required. List<Property Map>
Collection of instances belong to Spring Cloud Gateway.
operatorProperties This property is required. Property Map
Properties of the Spring Cloud Gateway Operator.
provisioningState This property is required. String
State of the Spring Cloud Gateway.
url This property is required. String
URL of the Spring Cloud Gateway, exposed when 'public' is true.
addonConfigs Map<Any>
Collection of addons for Spring Cloud Gateway
apiMetadataProperties Property Map
API metadata property for Spring Cloud Gateway
apmTypes List<String>
Collection of APM type used in Spring Cloud Gateway
apms List<Property Map>
Collection of ApmReferences in service level
clientAuth Property Map
Client-Certification Authentication.
corsProperties Property Map
Cross-Origin Resource Sharing property
environmentVariables Property Map
Environment variables of Spring Cloud Gateway
httpsOnly Boolean
Indicate if only https is allowed.
public Boolean
Indicates whether the Spring Cloud Gateway exposes endpoint.
resourceRequests Property Map
The requested resource quantity for required CPU and Memory.
responseCacheProperties Property Map | Property Map
The properties to configure different types of response cache for Spring Cloud Gateway.
ssoProperties Property Map
Single sign-on related configuration

GatewayPropertiesResponseClientAuth

CertificateVerification string
Whether to enable certificate verification or not
Certificates List<string>
Collection of certificate resource Ids in Azure Spring Apps.
CertificateVerification string
Whether to enable certificate verification or not
Certificates []string
Collection of certificate resource Ids in Azure Spring Apps.
certificateVerification String
Whether to enable certificate verification or not
certificates List<String>
Collection of certificate resource Ids in Azure Spring Apps.
certificateVerification string
Whether to enable certificate verification or not
certificates string[]
Collection of certificate resource Ids in Azure Spring Apps.
certificate_verification str
Whether to enable certificate verification or not
certificates Sequence[str]
Collection of certificate resource Ids in Azure Spring Apps.
certificateVerification String
Whether to enable certificate verification or not
certificates List<String>
Collection of certificate resource Ids in Azure Spring Apps.

GatewayPropertiesResponseEnvironmentVariables

Properties Dictionary<string, string>
Non-sensitive properties
Secrets Dictionary<string, string>
Sensitive properties
Properties map[string]string
Non-sensitive properties
Secrets map[string]string
Sensitive properties
properties Map<String,String>
Non-sensitive properties
secrets Map<String,String>
Sensitive properties
properties {[key: string]: string}
Non-sensitive properties
secrets {[key: string]: string}
Sensitive properties
properties Mapping[str, str]
Non-sensitive properties
secrets Mapping[str, str]
Sensitive properties
properties Map<String>
Non-sensitive properties
secrets Map<String>
Sensitive properties

GatewayResourceRequestsResponse

Cpu string
Cpu allocated to each Spring Cloud Gateway instance.
Memory string
Memory allocated to each Spring Cloud Gateway instance.
Cpu string
Cpu allocated to each Spring Cloud Gateway instance.
Memory string
Memory allocated to each Spring Cloud Gateway instance.
cpu String
Cpu allocated to each Spring Cloud Gateway instance.
memory String
Memory allocated to each Spring Cloud Gateway instance.
cpu string
Cpu allocated to each Spring Cloud Gateway instance.
memory string
Memory allocated to each Spring Cloud Gateway instance.
cpu str
Cpu allocated to each Spring Cloud Gateway instance.
memory str
Memory allocated to each Spring Cloud Gateway instance.
cpu String
Cpu allocated to each Spring Cloud Gateway instance.
memory String
Memory allocated to each Spring Cloud Gateway instance.

SkuResponse

Capacity int
Current capacity of the target resource
Name string
Name of the Sku
Tier string
Tier of the Sku
Capacity int
Current capacity of the target resource
Name string
Name of the Sku
Tier string
Tier of the Sku
capacity Integer
Current capacity of the target resource
name String
Name of the Sku
tier String
Tier of the Sku
capacity number
Current capacity of the target resource
name string
Name of the Sku
tier string
Tier of the Sku
capacity int
Current capacity of the target resource
name str
Name of the Sku
tier str
Tier of the Sku
capacity Number
Current capacity of the target resource
name String
Name of the Sku
tier String
Tier of the Sku

SsoPropertiesResponse

ClientId string
The public identifier for the application
ClientSecret string
The secret known only to the application and the authorization server
IssuerUri string
The URI of Issuer Identifier
Scope List<string>
It defines the specific actions applications can be allowed to do on a user's behalf
ClientId string
The public identifier for the application
ClientSecret string
The secret known only to the application and the authorization server
IssuerUri string
The URI of Issuer Identifier
Scope []string
It defines the specific actions applications can be allowed to do on a user's behalf
clientId String
The public identifier for the application
clientSecret String
The secret known only to the application and the authorization server
issuerUri String
The URI of Issuer Identifier
scope List<String>
It defines the specific actions applications can be allowed to do on a user's behalf
clientId string
The public identifier for the application
clientSecret string
The secret known only to the application and the authorization server
issuerUri string
The URI of Issuer Identifier
scope string[]
It defines the specific actions applications can be allowed to do on a user's behalf
client_id str
The public identifier for the application
client_secret str
The secret known only to the application and the authorization server
issuer_uri str
The URI of Issuer Identifier
scope Sequence[str]
It defines the specific actions applications can be allowed to do on a user's behalf
clientId String
The public identifier for the application
clientSecret String
The secret known only to the application and the authorization server
issuerUri String
The URI of Issuer Identifier
scope List<String>
It defines the specific actions applications can be allowed to do on a user's behalf

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource modification (UTC).
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource modification (UTC).
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource modification (UTC).
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource modification (UTC).
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource modification (UTC).
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource modification (UTC).
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi