These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
azure-native.appplatform.getGateway
Explore with Pulumi AI
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
Get the Spring Cloud Gateway and its properties. API Version: 2022-01-01-preview.
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>
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]
func LookupGateway(ctx *Context, args *LookupGatewayArgs, opts ...InvokeOption) (*LookupGatewayResult, error)
func LookupGatewayOutput(ctx *Context, args *LookupGatewayOutputArgs, opts ...InvokeOption) LookupGatewayResultOutput
> 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)
}
public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:appplatform:getGateway
arguments:
# arguments dictionary
The following arguments are supported:
- Gateway
Name string - The name of Spring Cloud Gateway.
- Resource
Group stringName - 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 string - The name of the Service resource.
- Gateway
Name string - The name of Spring Cloud Gateway.
- Resource
Group stringName - 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 string - The name of the Service resource.
- gateway
Name String - The name of Spring Cloud Gateway.
- resource
Group StringName - 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 String - The name of the Service resource.
- gateway
Name string - The name of Spring Cloud Gateway.
- resource
Group stringName - 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 string - The name of the Service resource.
- gateway_
name str - The name of Spring Cloud Gateway.
- resource_
group_ strname - 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 str - The name of the Service resource.
- gateway
Name String - The name of Spring Cloud Gateway.
- resource
Group StringName - 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 String - The name of the Service resource.
getGateway Result
The following output properties are available:
- Id string
- Fully qualified resource Id for the resource.
- Name string
- The name of the resource.
- Properties
Pulumi.
Azure Native. App Platform. Outputs. Gateway Properties Response - Spring Cloud Gateway properties payload
- System
Data Pulumi.Azure Native. App Platform. Outputs. System Data Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- The type of the resource.
- Sku
Pulumi.
Azure Native. App Platform. Outputs. Sku Response - Sku of the Spring Cloud Gateway resource
- Id string
- Fully qualified resource Id for the resource.
- Name string
- The name of the resource.
- Properties
Gateway
Properties Response - Spring Cloud Gateway properties payload
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- The type of the resource.
- Sku
Sku
Response - Sku of the Spring Cloud Gateway resource
- id String
- Fully qualified resource Id for the resource.
- name String
- The name of the resource.
- properties
Gateway
Properties Response - Spring Cloud Gateway properties payload
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the resource.
- sku
Sku
Response - Sku of the Spring Cloud Gateway resource
- id string
- Fully qualified resource Id for the resource.
- name string
- The name of the resource.
- properties
Gateway
Properties Response - Spring Cloud Gateway properties payload
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type string
- The type of the resource.
- sku
Sku
Response - Sku of the Spring Cloud Gateway resource
- id str
- Fully qualified resource Id for the resource.
- name str
- The name of the resource.
- properties
Gateway
Properties Response - Spring Cloud Gateway properties payload
- system_
data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type str
- The type of the resource.
- sku
Sku
Response - Sku of the Spring Cloud Gateway 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
- system
Data 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
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
- Server
Url 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
- Server
Url 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
- server
Url 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
- server
Url 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
- server
Url 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
- Allow
Credentials bool - Whether user credentials are supported on cross-site requests. Valid values:
true
,false
. - Allowed
Headers List<string> - Allowed headers in cross-site requests. The special value
*
allows actual requests to send any header. - Allowed
Methods List<string> - Allowed HTTP methods on cross-site requests. The special value
*
allows all methods. If not set,GET
andHEAD
are allowed by default. - Allowed
Origins List<string> - Allowed origins to make cross-site requests. The special value
*
allows all domains. - Exposed
Headers List<string> - 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.
- Allow
Credentials bool - Whether user credentials are supported on cross-site requests. Valid values:
true
,false
. - Allowed
Headers []string - Allowed headers in cross-site requests. The special value
*
allows actual requests to send any header. - Allowed
Methods []string - Allowed HTTP methods on cross-site requests. The special value
*
allows all methods. If not set,GET
andHEAD
are allowed by default. - Allowed
Origins []string - Allowed origins to make cross-site requests. The special value
*
allows all domains. - Exposed
Headers []string - 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.
- allow
Credentials Boolean - Whether user credentials are supported on cross-site requests. Valid values:
true
,false
. - allowed
Headers List<String> - Allowed headers in cross-site requests. The special value
*
allows actual requests to send any header. - allowed
Methods List<String> - Allowed HTTP methods on cross-site requests. The special value
*
allows all methods. If not set,GET
andHEAD
are allowed by default. - allowed
Origins List<String> - Allowed origins to make cross-site requests. The special value
*
allows all domains. - exposed
Headers List<String> - HTTP response headers to expose for cross-site requests.
- max
Age Integer - How long, in seconds, the response from a pre-flight request can be cached by clients.
- allow
Credentials boolean - Whether user credentials are supported on cross-site requests. Valid values:
true
,false
. - allowed
Headers string[] - Allowed headers in cross-site requests. The special value
*
allows actual requests to send any header. - allowed
Methods string[] - Allowed HTTP methods on cross-site requests. The special value
*
allows all methods. If not set,GET
andHEAD
are allowed by default. - allowed
Origins string[] - Allowed origins to make cross-site requests. The special value
*
allows all domains. - exposed
Headers string[] - HTTP response headers to expose for cross-site requests.
- max
Age 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
andHEAD
are allowed by default. - 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.
- allow
Credentials Boolean - Whether user credentials are supported on cross-site requests. Valid values:
true
,false
. - allowed
Headers List<String> - Allowed headers in cross-site requests. The special value
*
allows actual requests to send any header. - allowed
Methods List<String> - Allowed HTTP methods on cross-site requests. The special value
*
allows all methods. If not set,GET
andHEAD
are allowed by default. - allowed
Origins List<String> - Allowed origins to make cross-site requests. The special value
*
allows all domains. - exposed
Headers List<String> - HTTP response headers to expose for cross-site requests.
- max
Age Number - How long, in seconds, the response from a pre-flight request can be cached by clients.
GatewayInstanceResponse
GatewayOperatorPropertiesResponse
- Instances
List<Pulumi.
Azure Native. App Platform. Inputs. Gateway Instance Response> - Collection of instances belong to Spring Cloud Gateway operator.
- Resource
Requests Pulumi.Azure Native. App Platform. Inputs. Gateway Operator Resource Requests Response - The requested resource quantity for required CPU and Memory.
- Instances
[]Gateway
Instance Response - Collection of instances belong to Spring Cloud Gateway operator.
- Resource
Requests GatewayOperator Resource Requests Response - The requested resource quantity for required CPU and Memory.
- instances
List<Gateway
Instance Response> - Collection of instances belong to Spring Cloud Gateway operator.
- resource
Requests GatewayOperator Resource Requests Response - The requested resource quantity for required CPU and Memory.
- instances
Gateway
Instance Response[] - Collection of instances belong to Spring Cloud Gateway operator.
- resource
Requests GatewayOperator Resource Requests Response - The requested resource quantity for required CPU and Memory.
- instances
Sequence[Gateway
Instance Response] - Collection of instances belong to Spring Cloud Gateway operator.
- resource_
requests GatewayOperator Resource Requests Response - The requested resource quantity for required CPU and Memory.
- instances List<Property Map>
- Collection of instances belong to Spring Cloud Gateway operator.
- resource
Requests Property Map - The requested resource quantity for required CPU and Memory.
GatewayOperatorResourceRequestsResponse
- Cpu string
- Cpu allocated to each Spring Cloud Gateway Operator instance.
- Instance
Count int - Instance count of the Spring Cloud Gateway Operator.
- Memory string
- Memory allocated to each Spring Cloud Gateway Operator instance.
- Cpu string
- Cpu allocated to each Spring Cloud Gateway Operator instance.
- Instance
Count int - Instance count of the Spring Cloud Gateway Operator.
- Memory string
- Memory allocated to each Spring Cloud Gateway Operator instance.
- cpu String
- Cpu allocated to each Spring Cloud Gateway Operator instance.
- instance
Count Integer - Instance count of the Spring Cloud Gateway Operator.
- memory String
- Memory allocated to each Spring Cloud Gateway Operator instance.
- cpu string
- Cpu allocated to each Spring Cloud Gateway Operator instance.
- instance
Count number - Instance count of the Spring Cloud Gateway Operator.
- memory string
- Memory allocated to each Spring Cloud Gateway Operator instance.
- cpu str
- Cpu allocated to each Spring Cloud Gateway Operator instance.
- instance_
count int - Instance count of the Spring Cloud Gateway Operator.
- memory str
- Memory allocated to each Spring Cloud Gateway Operator instance.
- cpu String
- Cpu allocated to each Spring Cloud Gateway Operator instance.
- instance
Count Number - Instance count of the Spring Cloud Gateway Operator.
- memory String
- Memory allocated to each Spring Cloud Gateway Operator instance.
GatewayPropertiesResponse
- Instances
List<Pulumi.
Azure Native. App Platform. Inputs. Gateway Instance Response> - Collection of instances belong to Spring Cloud Gateway.
- Operator
Properties Pulumi.Azure Native. App Platform. Inputs. Gateway Operator Properties Response - Properties of the Spring Cloud Gateway Operator.
- Provisioning
State string - State of the Spring Cloud Gateway.
- Url string
- URL of the Spring Cloud Gateway, exposed when 'public' is true.
- Api
Metadata Pulumi.Properties Azure Native. App Platform. Inputs. Gateway Api Metadata Properties Response - API metadata property for Spring Cloud Gateway
- Cors
Properties Pulumi.Azure Native. App Platform. Inputs. Gateway Cors Properties Response - Cross-Origin Resource Sharing property
- Https
Only bool - Indicate if only https is allowed.
- Public bool
- Indicates whether the Spring Cloud Gateway exposes endpoint.
- Resource
Requests Pulumi.Azure Native. App Platform. Inputs. Gateway Resource Requests Response - The requested resource quantity for required CPU and Memory.
- Sso
Properties Pulumi.Azure Native. App Platform. Inputs. Sso Properties Response - Single sign-on related configuration
- Instances
[]Gateway
Instance Response - Collection of instances belong to Spring Cloud Gateway.
- Operator
Properties GatewayOperator Properties Response - Properties of the Spring Cloud Gateway Operator.
- Provisioning
State string - State of the Spring Cloud Gateway.
- Url string
- URL of the Spring Cloud Gateway, exposed when 'public' is true.
- Api
Metadata GatewayProperties Api Metadata Properties Response - API metadata property for Spring Cloud Gateway
- Cors
Properties GatewayCors Properties Response - Cross-Origin Resource Sharing property
- Https
Only bool - Indicate if only https is allowed.
- Public bool
- Indicates whether the Spring Cloud Gateway exposes endpoint.
- Resource
Requests GatewayResource Requests Response - The requested resource quantity for required CPU and Memory.
- Sso
Properties SsoProperties Response - Single sign-on related configuration
- instances
List<Gateway
Instance Response> - Collection of instances belong to Spring Cloud Gateway.
- operator
Properties GatewayOperator Properties Response - Properties of the Spring Cloud Gateway Operator.
- provisioning
State String - State of the Spring Cloud Gateway.
- url String
- URL of the Spring Cloud Gateway, exposed when 'public' is true.
- api
Metadata GatewayProperties Api Metadata Properties Response - API metadata property for Spring Cloud Gateway
- cors
Properties GatewayCors Properties Response - Cross-Origin Resource Sharing property
- https
Only Boolean - Indicate if only https is allowed.
- public_ Boolean
- Indicates whether the Spring Cloud Gateway exposes endpoint.
- resource
Requests GatewayResource Requests Response - The requested resource quantity for required CPU and Memory.
- sso
Properties SsoProperties Response - Single sign-on related configuration
- instances
Gateway
Instance Response[] - Collection of instances belong to Spring Cloud Gateway.
- operator
Properties GatewayOperator Properties Response - Properties of the Spring Cloud Gateway Operator.
- provisioning
State string - State of the Spring Cloud Gateway.
- url string
- URL of the Spring Cloud Gateway, exposed when 'public' is true.
- api
Metadata GatewayProperties Api Metadata Properties Response - API metadata property for Spring Cloud Gateway
- cors
Properties GatewayCors Properties Response - Cross-Origin Resource Sharing property
- https
Only boolean - Indicate if only https is allowed.
- public boolean
- Indicates whether the Spring Cloud Gateway exposes endpoint.
- resource
Requests GatewayResource Requests Response - The requested resource quantity for required CPU and Memory.
- sso
Properties SsoProperties Response - Single sign-on related configuration
- instances
Sequence[Gateway
Instance Response] - Collection of instances belong to Spring Cloud Gateway.
- operator_
properties GatewayOperator Properties Response - Properties of the Spring Cloud Gateway Operator.
- provisioning_
state str - State of the Spring Cloud Gateway.
- url str
- URL of the Spring Cloud Gateway, exposed when 'public' is true.
- api_
metadata_ Gatewayproperties Api Metadata Properties Response - API metadata property for Spring Cloud Gateway
- cors_
properties GatewayCors Properties Response - Cross-Origin Resource Sharing property
- https_
only bool - Indicate if only https is allowed.
- public bool
- Indicates whether the Spring Cloud Gateway exposes endpoint.
- resource_
requests GatewayResource Requests Response - The requested resource quantity for required CPU and Memory.
- sso_
properties SsoProperties Response - Single sign-on related configuration
- instances List<Property Map>
- Collection of instances belong to Spring Cloud Gateway.
- operator
Properties Property Map - Properties of the Spring Cloud Gateway Operator.
- provisioning
State String - State of the Spring Cloud Gateway.
- url String
- URL of the Spring Cloud Gateway, exposed when 'public' is true.
- api
Metadata Property MapProperties - API metadata property for Spring Cloud Gateway
- cors
Properties Property Map - Cross-Origin Resource Sharing property
- https
Only Boolean - Indicate if only https is allowed.
- public Boolean
- Indicates whether the Spring Cloud Gateway exposes endpoint.
- resource
Requests Property Map - The requested resource quantity for required CPU and Memory.
- sso
Properties Property Map - Single sign-on related configuration
GatewayResourceRequestsResponse
SkuResponse
SsoPropertiesResponse
- Client
Id string - The public identifier for the application
- Client
Secret string - The secret known only to the application and the authorization server
- Issuer
Uri 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
- Client
Id string - The public identifier for the application
- Client
Secret string - The secret known only to the application and the authorization server
- Issuer
Uri 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 String - The public identifier for the application
- client
Secret String - The secret known only to the application and the authorization server
- issuer
Uri 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
- client
Id string - The public identifier for the application
- client
Secret string - The secret known only to the application and the authorization server
- issuer
Uri 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
- client
Id String - The public identifier for the application
- client
Secret String - The secret known only to the application and the authorization server
- issuer
Uri 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
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi