azure-native.apimanagement.ApiGateway
Explore with Pulumi AI
A single API Management gateway resource in List or Get response. Azure REST API version: 2023-09-01-preview.
Other available API versions: 2024-05-01.
Example Usage
ApiManagementCreateStandardGateway
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiGateway = new AzureNative.ApiManagement.ApiGateway("apiGateway", new()
{
Backend = new AzureNative.ApiManagement.Inputs.BackendConfigurationArgs
{
Subnet = new AzureNative.ApiManagement.Inputs.BackendSubnetConfigurationArgs
{
Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
},
},
GatewayName = "apimGateway1",
Location = "South Central US",
ResourceGroupName = "rg1",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementGatewaySkuPropertiesArgs
{
Capacity = 1,
Name = AzureNative.ApiManagement.SkuType.Standard,
},
Tags =
{
{ "Name", "Contoso" },
{ "Test", "User" },
},
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewApiGateway(ctx, "apiGateway", &apimanagement.ApiGatewayArgs{
Backend: &apimanagement.BackendConfigurationArgs{
Subnet: &apimanagement.BackendSubnetConfigurationArgs{
Id: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"),
},
},
GatewayName: pulumi.String("apimGateway1"),
Location: pulumi.String("South Central US"),
ResourceGroupName: pulumi.String("rg1"),
Sku: &apimanagement.ApiManagementGatewaySkuPropertiesArgs{
Capacity: pulumi.Int(1),
Name: pulumi.String(apimanagement.SkuTypeStandard),
},
Tags: pulumi.StringMap{
"Name": pulumi.String("Contoso"),
"Test": pulumi.String("User"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.ApiGateway;
import com.pulumi.azurenative.apimanagement.ApiGatewayArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendConfigurationArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendSubnetConfigurationArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementGatewaySkuPropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var apiGateway = new ApiGateway("apiGateway", ApiGatewayArgs.builder()
.backend(BackendConfigurationArgs.builder()
.subnet(BackendSubnetConfigurationArgs.builder()
.id("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1")
.build())
.build())
.gatewayName("apimGateway1")
.location("South Central US")
.resourceGroupName("rg1")
.sku(ApiManagementGatewaySkuPropertiesArgs.builder()
.capacity(1)
.name("Standard")
.build())
.tags(Map.ofEntries(
Map.entry("Name", "Contoso"),
Map.entry("Test", "User")
))
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
api_gateway = azure_native.apimanagement.ApiGateway("apiGateway",
backend={
"subnet": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
},
},
gateway_name="apimGateway1",
location="South Central US",
resource_group_name="rg1",
sku={
"capacity": 1,
"name": azure_native.apimanagement.SkuType.STANDARD,
},
tags={
"Name": "Contoso",
"Test": "User",
})
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiGateway = new azure_native.apimanagement.ApiGateway("apiGateway", {
backend: {
subnet: {
id: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
},
},
gatewayName: "apimGateway1",
location: "South Central US",
resourceGroupName: "rg1",
sku: {
capacity: 1,
name: azure_native.apimanagement.SkuType.Standard,
},
tags: {
Name: "Contoso",
Test: "User",
},
});
resources:
apiGateway:
type: azure-native:apimanagement:ApiGateway
properties:
backend:
subnet:
id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1
gatewayName: apimGateway1
location: South Central US
resourceGroupName: rg1
sku:
capacity: 1
name: Standard
tags:
Name: Contoso
Test: User
ApiManagementCreateWorkspacePremiumGateway
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiGateway = new AzureNative.ApiManagement.ApiGateway("apiGateway", new()
{
Backend = new AzureNative.ApiManagement.Inputs.BackendConfigurationArgs
{
Subnet = new AzureNative.ApiManagement.Inputs.BackendSubnetConfigurationArgs
{
Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
},
},
GatewayName = "apimGateway1",
Location = "South Central US",
ResourceGroupName = "rg1",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementGatewaySkuPropertiesArgs
{
Capacity = 1,
Name = "WorkspaceGatewayPremium",
},
Tags =
{
{ "Name", "Contoso" },
{ "Test", "User" },
},
VirtualNetworkType = AzureNative.ApiManagement.VirtualNetworkType.External,
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewApiGateway(ctx, "apiGateway", &apimanagement.ApiGatewayArgs{
Backend: &apimanagement.BackendConfigurationArgs{
Subnet: &apimanagement.BackendSubnetConfigurationArgs{
Id: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"),
},
},
GatewayName: pulumi.String("apimGateway1"),
Location: pulumi.String("South Central US"),
ResourceGroupName: pulumi.String("rg1"),
Sku: &apimanagement.ApiManagementGatewaySkuPropertiesArgs{
Capacity: pulumi.Int(1),
Name: pulumi.String("WorkspaceGatewayPremium"),
},
Tags: pulumi.StringMap{
"Name": pulumi.String("Contoso"),
"Test": pulumi.String("User"),
},
VirtualNetworkType: pulumi.String(apimanagement.VirtualNetworkTypeExternal),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.ApiGateway;
import com.pulumi.azurenative.apimanagement.ApiGatewayArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendConfigurationArgs;
import com.pulumi.azurenative.apimanagement.inputs.BackendSubnetConfigurationArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementGatewaySkuPropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var apiGateway = new ApiGateway("apiGateway", ApiGatewayArgs.builder()
.backend(BackendConfigurationArgs.builder()
.subnet(BackendSubnetConfigurationArgs.builder()
.id("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1")
.build())
.build())
.gatewayName("apimGateway1")
.location("South Central US")
.resourceGroupName("rg1")
.sku(ApiManagementGatewaySkuPropertiesArgs.builder()
.capacity(1)
.name("WorkspaceGatewayPremium")
.build())
.tags(Map.ofEntries(
Map.entry("Name", "Contoso"),
Map.entry("Test", "User")
))
.virtualNetworkType("External")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
api_gateway = azure_native.apimanagement.ApiGateway("apiGateway",
backend={
"subnet": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
},
},
gateway_name="apimGateway1",
location="South Central US",
resource_group_name="rg1",
sku={
"capacity": 1,
"name": "WorkspaceGatewayPremium",
},
tags={
"Name": "Contoso",
"Test": "User",
},
virtual_network_type=azure_native.apimanagement.VirtualNetworkType.EXTERNAL)
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiGateway = new azure_native.apimanagement.ApiGateway("apiGateway", {
backend: {
subnet: {
id: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1",
},
},
gatewayName: "apimGateway1",
location: "South Central US",
resourceGroupName: "rg1",
sku: {
capacity: 1,
name: "WorkspaceGatewayPremium",
},
tags: {
Name: "Contoso",
Test: "User",
},
virtualNetworkType: azure_native.apimanagement.VirtualNetworkType.External,
});
resources:
apiGateway:
type: azure-native:apimanagement:ApiGateway
properties:
backend:
subnet:
id: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1
gatewayName: apimGateway1
location: South Central US
resourceGroupName: rg1
sku:
capacity: 1
name: WorkspaceGatewayPremium
tags:
Name: Contoso
Test: User
virtualNetworkType: External
Create ApiGateway Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApiGateway(name: string, args: ApiGatewayArgs, opts?: CustomResourceOptions);
@overload
def ApiGateway(resource_name: str,
args: ApiGatewayArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ApiGateway(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
sku: Optional[ApiManagementGatewaySkuPropertiesArgs] = None,
backend: Optional[BackendConfigurationArgs] = None,
gateway_name: Optional[str] = None,
location: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
virtual_network_type: Optional[Union[str, VirtualNetworkType]] = None)
func NewApiGateway(ctx *Context, name string, args ApiGatewayArgs, opts ...ResourceOption) (*ApiGateway, error)
public ApiGateway(string name, ApiGatewayArgs args, CustomResourceOptions? opts = null)
public ApiGateway(String name, ApiGatewayArgs args)
public ApiGateway(String name, ApiGatewayArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:ApiGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ApiGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ApiGatewayArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApiGatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiGatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiGatewayArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var apiGatewayResource = new AzureNative.ApiManagement.ApiGateway("apiGatewayResource", new()
{
ResourceGroupName = "string",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementGatewaySkuPropertiesArgs
{
Name = "string",
Capacity = 0,
},
Backend = new AzureNative.ApiManagement.Inputs.BackendConfigurationArgs
{
Subnet = new AzureNative.ApiManagement.Inputs.BackendSubnetConfigurationArgs
{
Id = "string",
},
},
GatewayName = "string",
Location = "string",
Tags =
{
{ "string", "string" },
},
VirtualNetworkType = "string",
});
example, err := apimanagement.NewApiGateway(ctx, "apiGatewayResource", &apimanagement.ApiGatewayArgs{
ResourceGroupName: pulumi.String("string"),
Sku: &apimanagement.ApiManagementGatewaySkuPropertiesArgs{
Name: pulumi.String("string"),
Capacity: pulumi.Int(0),
},
Backend: &apimanagement.BackendConfigurationArgs{
Subnet: &apimanagement.BackendSubnetConfigurationArgs{
Id: pulumi.String("string"),
},
},
GatewayName: pulumi.String("string"),
Location: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
VirtualNetworkType: pulumi.String("string"),
})
var apiGatewayResource = new ApiGateway("apiGatewayResource", ApiGatewayArgs.builder()
.resourceGroupName("string")
.sku(ApiManagementGatewaySkuPropertiesArgs.builder()
.name("string")
.capacity(0)
.build())
.backend(BackendConfigurationArgs.builder()
.subnet(BackendSubnetConfigurationArgs.builder()
.id("string")
.build())
.build())
.gatewayName("string")
.location("string")
.tags(Map.of("string", "string"))
.virtualNetworkType("string")
.build());
api_gateway_resource = azure_native.apimanagement.ApiGateway("apiGatewayResource",
resource_group_name="string",
sku={
"name": "string",
"capacity": 0,
},
backend={
"subnet": {
"id": "string",
},
},
gateway_name="string",
location="string",
tags={
"string": "string",
},
virtual_network_type="string")
const apiGatewayResource = new azure_native.apimanagement.ApiGateway("apiGatewayResource", {
resourceGroupName: "string",
sku: {
name: "string",
capacity: 0,
},
backend: {
subnet: {
id: "string",
},
},
gatewayName: "string",
location: "string",
tags: {
string: "string",
},
virtualNetworkType: "string",
});
type: azure-native:apimanagement:ApiGateway
properties:
backend:
subnet:
id: string
gatewayName: string
location: string
resourceGroupName: string
sku:
capacity: 0
name: string
tags:
string: string
virtualNetworkType: string
ApiGateway Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ApiGateway resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Sku
Pulumi.
Azure Native. Api Management. Inputs. Api Management Gateway Sku Properties - SKU properties of the API Management gateway.
- Backend
Pulumi.
Azure Native. Api Management. Inputs. Backend Configuration - Information regarding how the gateway should integrate with backend systems.
- Gateway
Name string - The name of the API Management gateway.
- Location string
- Resource location.
- Dictionary<string, string>
- Resource tags.
- Virtual
Network string | Pulumi.Type Azure Native. Api Management. Virtual Network Type - The type of VPN in which API Management gateway needs to be configured in.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Sku
Api
Management Gateway Sku Properties Args - SKU properties of the API Management gateway.
- Backend
Backend
Configuration Args - Information regarding how the gateway should integrate with backend systems.
- Gateway
Name string - The name of the API Management gateway.
- Location string
- Resource location.
- map[string]string
- Resource tags.
- Virtual
Network string | VirtualType Network Type - The type of VPN in which API Management gateway needs to be configured in.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- sku
Api
Management Gateway Sku Properties - SKU properties of the API Management gateway.
- backend
Backend
Configuration - Information regarding how the gateway should integrate with backend systems.
- gateway
Name String - The name of the API Management gateway.
- location String
- Resource location.
- Map<String,String>
- Resource tags.
- virtual
Network String | VirtualType Network Type - The type of VPN in which API Management gateway needs to be configured in.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- sku
Api
Management Gateway Sku Properties - SKU properties of the API Management gateway.
- backend
Backend
Configuration - Information regarding how the gateway should integrate with backend systems.
- gateway
Name string - The name of the API Management gateway.
- location string
- Resource location.
- {[key: string]: string}
- Resource tags.
- virtual
Network string | VirtualType Network Type - The type of VPN in which API Management gateway needs to be configured in.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- sku
Api
Management Gateway Sku Properties Args - SKU properties of the API Management gateway.
- backend
Backend
Configuration Args - Information regarding how the gateway should integrate with backend systems.
- gateway_
name str - The name of the API Management gateway.
- location str
- Resource location.
- Mapping[str, str]
- Resource tags.
- virtual_
network_ str | Virtualtype Network Type - The type of VPN in which API Management gateway needs to be configured in.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- sku Property Map
- SKU properties of the API Management gateway.
- backend Property Map
- Information regarding how the gateway should integrate with backend systems.
- gateway
Name String - The name of the API Management gateway.
- location String
- Resource location.
- Map<String>
- Resource tags.
- virtual
Network String | "None" | "External" | "Internal"Type - The type of VPN in which API Management gateway needs to be configured in.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApiGateway resource produces the following output properties:
- 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
- The provider-assigned unique ID for this managed resource.
- 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.
- 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.
- 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.
- 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
- The provider-assigned unique ID for this managed resource.
- 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.
- 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.
- 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.
- 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
- The provider-assigned unique ID for this managed resource.
- 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.
- 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.
- 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.
- 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
- The provider-assigned unique ID for this managed resource.
- 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.
- 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.
- 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.
- 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
- The provider-assigned unique ID for this managed resource.
- 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.
- 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.
- 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.
- 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
- The provider-assigned unique ID for this managed resource.
- 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.
- 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.
- 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.
Supporting Types
ApiManagementGatewaySkuProperties, ApiManagementGatewaySkuPropertiesArgs
- Name
string | Pulumi.
Azure Native. Api Management. Sku Type - Name of the Sku.
- Capacity int
- Capacity of the SKU (number of deployed units of the SKU)
- name String | "Developer" | "Standard" | "Premium" | "Basic" | "Consumption" | "Isolated"
- Name of the Sku.
- capacity Number
- Capacity of the SKU (number of deployed units of the SKU)
ApiManagementGatewaySkuPropertiesResponse, ApiManagementGatewaySkuPropertiesResponseArgs
BackendConfiguration, BackendConfigurationArgs
- Subnet
Pulumi.
Azure Native. Api Management. Inputs. Backend Subnet Configuration - The default hostname of the data-plane gateway to which requests can be sent.
- Subnet
Backend
Subnet Configuration - The default hostname of the data-plane gateway to which requests can be sent.
- subnet
Backend
Subnet Configuration - The default hostname of the data-plane gateway to which requests can be sent.
- subnet
Backend
Subnet Configuration - The default hostname of the data-plane gateway to which requests can be sent.
- subnet
Backend
Subnet Configuration - 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.
BackendConfigurationResponse, BackendConfigurationResponseArgs
- 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.
BackendSubnetConfiguration, BackendSubnetConfigurationArgs
- 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.
BackendSubnetConfigurationResponse, BackendSubnetConfigurationResponseArgs
- 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, FrontendConfigurationResponseArgs
- 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, GatewayConfigurationApiResponseArgs
- 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.
SkuType, SkuTypeArgs
- Developer
- DeveloperDeveloper SKU of Api Management.
- Standard
- StandardStandard SKU of Api Management.
- Premium
- PremiumPremium SKU of Api Management.
- Basic
- BasicBasic SKU of Api Management.
- Consumption
- ConsumptionConsumption SKU of Api Management.
- Isolated
- IsolatedIsolated SKU of Api Management.
- Sku
Type Developer - DeveloperDeveloper SKU of Api Management.
- Sku
Type Standard - StandardStandard SKU of Api Management.
- Sku
Type Premium - PremiumPremium SKU of Api Management.
- Sku
Type Basic - BasicBasic SKU of Api Management.
- Sku
Type Consumption - ConsumptionConsumption SKU of Api Management.
- Sku
Type Isolated - IsolatedIsolated SKU of Api Management.
- Developer
- DeveloperDeveloper SKU of Api Management.
- Standard
- StandardStandard SKU of Api Management.
- Premium
- PremiumPremium SKU of Api Management.
- Basic
- BasicBasic SKU of Api Management.
- Consumption
- ConsumptionConsumption SKU of Api Management.
- Isolated
- IsolatedIsolated SKU of Api Management.
- Developer
- DeveloperDeveloper SKU of Api Management.
- Standard
- StandardStandard SKU of Api Management.
- Premium
- PremiumPremium SKU of Api Management.
- Basic
- BasicBasic SKU of Api Management.
- Consumption
- ConsumptionConsumption SKU of Api Management.
- Isolated
- IsolatedIsolated SKU of Api Management.
- DEVELOPER
- DeveloperDeveloper SKU of Api Management.
- STANDARD
- StandardStandard SKU of Api Management.
- PREMIUM
- PremiumPremium SKU of Api Management.
- BASIC
- BasicBasic SKU of Api Management.
- CONSUMPTION
- ConsumptionConsumption SKU of Api Management.
- ISOLATED
- IsolatedIsolated SKU of Api Management.
- "Developer"
- DeveloperDeveloper SKU of Api Management.
- "Standard"
- StandardStandard SKU of Api Management.
- "Premium"
- PremiumPremium SKU of Api Management.
- "Basic"
- BasicBasic SKU of Api Management.
- "Consumption"
- ConsumptionConsumption SKU of Api Management.
- "Isolated"
- IsolatedIsolated SKU of Api Management.
SystemDataResponse, SystemDataResponseArgs
- 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.
VirtualNetworkType, VirtualNetworkTypeArgs
- None
- NoneThe service is not part of any Virtual Network.
- External
- ExternalThe service is part of Virtual Network and it is accessible from Internet.
- Internal
- InternalThe service is part of Virtual Network and it is only accessible from within the virtual network.
- Virtual
Network Type None - NoneThe service is not part of any Virtual Network.
- Virtual
Network Type External - ExternalThe service is part of Virtual Network and it is accessible from Internet.
- Virtual
Network Type Internal - InternalThe service is part of Virtual Network and it is only accessible from within the virtual network.
- None
- NoneThe service is not part of any Virtual Network.
- External
- ExternalThe service is part of Virtual Network and it is accessible from Internet.
- Internal
- InternalThe service is part of Virtual Network and it is only accessible from within the virtual network.
- None
- NoneThe service is not part of any Virtual Network.
- External
- ExternalThe service is part of Virtual Network and it is accessible from Internet.
- Internal
- InternalThe service is part of Virtual Network and it is only accessible from within the virtual network.
- NONE
- NoneThe service is not part of any Virtual Network.
- EXTERNAL
- ExternalThe service is part of Virtual Network and it is accessible from Internet.
- INTERNAL
- InternalThe service is part of Virtual Network and it is only accessible from within the virtual network.
- "None"
- NoneThe service is not part of any Virtual Network.
- "External"
- ExternalThe service is part of Virtual Network and it is accessible from Internet.
- "Internal"
- InternalThe service is part of Virtual Network and it is only accessible from within the virtual network.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:ApiGateway apimGateway1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0