This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.71.0 published on Friday, Nov 8, 2024 by Pulumi
azure-native.apimanagement.getApiGateway
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.71.0 published on Friday, Nov 8, 2024 by Pulumi
Gets an API Management gateway resource description. Azure REST API version: 2023-09-01-preview.
Other available API versions: 2024-05-01.
Using getApiGateway
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 getApiGateway(args: GetApiGatewayArgs, opts?: InvokeOptions): Promise<GetApiGatewayResult>
function getApiGatewayOutput(args: GetApiGatewayOutputArgs, opts?: InvokeOptions): Output<GetApiGatewayResult>
def get_api_gateway(gateway_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetApiGatewayResult
def get_api_gateway_output(gateway_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetApiGatewayResult]
func LookupApiGateway(ctx *Context, args *LookupApiGatewayArgs, opts ...InvokeOption) (*LookupApiGatewayResult, error)
func LookupApiGatewayOutput(ctx *Context, args *LookupApiGatewayOutputArgs, opts ...InvokeOption) LookupApiGatewayResultOutput
> Note: This function is named LookupApiGateway
in the Go SDK.
public static class GetApiGateway
{
public static Task<GetApiGatewayResult> InvokeAsync(GetApiGatewayArgs args, InvokeOptions? opts = null)
public static Output<GetApiGatewayResult> Invoke(GetApiGatewayInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetApiGatewayResult> getApiGateway(GetApiGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:apimanagement:getApiGateway
arguments:
# arguments dictionary
The following arguments are supported:
- Gateway
Name string - The name of the API Management gateway.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Gateway
Name string - The name of the API Management gateway.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- gateway
Name String - The name of the API Management gateway.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- gateway
Name string - The name of the API Management gateway.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- gateway_
name str - The name of the API Management gateway.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- gateway
Name String - The name of the API Management gateway.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getApiGateway Result
The following output properties are available:
- Created
At stringUtc - Creation UTC date of the API Management gateway.The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZ
as specified by the ISO 8601 standard. - Etag string
- ETag of the resource.
- Id string
- Resource ID.
- Location string
- Resource location.
- Name string
- Resource name.
- Provisioning
State string - The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
- Sku
Pulumi.
Azure Native. Api Management. Outputs. Api Management Gateway Sku Properties Response - SKU properties of the API Management gateway.
- System
Data Pulumi.Azure Native. Api Management. Outputs. System Data Response - Metadata pertaining to creation and last modification of the resource.
- Target
Provisioning stringState - The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
- Type string
- Resource type for API Management resource is set to Microsoft.ApiManagement.
- Backend
Pulumi.
Azure Native. Api Management. Outputs. Backend Configuration Response - Information regarding how the gateway should integrate with backend systems.
- Configuration
Api Pulumi.Azure Native. Api Management. Outputs. Gateway Configuration Api Response - Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
- Frontend
Pulumi.
Azure Native. Api Management. Outputs. Frontend Configuration Response - Information regarding how the gateway should be exposed.
- Dictionary<string, string>
- Resource tags.
- Virtual
Network stringType - The type of VPN in which API Management gateway needs to be configured in.
- Created
At stringUtc - Creation UTC date of the API Management gateway.The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZ
as specified by the ISO 8601 standard. - Etag string
- ETag of the resource.
- Id string
- Resource ID.
- Location string
- Resource location.
- Name string
- Resource name.
- Provisioning
State string - The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
- Sku
Api
Management Gateway Sku Properties Response - SKU properties of the API Management gateway.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- Target
Provisioning stringState - The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
- Type string
- Resource type for API Management resource is set to Microsoft.ApiManagement.
- Backend
Backend
Configuration Response - Information regarding how the gateway should integrate with backend systems.
- Configuration
Api GatewayConfiguration Api Response - Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
- Frontend
Frontend
Configuration Response - Information regarding how the gateway should be exposed.
- map[string]string
- Resource tags.
- Virtual
Network stringType - The type of VPN in which API Management gateway needs to be configured in.
- created
At StringUtc - Creation UTC date of the API Management gateway.The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZ
as specified by the ISO 8601 standard. - etag String
- ETag of the resource.
- id String
- Resource ID.
- location String
- Resource location.
- name String
- Resource name.
- provisioning
State String - The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
- sku
Api
Management Gateway Sku Properties Response - SKU properties of the API Management gateway.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- target
Provisioning StringState - The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
- type String
- Resource type for API Management resource is set to Microsoft.ApiManagement.
- backend
Backend
Configuration Response - Information regarding how the gateway should integrate with backend systems.
- configuration
Api GatewayConfiguration Api Response - Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
- frontend
Frontend
Configuration Response - Information regarding how the gateway should be exposed.
- Map<String,String>
- Resource tags.
- virtual
Network StringType - The type of VPN in which API Management gateway needs to be configured in.
- created
At stringUtc - Creation UTC date of the API Management gateway.The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZ
as specified by the ISO 8601 standard. - etag string
- ETag of the resource.
- id string
- Resource ID.
- location string
- Resource location.
- name string
- Resource name.
- provisioning
State string - The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
- sku
Api
Management Gateway Sku Properties Response - SKU properties of the API Management gateway.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- target
Provisioning stringState - The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
- type string
- Resource type for API Management resource is set to Microsoft.ApiManagement.
- backend
Backend
Configuration Response - Information regarding how the gateway should integrate with backend systems.
- configuration
Api GatewayConfiguration Api Response - Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
- frontend
Frontend
Configuration Response - Information regarding how the gateway should be exposed.
- {[key: string]: string}
- Resource tags.
- virtual
Network stringType - The type of VPN in which API Management gateway needs to be configured in.
- created_
at_ strutc - Creation UTC date of the API Management gateway.The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZ
as specified by the ISO 8601 standard. - etag str
- ETag of the resource.
- id str
- Resource ID.
- location str
- Resource location.
- name str
- Resource name.
- provisioning_
state str - The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
- sku
Api
Management Gateway Sku Properties Response - SKU properties of the API Management gateway.
- system_
data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- target_
provisioning_ strstate - The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
- type str
- Resource type for API Management resource is set to Microsoft.ApiManagement.
- backend
Backend
Configuration Response - Information regarding how the gateway should integrate with backend systems.
- configuration_
api GatewayConfiguration Api Response - Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
- frontend
Frontend
Configuration Response - Information regarding how the gateway should be exposed.
- Mapping[str, str]
- Resource tags.
- virtual_
network_ strtype - The type of VPN in which API Management gateway needs to be configured in.
- created
At StringUtc - Creation UTC date of the API Management gateway.The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZ
as specified by the ISO 8601 standard. - etag String
- ETag of the resource.
- id String
- Resource ID.
- location String
- Resource location.
- name String
- Resource name.
- provisioning
State String - The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
- sku Property Map
- SKU properties of the API Management gateway.
- system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
- target
Provisioning StringState - The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
- type String
- Resource type for API Management resource is set to Microsoft.ApiManagement.
- backend Property Map
- Information regarding how the gateway should integrate with backend systems.
- configuration
Api Property Map - Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
- frontend Property Map
- Information regarding how the gateway should be exposed.
- Map<String>
- Resource tags.
- virtual
Network StringType - The type of VPN in which API Management gateway needs to be configured in.
Supporting Types
ApiManagementGatewaySkuPropertiesResponse
BackendConfigurationResponse
- Subnet
Pulumi.
Azure Native. Api Management. Inputs. Backend Subnet Configuration Response - The default hostname of the data-plane gateway to which requests can be sent.
- Subnet
Backend
Subnet Configuration Response - The default hostname of the data-plane gateway to which requests can be sent.
- subnet
Backend
Subnet Configuration Response - The default hostname of the data-plane gateway to which requests can be sent.
- subnet
Backend
Subnet Configuration Response - The default hostname of the data-plane gateway to which requests can be sent.
- subnet
Backend
Subnet Configuration Response - The default hostname of the data-plane gateway to which requests can be sent.
- subnet Property Map
- The default hostname of the data-plane gateway to which requests can be sent.
BackendSubnetConfigurationResponse
- Id string
- The ARM ID of the subnet in which the backend systems are hosted.
- Id string
- The ARM ID of the subnet in which the backend systems are hosted.
- id String
- The ARM ID of the subnet in which the backend systems are hosted.
- id string
- The ARM ID of the subnet in which the backend systems are hosted.
- id str
- The ARM ID of the subnet in which the backend systems are hosted.
- id String
- The ARM ID of the subnet in which the backend systems are hosted.
FrontendConfigurationResponse
- Default
Hostname string - The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
- Default
Hostname string - The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
- default
Hostname String - The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
- default
Hostname string - The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
- default_
hostname str - The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
- default
Hostname String - The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU.
GatewayConfigurationApiResponse
- Hostname string
- Hostname to which the agent connects to propagate configuration to the cloud.
- Hostname string
- Hostname to which the agent connects to propagate configuration to the cloud.
- hostname String
- Hostname to which the agent connects to propagate configuration to the cloud.
- hostname string
- Hostname to which the agent connects to propagate configuration to the cloud.
- hostname str
- Hostname to which the agent connects to propagate configuration to the cloud.
- hostname String
- Hostname to which the agent connects to propagate configuration to the cloud.
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 pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.71.0 published on Friday, Nov 8, 2024 by Pulumi