Docs Home
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.apimanagement.ApiManagementService
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
A single API Management service resource in List or Get response. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2016-10-10, 2017-03-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Example Usage
ApiManagementCreateMultiRegionServiceWithCustomHostname
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new()
{
AdditionalLocations = new[]
{
new AzureNative.ApiManagement.Inputs.AdditionalLocationArgs
{
DisableGateway = true,
Location = "East US",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
{
Capacity = 1,
Name = AzureNative.ApiManagement.SkuType.Premium,
},
},
},
ApiVersionConstraint = new AzureNative.ApiManagement.Inputs.ApiVersionConstraintArgs
{
MinApiVersion = "2019-01-01",
},
HostnameConfigurations = new[]
{
new AzureNative.ApiManagement.Inputs.HostnameConfigurationArgs
{
CertificatePassword = "Password",
DefaultSslBinding = true,
EncodedCertificate = "****** Base 64 Encoded Certificate ************",
HostName = "gateway1.msitesting.net",
Type = AzureNative.ApiManagement.HostnameType.Proxy,
},
new AzureNative.ApiManagement.Inputs.HostnameConfigurationArgs
{
CertificatePassword = "Password",
EncodedCertificate = "****** Base 64 Encoded Certificate ************",
HostName = "mgmt.msitesting.net",
Type = AzureNative.ApiManagement.HostnameType.Management,
},
new AzureNative.ApiManagement.Inputs.HostnameConfigurationArgs
{
CertificatePassword = "Password",
EncodedCertificate = "****** Base 64 Encoded Certificate ************",
HostName = "portal1.msitesting.net",
Type = AzureNative.ApiManagement.HostnameType.Portal,
},
},
Location = "West US",
PublisherEmail = "apim@autorestsdk.com",
PublisherName = "autorestsdk",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
{
Capacity = 1,
Name = AzureNative.ApiManagement.SkuType.Premium,
},
Tags =
{
{ "tag1", "value1" },
{ "tag2", "value2" },
{ "tag3", "value3" },
},
VirtualNetworkType = AzureNative.ApiManagement.VirtualNetworkType.None,
});
});
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.NewApiManagementService(ctx, "apiManagementService", &apimanagement.ApiManagementServiceArgs{
AdditionalLocations: apimanagement.AdditionalLocationArray{
&apimanagement.AdditionalLocationArgs{
DisableGateway: pulumi.Bool(true),
Location: pulumi.String("East US"),
Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
Capacity: pulumi.Int(1),
Name: pulumi.String(apimanagement.SkuTypePremium),
},
},
},
ApiVersionConstraint: &apimanagement.ApiVersionConstraintArgs{
MinApiVersion: pulumi.String("2019-01-01"),
},
HostnameConfigurations: apimanagement.HostnameConfigurationArray{
&apimanagement.HostnameConfigurationArgs{
CertificatePassword: pulumi.String("Password"),
DefaultSslBinding: pulumi.Bool(true),
EncodedCertificate: pulumi.String("****** Base 64 Encoded Certificate ************"),
HostName: pulumi.String("gateway1.msitesting.net"),
Type: pulumi.String(apimanagement.HostnameTypeProxy),
},
&apimanagement.HostnameConfigurationArgs{
CertificatePassword: pulumi.String("Password"),
EncodedCertificate: pulumi.String("****** Base 64 Encoded Certificate ************"),
HostName: pulumi.String("mgmt.msitesting.net"),
Type: pulumi.String(apimanagement.HostnameTypeManagement),
},
&apimanagement.HostnameConfigurationArgs{
CertificatePassword: pulumi.String("Password"),
EncodedCertificate: pulumi.String("****** Base 64 Encoded Certificate ************"),
HostName: pulumi.String("portal1.msitesting.net"),
Type: pulumi.String(apimanagement.HostnameTypePortal),
},
},
Location: pulumi.String("West US"),
PublisherEmail: pulumi.String("apim@autorestsdk.com"),
PublisherName: pulumi.String("autorestsdk"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
Capacity: pulumi.Int(1),
Name: pulumi.String(apimanagement.SkuTypePremium),
},
Tags: pulumi.StringMap{
"tag1": pulumi.String("value1"),
"tag2": pulumi.String("value2"),
"tag3": pulumi.String("value3"),
},
VirtualNetworkType: pulumi.String(apimanagement.VirtualNetworkTypeNone),
})
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.ApiManagementService;
import com.pulumi.azurenative.apimanagement.ApiManagementServiceArgs;
import com.pulumi.azurenative.apimanagement.inputs.AdditionalLocationArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementServiceSkuPropertiesArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiVersionConstraintArgs;
import com.pulumi.azurenative.apimanagement.inputs.HostnameConfigurationArgs;
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 apiManagementService = new ApiManagementService("apiManagementService", ApiManagementServiceArgs.builder()
.additionalLocations(AdditionalLocationArgs.builder()
.disableGateway(true)
.location("East US")
.sku(ApiManagementServiceSkuPropertiesArgs.builder()
.capacity(1)
.name("Premium")
.build())
.build())
.apiVersionConstraint(ApiVersionConstraintArgs.builder()
.minApiVersion("2019-01-01")
.build())
.hostnameConfigurations(
HostnameConfigurationArgs.builder()
.certificatePassword("Password")
.defaultSslBinding(true)
.encodedCertificate("****** Base 64 Encoded Certificate ************")
.hostName("gateway1.msitesting.net")
.type("Proxy")
.build(),
HostnameConfigurationArgs.builder()
.certificatePassword("Password")
.encodedCertificate("****** Base 64 Encoded Certificate ************")
.hostName("mgmt.msitesting.net")
.type("Management")
.build(),
HostnameConfigurationArgs.builder()
.certificatePassword("Password")
.encodedCertificate("****** Base 64 Encoded Certificate ************")
.hostName("portal1.msitesting.net")
.type("Portal")
.build())
.location("West US")
.publisherEmail("apim@autorestsdk.com")
.publisherName("autorestsdk")
.resourceGroupName("rg1")
.serviceName("apimService1")
.sku(ApiManagementServiceSkuPropertiesArgs.builder()
.capacity(1)
.name("Premium")
.build())
.tags(Map.ofEntries(
Map.entry("tag1", "value1"),
Map.entry("tag2", "value2"),
Map.entry("tag3", "value3")
))
.virtualNetworkType("None")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiManagementService = new azure_native.apimanagement.ApiManagementService("apiManagementService", {
additionalLocations: [{
disableGateway: true,
location: "East US",
sku: {
capacity: 1,
name: azure_native.apimanagement.SkuType.Premium,
},
}],
apiVersionConstraint: {
minApiVersion: "2019-01-01",
},
hostnameConfigurations: [
{
certificatePassword: "Password",
defaultSslBinding: true,
encodedCertificate: "****** Base 64 Encoded Certificate ************",
hostName: "gateway1.msitesting.net",
type: azure_native.apimanagement.HostnameType.Proxy,
},
{
certificatePassword: "Password",
encodedCertificate: "****** Base 64 Encoded Certificate ************",
hostName: "mgmt.msitesting.net",
type: azure_native.apimanagement.HostnameType.Management,
},
{
certificatePassword: "Password",
encodedCertificate: "****** Base 64 Encoded Certificate ************",
hostName: "portal1.msitesting.net",
type: azure_native.apimanagement.HostnameType.Portal,
},
],
location: "West US",
publisherEmail: "apim@autorestsdk.com",
publisherName: "autorestsdk",
resourceGroupName: "rg1",
serviceName: "apimService1",
sku: {
capacity: 1,
name: azure_native.apimanagement.SkuType.Premium,
},
tags: {
tag1: "value1",
tag2: "value2",
tag3: "value3",
},
virtualNetworkType: azure_native.apimanagement.VirtualNetworkType.None,
});
import pulumi
import pulumi_azure_native as azure_native
api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
additional_locations=[{
"disable_gateway": True,
"location": "East US",
"sku": {
"capacity": 1,
"name": azure_native.apimanagement.SkuType.PREMIUM,
},
}],
api_version_constraint={
"min_api_version": "2019-01-01",
},
hostname_configurations=[
{
"certificate_password": "Password",
"default_ssl_binding": True,
"encoded_certificate": "****** Base 64 Encoded Certificate ************",
"host_name": "gateway1.msitesting.net",
"type": azure_native.apimanagement.HostnameType.PROXY,
},
{
"certificate_password": "Password",
"encoded_certificate": "****** Base 64 Encoded Certificate ************",
"host_name": "mgmt.msitesting.net",
"type": azure_native.apimanagement.HostnameType.MANAGEMENT,
},
{
"certificate_password": "Password",
"encoded_certificate": "****** Base 64 Encoded Certificate ************",
"host_name": "portal1.msitesting.net",
"type": azure_native.apimanagement.HostnameType.PORTAL,
},
],
location="West US",
publisher_email="apim@autorestsdk.com",
publisher_name="autorestsdk",
resource_group_name="rg1",
service_name="apimService1",
sku={
"capacity": 1,
"name": azure_native.apimanagement.SkuType.PREMIUM,
},
tags={
"tag1": "value1",
"tag2": "value2",
"tag3": "value3",
},
virtual_network_type=azure_native.apimanagement.VirtualNetworkType.NONE)
resources:
apiManagementService:
type: azure-native:apimanagement:ApiManagementService
properties:
additionalLocations:
- disableGateway: true
location: East US
sku:
capacity: 1
name: Premium
apiVersionConstraint:
minApiVersion: 2019-01-01
hostnameConfigurations:
- certificatePassword: Password
defaultSslBinding: true
encodedCertificate: '****** Base 64 Encoded Certificate ************'
hostName: gateway1.msitesting.net
type: Proxy
- certificatePassword: Password
encodedCertificate: '****** Base 64 Encoded Certificate ************'
hostName: mgmt.msitesting.net
type: Management
- certificatePassword: Password
encodedCertificate: '****** Base 64 Encoded Certificate ************'
hostName: portal1.msitesting.net
type: Portal
location: West US
publisherEmail: apim@autorestsdk.com
publisherName: autorestsdk
resourceGroupName: rg1
serviceName: apimService1
sku:
capacity: 1
name: Premium
tags:
tag1: value1
tag2: value2
tag3: value3
virtualNetworkType: None
ApiManagementCreateService
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new()
{
Location = "South Central US",
PublisherEmail = "foo@contoso.com",
PublisherName = "foo",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
{
Capacity = 1,
Name = AzureNative.ApiManagement.SkuType.Developer,
},
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.NewApiManagementService(ctx, "apiManagementService", &apimanagement.ApiManagementServiceArgs{
Location: pulumi.String("South Central US"),
PublisherEmail: pulumi.String("foo@contoso.com"),
PublisherName: pulumi.String("foo"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
Capacity: pulumi.Int(1),
Name: pulumi.String(apimanagement.SkuTypeDeveloper),
},
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.ApiManagementService;
import com.pulumi.azurenative.apimanagement.ApiManagementServiceArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementServiceSkuPropertiesArgs;
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 apiManagementService = new ApiManagementService("apiManagementService", ApiManagementServiceArgs.builder()
.location("South Central US")
.publisherEmail("foo@contoso.com")
.publisherName("foo")
.resourceGroupName("rg1")
.serviceName("apimService1")
.sku(ApiManagementServiceSkuPropertiesArgs.builder()
.capacity(1)
.name("Developer")
.build())
.tags(Map.ofEntries(
Map.entry("Name", "Contoso"),
Map.entry("Test", "User")
))
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiManagementService = new azure_native.apimanagement.ApiManagementService("apiManagementService", {
location: "South Central US",
publisherEmail: "foo@contoso.com",
publisherName: "foo",
resourceGroupName: "rg1",
serviceName: "apimService1",
sku: {
capacity: 1,
name: azure_native.apimanagement.SkuType.Developer,
},
tags: {
Name: "Contoso",
Test: "User",
},
});
import pulumi
import pulumi_azure_native as azure_native
api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
location="South Central US",
publisher_email="foo@contoso.com",
publisher_name="foo",
resource_group_name="rg1",
service_name="apimService1",
sku={
"capacity": 1,
"name": azure_native.apimanagement.SkuType.DEVELOPER,
},
tags={
"Name": "Contoso",
"Test": "User",
})
resources:
apiManagementService:
type: azure-native:apimanagement:ApiManagementService
properties:
location: South Central US
publisherEmail: foo@contoso.com
publisherName: foo
resourceGroupName: rg1
serviceName: apimService1
sku:
capacity: 1
name: Developer
tags:
Name: Contoso
Test: User
ApiManagementCreateServiceHavingMsi
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new()
{
Identity = new AzureNative.ApiManagement.Inputs.ApiManagementServiceIdentityArgs
{
Type = AzureNative.ApiManagement.ApimIdentityType.SystemAssigned,
},
Location = "West US",
PublisherEmail = "apim@autorestsdk.com",
PublisherName = "autorestsdk",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
{
Capacity = 0,
Name = AzureNative.ApiManagement.SkuType.Consumption,
},
Tags =
{
{ "tag1", "value1" },
{ "tag2", "value2" },
{ "tag3", "value3" },
},
});
});
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.NewApiManagementService(ctx, "apiManagementService", &apimanagement.ApiManagementServiceArgs{
Identity: &apimanagement.ApiManagementServiceIdentityArgs{
Type: pulumi.String(apimanagement.ApimIdentityTypeSystemAssigned),
},
Location: pulumi.String("West US"),
PublisherEmail: pulumi.String("apim@autorestsdk.com"),
PublisherName: pulumi.String("autorestsdk"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
Capacity: pulumi.Int(0),
Name: pulumi.String(apimanagement.SkuTypeConsumption),
},
Tags: pulumi.StringMap{
"tag1": pulumi.String("value1"),
"tag2": pulumi.String("value2"),
"tag3": pulumi.String("value3"),
},
})
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.ApiManagementService;
import com.pulumi.azurenative.apimanagement.ApiManagementServiceArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementServiceIdentityArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementServiceSkuPropertiesArgs;
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 apiManagementService = new ApiManagementService("apiManagementService", ApiManagementServiceArgs.builder()
.identity(ApiManagementServiceIdentityArgs.builder()
.type("SystemAssigned")
.build())
.location("West US")
.publisherEmail("apim@autorestsdk.com")
.publisherName("autorestsdk")
.resourceGroupName("rg1")
.serviceName("apimService1")
.sku(ApiManagementServiceSkuPropertiesArgs.builder()
.capacity(0)
.name("Consumption")
.build())
.tags(Map.ofEntries(
Map.entry("tag1", "value1"),
Map.entry("tag2", "value2"),
Map.entry("tag3", "value3")
))
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiManagementService = new azure_native.apimanagement.ApiManagementService("apiManagementService", {
identity: {
type: azure_native.apimanagement.ApimIdentityType.SystemAssigned,
},
location: "West US",
publisherEmail: "apim@autorestsdk.com",
publisherName: "autorestsdk",
resourceGroupName: "rg1",
serviceName: "apimService1",
sku: {
capacity: 0,
name: azure_native.apimanagement.SkuType.Consumption,
},
tags: {
tag1: "value1",
tag2: "value2",
tag3: "value3",
},
});
import pulumi
import pulumi_azure_native as azure_native
api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
identity={
"type": azure_native.apimanagement.ApimIdentityType.SYSTEM_ASSIGNED,
},
location="West US",
publisher_email="apim@autorestsdk.com",
publisher_name="autorestsdk",
resource_group_name="rg1",
service_name="apimService1",
sku={
"capacity": 0,
"name": azure_native.apimanagement.SkuType.CONSUMPTION,
},
tags={
"tag1": "value1",
"tag2": "value2",
"tag3": "value3",
})
resources:
apiManagementService:
type: azure-native:apimanagement:ApiManagementService
properties:
identity:
type: SystemAssigned
location: West US
publisherEmail: apim@autorestsdk.com
publisherName: autorestsdk
resourceGroupName: rg1
serviceName: apimService1
sku:
capacity: 0
name: Consumption
tags:
tag1: value1
tag2: value2
tag3: value3
ApiManagementCreateServiceInVnetWithPublicIP
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new()
{
Location = "East US 2 EUAP",
PublicIpAddressId = "/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet",
PublisherEmail = "apim@autorestsdk.com",
PublisherName = "autorestsdk",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
{
Capacity = 2,
Name = AzureNative.ApiManagement.SkuType.Premium,
},
Tags =
{
{ "tag1", "value1" },
{ "tag2", "value2" },
{ "tag3", "value3" },
},
VirtualNetworkConfiguration = new AzureNative.ApiManagement.Inputs.VirtualNetworkConfigurationArgs
{
SubnetResourceId = "/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant",
},
VirtualNetworkType = AzureNative.ApiManagement.VirtualNetworkType.External,
Zones = new[]
{
"1",
"2",
},
});
});
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.NewApiManagementService(ctx, "apiManagementService", &apimanagement.ApiManagementServiceArgs{
Location: pulumi.String("East US 2 EUAP"),
PublicIpAddressId: pulumi.String("/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet"),
PublisherEmail: pulumi.String("apim@autorestsdk.com"),
PublisherName: pulumi.String("autorestsdk"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
Capacity: pulumi.Int(2),
Name: pulumi.String(apimanagement.SkuTypePremium),
},
Tags: pulumi.StringMap{
"tag1": pulumi.String("value1"),
"tag2": pulumi.String("value2"),
"tag3": pulumi.String("value3"),
},
VirtualNetworkConfiguration: &apimanagement.VirtualNetworkConfigurationArgs{
SubnetResourceId: pulumi.String("/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant"),
},
VirtualNetworkType: pulumi.String(apimanagement.VirtualNetworkTypeExternal),
Zones: pulumi.StringArray{
pulumi.String("1"),
pulumi.String("2"),
},
})
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.ApiManagementService;
import com.pulumi.azurenative.apimanagement.ApiManagementServiceArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementServiceSkuPropertiesArgs;
import com.pulumi.azurenative.apimanagement.inputs.VirtualNetworkConfigurationArgs;
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 apiManagementService = new ApiManagementService("apiManagementService", ApiManagementServiceArgs.builder()
.location("East US 2 EUAP")
.publicIpAddressId("/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet")
.publisherEmail("apim@autorestsdk.com")
.publisherName("autorestsdk")
.resourceGroupName("rg1")
.serviceName("apimService1")
.sku(ApiManagementServiceSkuPropertiesArgs.builder()
.capacity(2)
.name("Premium")
.build())
.tags(Map.ofEntries(
Map.entry("tag1", "value1"),
Map.entry("tag2", "value2"),
Map.entry("tag3", "value3")
))
.virtualNetworkConfiguration(VirtualNetworkConfigurationArgs.builder()
.subnetResourceId("/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant")
.build())
.virtualNetworkType("External")
.zones(
"1",
"2")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiManagementService = new azure_native.apimanagement.ApiManagementService("apiManagementService", {
location: "East US 2 EUAP",
publicIpAddressId: "/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet",
publisherEmail: "apim@autorestsdk.com",
publisherName: "autorestsdk",
resourceGroupName: "rg1",
serviceName: "apimService1",
sku: {
capacity: 2,
name: azure_native.apimanagement.SkuType.Premium,
},
tags: {
tag1: "value1",
tag2: "value2",
tag3: "value3",
},
virtualNetworkConfiguration: {
subnetResourceId: "/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant",
},
virtualNetworkType: azure_native.apimanagement.VirtualNetworkType.External,
zones: [
"1",
"2",
],
});
import pulumi
import pulumi_azure_native as azure_native
api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
location="East US 2 EUAP",
public_ip_address_id="/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet",
publisher_email="apim@autorestsdk.com",
publisher_name="autorestsdk",
resource_group_name="rg1",
service_name="apimService1",
sku={
"capacity": 2,
"name": azure_native.apimanagement.SkuType.PREMIUM,
},
tags={
"tag1": "value1",
"tag2": "value2",
"tag3": "value3",
},
virtual_network_configuration={
"subnet_resource_id": "/subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant",
},
virtual_network_type=azure_native.apimanagement.VirtualNetworkType.EXTERNAL,
zones=[
"1",
"2",
])
resources:
apiManagementService:
type: azure-native:apimanagement:ApiManagementService
properties:
location: East US 2 EUAP
publicIpAddressId: /subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/publicIPAddresses/apimazvnet
publisherEmail: apim@autorestsdk.com
publisherName: autorestsdk
resourceGroupName: rg1
serviceName: apimService1
sku:
capacity: 2
name: Premium
tags:
tag1: value1
tag2: value2
tag3: value3
virtualNetworkConfiguration:
subnetResourceId: /subscriptions/subid/resourceGroups/rgName/providers/Microsoft.Network/virtualNetworks/apimcus/subnets/tenant
virtualNetworkType: External
zones:
- '1'
- '2'
ApiManagementCreateServiceInZones
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new()
{
Location = "North europe",
PublisherEmail = "apim@autorestsdk.com",
PublisherName = "autorestsdk",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
{
Capacity = 2,
Name = AzureNative.ApiManagement.SkuType.Premium,
},
Tags =
{
{ "tag1", "value1" },
{ "tag2", "value2" },
{ "tag3", "value3" },
},
Zones = new[]
{
"1",
"2",
},
});
});
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.NewApiManagementService(ctx, "apiManagementService", &apimanagement.ApiManagementServiceArgs{
Location: pulumi.String("North europe"),
PublisherEmail: pulumi.String("apim@autorestsdk.com"),
PublisherName: pulumi.String("autorestsdk"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
Capacity: pulumi.Int(2),
Name: pulumi.String(apimanagement.SkuTypePremium),
},
Tags: pulumi.StringMap{
"tag1": pulumi.String("value1"),
"tag2": pulumi.String("value2"),
"tag3": pulumi.String("value3"),
},
Zones: pulumi.StringArray{
pulumi.String("1"),
pulumi.String("2"),
},
})
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.ApiManagementService;
import com.pulumi.azurenative.apimanagement.ApiManagementServiceArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementServiceSkuPropertiesArgs;
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 apiManagementService = new ApiManagementService("apiManagementService", ApiManagementServiceArgs.builder()
.location("North europe")
.publisherEmail("apim@autorestsdk.com")
.publisherName("autorestsdk")
.resourceGroupName("rg1")
.serviceName("apimService1")
.sku(ApiManagementServiceSkuPropertiesArgs.builder()
.capacity(2)
.name("Premium")
.build())
.tags(Map.ofEntries(
Map.entry("tag1", "value1"),
Map.entry("tag2", "value2"),
Map.entry("tag3", "value3")
))
.zones(
"1",
"2")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiManagementService = new azure_native.apimanagement.ApiManagementService("apiManagementService", {
location: "North europe",
publisherEmail: "apim@autorestsdk.com",
publisherName: "autorestsdk",
resourceGroupName: "rg1",
serviceName: "apimService1",
sku: {
capacity: 2,
name: azure_native.apimanagement.SkuType.Premium,
},
tags: {
tag1: "value1",
tag2: "value2",
tag3: "value3",
},
zones: [
"1",
"2",
],
});
import pulumi
import pulumi_azure_native as azure_native
api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
location="North europe",
publisher_email="apim@autorestsdk.com",
publisher_name="autorestsdk",
resource_group_name="rg1",
service_name="apimService1",
sku={
"capacity": 2,
"name": azure_native.apimanagement.SkuType.PREMIUM,
},
tags={
"tag1": "value1",
"tag2": "value2",
"tag3": "value3",
},
zones=[
"1",
"2",
])
resources:
apiManagementService:
type: azure-native:apimanagement:ApiManagementService
properties:
location: North europe
publisherEmail: apim@autorestsdk.com
publisherName: autorestsdk
resourceGroupName: rg1
serviceName: apimService1
sku:
capacity: 2
name: Premium
tags:
tag1: value1
tag2: value2
tag3: value3
zones:
- '1'
- '2'
ApiManagementCreateServiceWithCustomHostnameKeyVault
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new()
{
ApiVersionConstraint = new AzureNative.ApiManagement.Inputs.ApiVersionConstraintArgs
{
MinApiVersion = "2019-01-01",
},
HostnameConfigurations = new[]
{
new AzureNative.ApiManagement.Inputs.HostnameConfigurationArgs
{
DefaultSslBinding = true,
HostName = "gateway1.msitesting.net",
IdentityClientId = "329419bc-adec-4dce-9568-25a6d486e468",
KeyVaultId = "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
Type = AzureNative.ApiManagement.HostnameType.Proxy,
},
new AzureNative.ApiManagement.Inputs.HostnameConfigurationArgs
{
HostName = "mgmt.msitesting.net",
IdentityClientId = "329419bc-adec-4dce-9568-25a6d486e468",
KeyVaultId = "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
Type = AzureNative.ApiManagement.HostnameType.Management,
},
new AzureNative.ApiManagement.Inputs.HostnameConfigurationArgs
{
HostName = "portal1.msitesting.net",
IdentityClientId = "329419bc-adec-4dce-9568-25a6d486e468",
KeyVaultId = "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
Type = AzureNative.ApiManagement.HostnameType.Portal,
},
},
Identity = new AzureNative.ApiManagement.Inputs.ApiManagementServiceIdentityArgs
{
Type = AzureNative.ApiManagement.ApimIdentityType.UserAssigned,
UserAssignedIdentities =
{
{ "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1", null },
},
},
Location = "North Europe",
PublisherEmail = "apim@autorestsdk.com",
PublisherName = "autorestsdk",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
{
Capacity = 1,
Name = AzureNative.ApiManagement.SkuType.Premium,
},
Tags =
{
{ "tag1", "value1" },
{ "tag2", "value2" },
{ "tag3", "value3" },
},
VirtualNetworkType = AzureNative.ApiManagement.VirtualNetworkType.None,
});
});
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.NewApiManagementService(ctx, "apiManagementService", &apimanagement.ApiManagementServiceArgs{
ApiVersionConstraint: &apimanagement.ApiVersionConstraintArgs{
MinApiVersion: pulumi.String("2019-01-01"),
},
HostnameConfigurations: apimanagement.HostnameConfigurationArray{
&apimanagement.HostnameConfigurationArgs{
DefaultSslBinding: pulumi.Bool(true),
HostName: pulumi.String("gateway1.msitesting.net"),
IdentityClientId: pulumi.String("329419bc-adec-4dce-9568-25a6d486e468"),
KeyVaultId: pulumi.String("https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert"),
Type: pulumi.String(apimanagement.HostnameTypeProxy),
},
&apimanagement.HostnameConfigurationArgs{
HostName: pulumi.String("mgmt.msitesting.net"),
IdentityClientId: pulumi.String("329419bc-adec-4dce-9568-25a6d486e468"),
KeyVaultId: pulumi.String("https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert"),
Type: pulumi.String(apimanagement.HostnameTypeManagement),
},
&apimanagement.HostnameConfigurationArgs{
HostName: pulumi.String("portal1.msitesting.net"),
IdentityClientId: pulumi.String("329419bc-adec-4dce-9568-25a6d486e468"),
KeyVaultId: pulumi.String("https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert"),
Type: pulumi.String(apimanagement.HostnameTypePortal),
},
},
Identity: &apimanagement.ApiManagementServiceIdentityArgs{
Type: pulumi.String(apimanagement.ApimIdentityTypeUserAssigned),
UserAssignedIdentities: apimanagement.UserIdentityPropertiesMap{
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": &apimanagement.UserIdentityPropertiesArgs{},
},
},
Location: pulumi.String("North Europe"),
PublisherEmail: pulumi.String("apim@autorestsdk.com"),
PublisherName: pulumi.String("autorestsdk"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
Capacity: pulumi.Int(1),
Name: pulumi.String(apimanagement.SkuTypePremium),
},
Tags: pulumi.StringMap{
"tag1": pulumi.String("value1"),
"tag2": pulumi.String("value2"),
"tag3": pulumi.String("value3"),
},
VirtualNetworkType: pulumi.String(apimanagement.VirtualNetworkTypeNone),
})
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.ApiManagementService;
import com.pulumi.azurenative.apimanagement.ApiManagementServiceArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiVersionConstraintArgs;
import com.pulumi.azurenative.apimanagement.inputs.HostnameConfigurationArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementServiceIdentityArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementServiceSkuPropertiesArgs;
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 apiManagementService = new ApiManagementService("apiManagementService", ApiManagementServiceArgs.builder()
.apiVersionConstraint(ApiVersionConstraintArgs.builder()
.minApiVersion("2019-01-01")
.build())
.hostnameConfigurations(
HostnameConfigurationArgs.builder()
.defaultSslBinding(true)
.hostName("gateway1.msitesting.net")
.identityClientId("329419bc-adec-4dce-9568-25a6d486e468")
.keyVaultId("https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert")
.type("Proxy")
.build(),
HostnameConfigurationArgs.builder()
.hostName("mgmt.msitesting.net")
.identityClientId("329419bc-adec-4dce-9568-25a6d486e468")
.keyVaultId("https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert")
.type("Management")
.build(),
HostnameConfigurationArgs.builder()
.hostName("portal1.msitesting.net")
.identityClientId("329419bc-adec-4dce-9568-25a6d486e468")
.keyVaultId("https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert")
.type("Portal")
.build())
.identity(ApiManagementServiceIdentityArgs.builder()
.type("UserAssigned")
.userAssignedIdentities(Map.of("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1", ))
.build())
.location("North Europe")
.publisherEmail("apim@autorestsdk.com")
.publisherName("autorestsdk")
.resourceGroupName("rg1")
.serviceName("apimService1")
.sku(ApiManagementServiceSkuPropertiesArgs.builder()
.capacity(1)
.name("Premium")
.build())
.tags(Map.ofEntries(
Map.entry("tag1", "value1"),
Map.entry("tag2", "value2"),
Map.entry("tag3", "value3")
))
.virtualNetworkType("None")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiManagementService = new azure_native.apimanagement.ApiManagementService("apiManagementService", {
apiVersionConstraint: {
minApiVersion: "2019-01-01",
},
hostnameConfigurations: [
{
defaultSslBinding: true,
hostName: "gateway1.msitesting.net",
identityClientId: "329419bc-adec-4dce-9568-25a6d486e468",
keyVaultId: "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
type: azure_native.apimanagement.HostnameType.Proxy,
},
{
hostName: "mgmt.msitesting.net",
identityClientId: "329419bc-adec-4dce-9568-25a6d486e468",
keyVaultId: "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
type: azure_native.apimanagement.HostnameType.Management,
},
{
hostName: "portal1.msitesting.net",
identityClientId: "329419bc-adec-4dce-9568-25a6d486e468",
keyVaultId: "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
type: azure_native.apimanagement.HostnameType.Portal,
},
],
identity: {
type: azure_native.apimanagement.ApimIdentityType.UserAssigned,
userAssignedIdentities: {
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
},
},
location: "North Europe",
publisherEmail: "apim@autorestsdk.com",
publisherName: "autorestsdk",
resourceGroupName: "rg1",
serviceName: "apimService1",
sku: {
capacity: 1,
name: azure_native.apimanagement.SkuType.Premium,
},
tags: {
tag1: "value1",
tag2: "value2",
tag3: "value3",
},
virtualNetworkType: azure_native.apimanagement.VirtualNetworkType.None,
});
import pulumi
import pulumi_azure_native as azure_native
api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
api_version_constraint={
"min_api_version": "2019-01-01",
},
hostname_configurations=[
{
"default_ssl_binding": True,
"host_name": "gateway1.msitesting.net",
"identity_client_id": "329419bc-adec-4dce-9568-25a6d486e468",
"key_vault_id": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
"type": azure_native.apimanagement.HostnameType.PROXY,
},
{
"host_name": "mgmt.msitesting.net",
"identity_client_id": "329419bc-adec-4dce-9568-25a6d486e468",
"key_vault_id": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
"type": azure_native.apimanagement.HostnameType.MANAGEMENT,
},
{
"host_name": "portal1.msitesting.net",
"identity_client_id": "329419bc-adec-4dce-9568-25a6d486e468",
"key_vault_id": "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
"type": azure_native.apimanagement.HostnameType.PORTAL,
},
],
identity={
"type": azure_native.apimanagement.ApimIdentityType.USER_ASSIGNED,
"user_assigned_identities": {
"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
},
},
location="North Europe",
publisher_email="apim@autorestsdk.com",
publisher_name="autorestsdk",
resource_group_name="rg1",
service_name="apimService1",
sku={
"capacity": 1,
"name": azure_native.apimanagement.SkuType.PREMIUM,
},
tags={
"tag1": "value1",
"tag2": "value2",
"tag3": "value3",
},
virtual_network_type=azure_native.apimanagement.VirtualNetworkType.NONE)
resources:
apiManagementService:
type: azure-native:apimanagement:ApiManagementService
properties:
apiVersionConstraint:
minApiVersion: 2019-01-01
hostnameConfigurations:
- defaultSslBinding: true
hostName: gateway1.msitesting.net
identityClientId: 329419bc-adec-4dce-9568-25a6d486e468
keyVaultId: https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert
type: Proxy
- hostName: mgmt.msitesting.net
identityClientId: 329419bc-adec-4dce-9568-25a6d486e468
keyVaultId: https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert
type: Management
- hostName: portal1.msitesting.net
identityClientId: 329419bc-adec-4dce-9568-25a6d486e468
keyVaultId: https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert
type: Portal
identity:
type: UserAssigned
userAssignedIdentities:
/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1: {}
location: North Europe
publisherEmail: apim@autorestsdk.com
publisherName: autorestsdk
resourceGroupName: rg1
serviceName: apimService1
sku:
capacity: 1
name: Premium
tags:
tag1: value1
tag2: value2
tag3: value3
virtualNetworkType: None
ApiManagementCreateServiceWithNatGatewayEnabled
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new()
{
Location = "East US",
NatGatewayState = AzureNative.ApiManagement.NatGatewayState.Enabled,
PublisherEmail = "apim@autorestsdk.com",
PublisherName = "autorestsdk",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
{
Capacity = 1,
Name = AzureNative.ApiManagement.SkuType.Premium,
},
Tags =
{
{ "tag1", "value1" },
{ "tag2", "value2" },
{ "tag3", "value3" },
},
});
});
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.NewApiManagementService(ctx, "apiManagementService", &apimanagement.ApiManagementServiceArgs{
Location: pulumi.String("East US"),
NatGatewayState: pulumi.String(apimanagement.NatGatewayStateEnabled),
PublisherEmail: pulumi.String("apim@autorestsdk.com"),
PublisherName: pulumi.String("autorestsdk"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
Capacity: pulumi.Int(1),
Name: pulumi.String(apimanagement.SkuTypePremium),
},
Tags: pulumi.StringMap{
"tag1": pulumi.String("value1"),
"tag2": pulumi.String("value2"),
"tag3": pulumi.String("value3"),
},
})
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.ApiManagementService;
import com.pulumi.azurenative.apimanagement.ApiManagementServiceArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementServiceSkuPropertiesArgs;
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 apiManagementService = new ApiManagementService("apiManagementService", ApiManagementServiceArgs.builder()
.location("East US")
.natGatewayState("Enabled")
.publisherEmail("apim@autorestsdk.com")
.publisherName("autorestsdk")
.resourceGroupName("rg1")
.serviceName("apimService1")
.sku(ApiManagementServiceSkuPropertiesArgs.builder()
.capacity(1)
.name("Premium")
.build())
.tags(Map.ofEntries(
Map.entry("tag1", "value1"),
Map.entry("tag2", "value2"),
Map.entry("tag3", "value3")
))
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiManagementService = new azure_native.apimanagement.ApiManagementService("apiManagementService", {
location: "East US",
natGatewayState: azure_native.apimanagement.NatGatewayState.Enabled,
publisherEmail: "apim@autorestsdk.com",
publisherName: "autorestsdk",
resourceGroupName: "rg1",
serviceName: "apimService1",
sku: {
capacity: 1,
name: azure_native.apimanagement.SkuType.Premium,
},
tags: {
tag1: "value1",
tag2: "value2",
tag3: "value3",
},
});
import pulumi
import pulumi_azure_native as azure_native
api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
location="East US",
nat_gateway_state=azure_native.apimanagement.NatGatewayState.ENABLED,
publisher_email="apim@autorestsdk.com",
publisher_name="autorestsdk",
resource_group_name="rg1",
service_name="apimService1",
sku={
"capacity": 1,
"name": azure_native.apimanagement.SkuType.PREMIUM,
},
tags={
"tag1": "value1",
"tag2": "value2",
"tag3": "value3",
})
resources:
apiManagementService:
type: azure-native:apimanagement:ApiManagementService
properties:
location: East US
natGatewayState: Enabled
publisherEmail: apim@autorestsdk.com
publisherName: autorestsdk
resourceGroupName: rg1
serviceName: apimService1
sku:
capacity: 1
name: Premium
tags:
tag1: value1
tag2: value2
tag3: value3
ApiManagementCreateServiceWithSystemCertificates
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new()
{
Certificates = new[]
{
new AzureNative.ApiManagement.Inputs.CertificateConfigurationArgs
{
CertificatePassword = "Password",
EncodedCertificate = "*******Base64 encoded Certificate******************",
StoreName = "CertificateAuthority",
},
},
Location = "Central US",
PublisherEmail = "apim@autorestsdk.com",
PublisherName = "autorestsdk",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
{
Capacity = 1,
Name = AzureNative.ApiManagement.SkuType.Basic,
},
Tags =
{
{ "tag1", "value1" },
{ "tag2", "value2" },
{ "tag3", "value3" },
},
});
});
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.NewApiManagementService(ctx, "apiManagementService", &apimanagement.ApiManagementServiceArgs{
Certificates: apimanagement.CertificateConfigurationArray{
&apimanagement.CertificateConfigurationArgs{
CertificatePassword: pulumi.String("Password"),
EncodedCertificate: pulumi.String("*******Base64 encoded Certificate******************"),
StoreName: pulumi.String("CertificateAuthority"),
},
},
Location: pulumi.String("Central US"),
PublisherEmail: pulumi.String("apim@autorestsdk.com"),
PublisherName: pulumi.String("autorestsdk"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
Capacity: pulumi.Int(1),
Name: pulumi.String(apimanagement.SkuTypeBasic),
},
Tags: pulumi.StringMap{
"tag1": pulumi.String("value1"),
"tag2": pulumi.String("value2"),
"tag3": pulumi.String("value3"),
},
})
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.ApiManagementService;
import com.pulumi.azurenative.apimanagement.ApiManagementServiceArgs;
import com.pulumi.azurenative.apimanagement.inputs.CertificateConfigurationArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementServiceSkuPropertiesArgs;
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 apiManagementService = new ApiManagementService("apiManagementService", ApiManagementServiceArgs.builder()
.certificates(CertificateConfigurationArgs.builder()
.certificatePassword("Password")
.encodedCertificate("*******Base64 encoded Certificate******************")
.storeName("CertificateAuthority")
.build())
.location("Central US")
.publisherEmail("apim@autorestsdk.com")
.publisherName("autorestsdk")
.resourceGroupName("rg1")
.serviceName("apimService1")
.sku(ApiManagementServiceSkuPropertiesArgs.builder()
.capacity(1)
.name("Basic")
.build())
.tags(Map.ofEntries(
Map.entry("tag1", "value1"),
Map.entry("tag2", "value2"),
Map.entry("tag3", "value3")
))
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiManagementService = new azure_native.apimanagement.ApiManagementService("apiManagementService", {
certificates: [{
certificatePassword: "Password",
encodedCertificate: "*******Base64 encoded Certificate******************",
storeName: "CertificateAuthority",
}],
location: "Central US",
publisherEmail: "apim@autorestsdk.com",
publisherName: "autorestsdk",
resourceGroupName: "rg1",
serviceName: "apimService1",
sku: {
capacity: 1,
name: azure_native.apimanagement.SkuType.Basic,
},
tags: {
tag1: "value1",
tag2: "value2",
tag3: "value3",
},
});
import pulumi
import pulumi_azure_native as azure_native
api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
certificates=[{
"certificate_password": "Password",
"encoded_certificate": "*******Base64 encoded Certificate******************",
"store_name": "CertificateAuthority",
}],
location="Central US",
publisher_email="apim@autorestsdk.com",
publisher_name="autorestsdk",
resource_group_name="rg1",
service_name="apimService1",
sku={
"capacity": 1,
"name": azure_native.apimanagement.SkuType.BASIC,
},
tags={
"tag1": "value1",
"tag2": "value2",
"tag3": "value3",
})
resources:
apiManagementService:
type: azure-native:apimanagement:ApiManagementService
properties:
certificates:
- certificatePassword: Password
encodedCertificate: '*******Base64 encoded Certificate******************'
storeName: CertificateAuthority
location: Central US
publisherEmail: apim@autorestsdk.com
publisherName: autorestsdk
resourceGroupName: rg1
serviceName: apimService1
sku:
capacity: 1
name: Basic
tags:
tag1: value1
tag2: value2
tag3: value3
ApiManagementCreateServiceWithUserAssignedIdentity
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new()
{
Identity = new AzureNative.ApiManagement.Inputs.ApiManagementServiceIdentityArgs
{
Type = AzureNative.ApiManagement.ApimIdentityType.UserAssigned,
UserAssignedIdentities =
{
{ "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1", null },
},
},
Location = "West US",
PublisherEmail = "apim@autorestsdk.com",
PublisherName = "autorestsdk",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
{
Capacity = 0,
Name = AzureNative.ApiManagement.SkuType.Consumption,
},
Tags =
{
{ "tag1", "value1" },
{ "tag2", "value2" },
{ "tag3", "value3" },
},
});
});
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.NewApiManagementService(ctx, "apiManagementService", &apimanagement.ApiManagementServiceArgs{
Identity: &apimanagement.ApiManagementServiceIdentityArgs{
Type: pulumi.String(apimanagement.ApimIdentityTypeUserAssigned),
UserAssignedIdentities: apimanagement.UserIdentityPropertiesMap{
"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": &apimanagement.UserIdentityPropertiesArgs{},
},
},
Location: pulumi.String("West US"),
PublisherEmail: pulumi.String("apim@autorestsdk.com"),
PublisherName: pulumi.String("autorestsdk"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
Capacity: pulumi.Int(0),
Name: pulumi.String(apimanagement.SkuTypeConsumption),
},
Tags: pulumi.StringMap{
"tag1": pulumi.String("value1"),
"tag2": pulumi.String("value2"),
"tag3": pulumi.String("value3"),
},
})
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.ApiManagementService;
import com.pulumi.azurenative.apimanagement.ApiManagementServiceArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementServiceIdentityArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementServiceSkuPropertiesArgs;
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 apiManagementService = new ApiManagementService("apiManagementService", ApiManagementServiceArgs.builder()
.identity(ApiManagementServiceIdentityArgs.builder()
.type("UserAssigned")
.userAssignedIdentities(Map.of("/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1", ))
.build())
.location("West US")
.publisherEmail("apim@autorestsdk.com")
.publisherName("autorestsdk")
.resourceGroupName("rg1")
.serviceName("apimService1")
.sku(ApiManagementServiceSkuPropertiesArgs.builder()
.capacity(0)
.name("Consumption")
.build())
.tags(Map.ofEntries(
Map.entry("tag1", "value1"),
Map.entry("tag2", "value2"),
Map.entry("tag3", "value3")
))
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiManagementService = new azure_native.apimanagement.ApiManagementService("apiManagementService", {
identity: {
type: azure_native.apimanagement.ApimIdentityType.UserAssigned,
userAssignedIdentities: {
"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {},
},
},
location: "West US",
publisherEmail: "apim@autorestsdk.com",
publisherName: "autorestsdk",
resourceGroupName: "rg1",
serviceName: "apimService1",
sku: {
capacity: 0,
name: azure_native.apimanagement.SkuType.Consumption,
},
tags: {
tag1: "value1",
tag2: "value2",
tag3: "value3",
},
});
import pulumi
import pulumi_azure_native as azure_native
api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
identity={
"type": azure_native.apimanagement.ApimIdentityType.USER_ASSIGNED,
"user_assigned_identities": {
"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": {},
},
},
location="West US",
publisher_email="apim@autorestsdk.com",
publisher_name="autorestsdk",
resource_group_name="rg1",
service_name="apimService1",
sku={
"capacity": 0,
"name": azure_native.apimanagement.SkuType.CONSUMPTION,
},
tags={
"tag1": "value1",
"tag2": "value2",
"tag3": "value3",
})
resources:
apiManagementService:
type: azure-native:apimanagement:ApiManagementService
properties:
identity:
type: UserAssigned
userAssignedIdentities:
/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1: {}
location: West US
publisherEmail: apim@autorestsdk.com
publisherName: autorestsdk
resourceGroupName: rg1
serviceName: apimService1
sku:
capacity: 0
name: Consumption
tags:
tag1: value1
tag2: value2
tag3: value3
ApiManagementUndelete
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new()
{
Location = "South Central US",
PublisherEmail = "foo@contoso.com",
PublisherName = "foo",
ResourceGroupName = "rg1",
Restore = true,
ServiceName = "apimService1",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
{
Capacity = 1,
Name = AzureNative.ApiManagement.SkuType.Developer,
},
});
});
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.NewApiManagementService(ctx, "apiManagementService", &apimanagement.ApiManagementServiceArgs{
Location: pulumi.String("South Central US"),
PublisherEmail: pulumi.String("foo@contoso.com"),
PublisherName: pulumi.String("foo"),
ResourceGroupName: pulumi.String("rg1"),
Restore: pulumi.Bool(true),
ServiceName: pulumi.String("apimService1"),
Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
Capacity: pulumi.Int(1),
Name: pulumi.String(apimanagement.SkuTypeDeveloper),
},
})
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.ApiManagementService;
import com.pulumi.azurenative.apimanagement.ApiManagementServiceArgs;
import com.pulumi.azurenative.apimanagement.inputs.ApiManagementServiceSkuPropertiesArgs;
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 apiManagementService = new ApiManagementService("apiManagementService", ApiManagementServiceArgs.builder()
.location("South Central US")
.publisherEmail("foo@contoso.com")
.publisherName("foo")
.resourceGroupName("rg1")
.restore(true)
.serviceName("apimService1")
.sku(ApiManagementServiceSkuPropertiesArgs.builder()
.capacity(1)
.name("Developer")
.build())
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiManagementService = new azure_native.apimanagement.ApiManagementService("apiManagementService", {
location: "South Central US",
publisherEmail: "foo@contoso.com",
publisherName: "foo",
resourceGroupName: "rg1",
restore: true,
serviceName: "apimService1",
sku: {
capacity: 1,
name: azure_native.apimanagement.SkuType.Developer,
},
});
import pulumi
import pulumi_azure_native as azure_native
api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
location="South Central US",
publisher_email="foo@contoso.com",
publisher_name="foo",
resource_group_name="rg1",
restore=True,
service_name="apimService1",
sku={
"capacity": 1,
"name": azure_native.apimanagement.SkuType.DEVELOPER,
})
resources:
apiManagementService:
type: azure-native:apimanagement:ApiManagementService
properties:
location: South Central US
publisherEmail: foo@contoso.com
publisherName: foo
resourceGroupName: rg1
restore: true
serviceName: apimService1
sku:
capacity: 1
name: Developer
Create ApiManagementService Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApiManagementService(name: string, args: ApiManagementServiceArgs, opts?: CustomResourceOptions);@overload
def ApiManagementService(resource_name: str,
args: ApiManagementServiceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ApiManagementService(resource_name: str,
opts: Optional[ResourceOptions] = None,
publisher_email: Optional[str] = None,
sku: Optional[ApiManagementServiceSkuPropertiesArgs] = None,
resource_group_name: Optional[str] = None,
publisher_name: Optional[str] = None,
public_ip_address_id: Optional[str] = None,
public_network_access: Optional[Union[str, PublicNetworkAccess]] = None,
hostname_configurations: Optional[Sequence[HostnameConfigurationArgs]] = None,
identity: Optional[ApiManagementServiceIdentityArgs] = None,
location: Optional[str] = None,
nat_gateway_state: Optional[Union[str, NatGatewayState]] = None,
notification_sender_email: Optional[str] = None,
private_endpoint_connections: Optional[Sequence[RemotePrivateEndpointConnectionWrapperArgs]] = None,
additional_locations: Optional[Sequence[AdditionalLocationArgs]] = None,
enable_client_certificate: Optional[bool] = None,
disable_gateway: Optional[bool] = None,
custom_properties: Optional[Mapping[str, str]] = None,
certificates: Optional[Sequence[CertificateConfigurationArgs]] = None,
restore: Optional[bool] = None,
service_name: Optional[str] = None,
api_version_constraint: Optional[ApiVersionConstraintArgs] = None,
tags: Optional[Mapping[str, str]] = None,
virtual_network_configuration: Optional[VirtualNetworkConfigurationArgs] = None,
virtual_network_type: Optional[Union[str, VirtualNetworkType]] = None,
zones: Optional[Sequence[str]] = None)func NewApiManagementService(ctx *Context, name string, args ApiManagementServiceArgs, opts ...ResourceOption) (*ApiManagementService, error)public ApiManagementService(string name, ApiManagementServiceArgs args, CustomResourceOptions? opts = null)
public ApiManagementService(String name, ApiManagementServiceArgs args)
public ApiManagementService(String name, ApiManagementServiceArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:ApiManagementService
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 ApiManagementServiceArgs
- 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 ApiManagementServiceArgs
- 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 ApiManagementServiceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiManagementServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiManagementServiceArgs
- 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 apiManagementServiceResource = new AzureNative.ApiManagement.ApiManagementService("apiManagementServiceResource", new()
{
PublisherEmail = "string",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
{
Capacity = 0,
Name = "string",
},
ResourceGroupName = "string",
PublisherName = "string",
PublicIpAddressId = "string",
PublicNetworkAccess = "string",
HostnameConfigurations = new[]
{
new AzureNative.ApiManagement.Inputs.HostnameConfigurationArgs
{
HostName = "string",
Type = "string",
Certificate = new AzureNative.ApiManagement.Inputs.CertificateInformationArgs
{
Expiry = "string",
Subject = "string",
Thumbprint = "string",
},
CertificatePassword = "string",
CertificateSource = "string",
CertificateStatus = "string",
DefaultSslBinding = false,
EncodedCertificate = "string",
IdentityClientId = "string",
KeyVaultId = "string",
NegotiateClientCertificate = false,
},
},
Identity = new AzureNative.ApiManagement.Inputs.ApiManagementServiceIdentityArgs
{
Type = "string",
UserAssignedIdentities =
{
{ "string", new AzureNative.ApiManagement.Inputs.UserIdentityPropertiesArgs
{
ClientId = "string",
PrincipalId = "string",
} },
},
},
Location = "string",
NatGatewayState = "string",
NotificationSenderEmail = "string",
PrivateEndpointConnections = new[]
{
new AzureNative.ApiManagement.Inputs.RemotePrivateEndpointConnectionWrapperArgs
{
PrivateLinkServiceConnectionState = new AzureNative.ApiManagement.Inputs.PrivateLinkServiceConnectionStateArgs
{
ActionsRequired = "string",
Description = "string",
Status = "string",
},
Id = "string",
Name = "string",
Type = "string",
},
},
AdditionalLocations = new[]
{
new AzureNative.ApiManagement.Inputs.AdditionalLocationArgs
{
Location = "string",
Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
{
Capacity = 0,
Name = "string",
},
DisableGateway = false,
NatGatewayState = "string",
PublicIpAddressId = "string",
VirtualNetworkConfiguration = new AzureNative.ApiManagement.Inputs.VirtualNetworkConfigurationArgs
{
SubnetResourceId = "string",
},
Zones = new[]
{
"string",
},
},
},
EnableClientCertificate = false,
DisableGateway = false,
CustomProperties =
{
{ "string", "string" },
},
Certificates = new[]
{
new AzureNative.ApiManagement.Inputs.CertificateConfigurationArgs
{
StoreName = "string",
Certificate = new AzureNative.ApiManagement.Inputs.CertificateInformationArgs
{
Expiry = "string",
Subject = "string",
Thumbprint = "string",
},
CertificatePassword = "string",
EncodedCertificate = "string",
},
},
Restore = false,
ServiceName = "string",
ApiVersionConstraint = new AzureNative.ApiManagement.Inputs.ApiVersionConstraintArgs
{
MinApiVersion = "string",
},
Tags =
{
{ "string", "string" },
},
VirtualNetworkConfiguration = new AzureNative.ApiManagement.Inputs.VirtualNetworkConfigurationArgs
{
SubnetResourceId = "string",
},
VirtualNetworkType = "string",
Zones = new[]
{
"string",
},
});
example, err := apimanagement.NewApiManagementService(ctx, "apiManagementServiceResource", &apimanagement.ApiManagementServiceArgs{
PublisherEmail: pulumi.String("string"),
Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
Capacity: pulumi.Int(0),
Name: pulumi.String("string"),
},
ResourceGroupName: pulumi.String("string"),
PublisherName: pulumi.String("string"),
PublicIpAddressId: pulumi.String("string"),
PublicNetworkAccess: pulumi.String("string"),
HostnameConfigurations: apimanagement.HostnameConfigurationArray{
&apimanagement.HostnameConfigurationArgs{
HostName: pulumi.String("string"),
Type: pulumi.String("string"),
Certificate: &apimanagement.CertificateInformationArgs{
Expiry: pulumi.String("string"),
Subject: pulumi.String("string"),
Thumbprint: pulumi.String("string"),
},
CertificatePassword: pulumi.String("string"),
CertificateSource: pulumi.String("string"),
CertificateStatus: pulumi.String("string"),
DefaultSslBinding: pulumi.Bool(false),
EncodedCertificate: pulumi.String("string"),
IdentityClientId: pulumi.String("string"),
KeyVaultId: pulumi.String("string"),
NegotiateClientCertificate: pulumi.Bool(false),
},
},
Identity: &apimanagement.ApiManagementServiceIdentityArgs{
Type: pulumi.String("string"),
UserAssignedIdentities: apimanagement.UserIdentityPropertiesMap{
"string": &apimanagement.UserIdentityPropertiesArgs{
ClientId: pulumi.String("string"),
PrincipalId: pulumi.String("string"),
},
},
},
Location: pulumi.String("string"),
NatGatewayState: pulumi.String("string"),
NotificationSenderEmail: pulumi.String("string"),
PrivateEndpointConnections: apimanagement.RemotePrivateEndpointConnectionWrapperArray{
&apimanagement.RemotePrivateEndpointConnectionWrapperArgs{
PrivateLinkServiceConnectionState: &apimanagement.PrivateLinkServiceConnectionStateArgs{
ActionsRequired: pulumi.String("string"),
Description: pulumi.String("string"),
Status: pulumi.String("string"),
},
Id: pulumi.String("string"),
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
AdditionalLocations: apimanagement.AdditionalLocationArray{
&apimanagement.AdditionalLocationArgs{
Location: pulumi.String("string"),
Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
Capacity: pulumi.Int(0),
Name: pulumi.String("string"),
},
DisableGateway: pulumi.Bool(false),
NatGatewayState: pulumi.String("string"),
PublicIpAddressId: pulumi.String("string"),
VirtualNetworkConfiguration: &apimanagement.VirtualNetworkConfigurationArgs{
SubnetResourceId: pulumi.String("string"),
},
Zones: pulumi.StringArray{
pulumi.String("string"),
},
},
},
EnableClientCertificate: pulumi.Bool(false),
DisableGateway: pulumi.Bool(false),
CustomProperties: pulumi.StringMap{
"string": pulumi.String("string"),
},
Certificates: apimanagement.CertificateConfigurationArray{
&apimanagement.CertificateConfigurationArgs{
StoreName: pulumi.String("string"),
Certificate: &apimanagement.CertificateInformationArgs{
Expiry: pulumi.String("string"),
Subject: pulumi.String("string"),
Thumbprint: pulumi.String("string"),
},
CertificatePassword: pulumi.String("string"),
EncodedCertificate: pulumi.String("string"),
},
},
Restore: pulumi.Bool(false),
ServiceName: pulumi.String("string"),
ApiVersionConstraint: &apimanagement.ApiVersionConstraintArgs{
MinApiVersion: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
VirtualNetworkConfiguration: &apimanagement.VirtualNetworkConfigurationArgs{
SubnetResourceId: pulumi.String("string"),
},
VirtualNetworkType: pulumi.String("string"),
Zones: pulumi.StringArray{
pulumi.String("string"),
},
})
var apiManagementServiceResource = new ApiManagementService("apiManagementServiceResource", ApiManagementServiceArgs.builder()
.publisherEmail("string")
.sku(ApiManagementServiceSkuPropertiesArgs.builder()
.capacity(0)
.name("string")
.build())
.resourceGroupName("string")
.publisherName("string")
.publicIpAddressId("string")
.publicNetworkAccess("string")
.hostnameConfigurations(HostnameConfigurationArgs.builder()
.hostName("string")
.type("string")
.certificate(CertificateInformationArgs.builder()
.expiry("string")
.subject("string")
.thumbprint("string")
.build())
.certificatePassword("string")
.certificateSource("string")
.certificateStatus("string")
.defaultSslBinding(false)
.encodedCertificate("string")
.identityClientId("string")
.keyVaultId("string")
.negotiateClientCertificate(false)
.build())
.identity(ApiManagementServiceIdentityArgs.builder()
.type("string")
.userAssignedIdentities(Map.of("string", Map.ofEntries(
Map.entry("clientId", "string"),
Map.entry("principalId", "string")
)))
.build())
.location("string")
.natGatewayState("string")
.notificationSenderEmail("string")
.privateEndpointConnections(RemotePrivateEndpointConnectionWrapperArgs.builder()
.privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
.actionsRequired("string")
.description("string")
.status("string")
.build())
.id("string")
.name("string")
.type("string")
.build())
.additionalLocations(AdditionalLocationArgs.builder()
.location("string")
.sku(ApiManagementServiceSkuPropertiesArgs.builder()
.capacity(0)
.name("string")
.build())
.disableGateway(false)
.natGatewayState("string")
.publicIpAddressId("string")
.virtualNetworkConfiguration(VirtualNetworkConfigurationArgs.builder()
.subnetResourceId("string")
.build())
.zones("string")
.build())
.enableClientCertificate(false)
.disableGateway(false)
.customProperties(Map.of("string", "string"))
.certificates(CertificateConfigurationArgs.builder()
.storeName("string")
.certificate(CertificateInformationArgs.builder()
.expiry("string")
.subject("string")
.thumbprint("string")
.build())
.certificatePassword("string")
.encodedCertificate("string")
.build())
.restore(false)
.serviceName("string")
.apiVersionConstraint(ApiVersionConstraintArgs.builder()
.minApiVersion("string")
.build())
.tags(Map.of("string", "string"))
.virtualNetworkConfiguration(VirtualNetworkConfigurationArgs.builder()
.subnetResourceId("string")
.build())
.virtualNetworkType("string")
.zones("string")
.build());
api_management_service_resource = azure_native.apimanagement.ApiManagementService("apiManagementServiceResource",
publisher_email="string",
sku={
"capacity": 0,
"name": "string",
},
resource_group_name="string",
publisher_name="string",
public_ip_address_id="string",
public_network_access="string",
hostname_configurations=[{
"host_name": "string",
"type": "string",
"certificate": {
"expiry": "string",
"subject": "string",
"thumbprint": "string",
},
"certificate_password": "string",
"certificate_source": "string",
"certificate_status": "string",
"default_ssl_binding": False,
"encoded_certificate": "string",
"identity_client_id": "string",
"key_vault_id": "string",
"negotiate_client_certificate": False,
}],
identity={
"type": "string",
"user_assigned_identities": {
"string": {
"client_id": "string",
"principal_id": "string",
},
},
},
location="string",
nat_gateway_state="string",
notification_sender_email="string",
private_endpoint_connections=[{
"private_link_service_connection_state": {
"actions_required": "string",
"description": "string",
"status": "string",
},
"id": "string",
"name": "string",
"type": "string",
}],
additional_locations=[{
"location": "string",
"sku": {
"capacity": 0,
"name": "string",
},
"disable_gateway": False,
"nat_gateway_state": "string",
"public_ip_address_id": "string",
"virtual_network_configuration": {
"subnet_resource_id": "string",
},
"zones": ["string"],
}],
enable_client_certificate=False,
disable_gateway=False,
custom_properties={
"string": "string",
},
certificates=[{
"store_name": "string",
"certificate": {
"expiry": "string",
"subject": "string",
"thumbprint": "string",
},
"certificate_password": "string",
"encoded_certificate": "string",
}],
restore=False,
service_name="string",
api_version_constraint={
"min_api_version": "string",
},
tags={
"string": "string",
},
virtual_network_configuration={
"subnet_resource_id": "string",
},
virtual_network_type="string",
zones=["string"])
const apiManagementServiceResource = new azure_native.apimanagement.ApiManagementService("apiManagementServiceResource", {
publisherEmail: "string",
sku: {
capacity: 0,
name: "string",
},
resourceGroupName: "string",
publisherName: "string",
publicIpAddressId: "string",
publicNetworkAccess: "string",
hostnameConfigurations: [{
hostName: "string",
type: "string",
certificate: {
expiry: "string",
subject: "string",
thumbprint: "string",
},
certificatePassword: "string",
certificateSource: "string",
certificateStatus: "string",
defaultSslBinding: false,
encodedCertificate: "string",
identityClientId: "string",
keyVaultId: "string",
negotiateClientCertificate: false,
}],
identity: {
type: "string",
userAssignedIdentities: {
string: {
clientId: "string",
principalId: "string",
},
},
},
location: "string",
natGatewayState: "string",
notificationSenderEmail: "string",
privateEndpointConnections: [{
privateLinkServiceConnectionState: {
actionsRequired: "string",
description: "string",
status: "string",
},
id: "string",
name: "string",
type: "string",
}],
additionalLocations: [{
location: "string",
sku: {
capacity: 0,
name: "string",
},
disableGateway: false,
natGatewayState: "string",
publicIpAddressId: "string",
virtualNetworkConfiguration: {
subnetResourceId: "string",
},
zones: ["string"],
}],
enableClientCertificate: false,
disableGateway: false,
customProperties: {
string: "string",
},
certificates: [{
storeName: "string",
certificate: {
expiry: "string",
subject: "string",
thumbprint: "string",
},
certificatePassword: "string",
encodedCertificate: "string",
}],
restore: false,
serviceName: "string",
apiVersionConstraint: {
minApiVersion: "string",
},
tags: {
string: "string",
},
virtualNetworkConfiguration: {
subnetResourceId: "string",
},
virtualNetworkType: "string",
zones: ["string"],
});
type: azure-native:apimanagement:ApiManagementService
properties:
additionalLocations:
- disableGateway: false
location: string
natGatewayState: string
publicIpAddressId: string
sku:
capacity: 0
name: string
virtualNetworkConfiguration:
subnetResourceId: string
zones:
- string
apiVersionConstraint:
minApiVersion: string
certificates:
- certificate:
expiry: string
subject: string
thumbprint: string
certificatePassword: string
encodedCertificate: string
storeName: string
customProperties:
string: string
disableGateway: false
enableClientCertificate: false
hostnameConfigurations:
- certificate:
expiry: string
subject: string
thumbprint: string
certificatePassword: string
certificateSource: string
certificateStatus: string
defaultSslBinding: false
encodedCertificate: string
hostName: string
identityClientId: string
keyVaultId: string
negotiateClientCertificate: false
type: string
identity:
type: string
userAssignedIdentities:
string:
clientId: string
principalId: string
location: string
natGatewayState: string
notificationSenderEmail: string
privateEndpointConnections:
- id: string
name: string
privateLinkServiceConnectionState:
actionsRequired: string
description: string
status: string
type: string
publicIpAddressId: string
publicNetworkAccess: string
publisherEmail: string
publisherName: string
resourceGroupName: string
restore: false
serviceName: string
sku:
capacity: 0
name: string
tags:
string: string
virtualNetworkConfiguration:
subnetResourceId: string
virtualNetworkType: string
zones:
- string
ApiManagementService Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ApiManagementService resource accepts the following input properties:
- Publisher
Email string - Publisher email.
- Publisher
Name string - Publisher name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Sku
Pulumi.
Azure Native. Api Management. Inputs. Api Management Service Sku Properties - SKU properties of the API Management service.
- Additional
Locations List<Pulumi.Azure Native. Api Management. Inputs. Additional Location> - Additional datacenter locations of the API Management service.
- Api
Version Pulumi.Constraint Azure Native. Api Management. Inputs. Api Version Constraint - Control Plane Apis version constraint for the API Management service.
- Certificates
List<Pulumi.
Azure Native. Api Management. Inputs. Certificate Configuration> - List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
- Custom
Properties Dictionary<string, string> - Custom properties of the API Management service.Setting
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11can be used to disable just TLS 1.1.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10can be used to disable TLS 1.0 on an API Management service.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11can be used to disable just TLS 1.1 for communications with backends.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10can be used to disable TLS 1.0 for communications with backends.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value isTrueif the service was created on or before April 1, 2018 andFalseotherwise. Http2 setting's default value isFalse.You can disable any of the following ciphers by using settingsMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example,Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value istruefor them. Note: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - Disable
Gateway bool - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
- Enable
Client boolCertificate - Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.
- Hostname
Configurations List<Pulumi.Azure Native. Api Management. Inputs. Hostname Configuration> - Custom hostname configuration of the API Management service.
- Identity
Pulumi.
Azure Native. Api Management. Inputs. Api Management Service Identity - Managed service identity of the Api Management service.
- Location string
- Resource location.
- Nat
Gateway string | Pulumi.State Azure Native. Api Management. Nat Gateway State - Property can be used to enable NAT Gateway for this API Management service.
- Notification
Sender stringEmail - Email address from which the notification will be sent.
- Private
Endpoint List<Pulumi.Connections Azure Native. Api Management. Inputs. Remote Private Endpoint Connection Wrapper> - List of Private Endpoint Connections of this service.
- Public
Ip stringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network.
- Public
Network string | Pulumi.Access Azure Native. Api Management. Public Network Access - Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'
- Restore bool
- Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.
- Service
Name string - The name of the API Management service.
- Dictionary<string, string>
- Resource tags.
- Virtual
Network Pulumi.Configuration Azure Native. Api Management. Inputs. Virtual Network Configuration - Virtual network configuration of the API Management service.
- Virtual
Network string | Pulumi.Type Azure Native. Api Management. Virtual Network Type - The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.
- Zones List<string>
- A list of availability zones denoting where the resource needs to come from.
- Publisher
Email string - Publisher email.
- Publisher
Name string - Publisher name.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Sku
Api
Management Service Sku Properties Args - SKU properties of the API Management service.
- Additional
Locations []AdditionalLocation Args - Additional datacenter locations of the API Management service.
- Api
Version ApiConstraint Version Constraint Args - Control Plane Apis version constraint for the API Management service.
- Certificates
[]Certificate
Configuration Args - List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
- Custom
Properties map[string]string - Custom properties of the API Management service.Setting
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11can be used to disable just TLS 1.1.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10can be used to disable TLS 1.0 on an API Management service.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11can be used to disable just TLS 1.1 for communications with backends.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10can be used to disable TLS 1.0 for communications with backends.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value isTrueif the service was created on or before April 1, 2018 andFalseotherwise. Http2 setting's default value isFalse.You can disable any of the following ciphers by using settingsMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example,Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value istruefor them. Note: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - Disable
Gateway bool - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
- Enable
Client boolCertificate - Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.
- Hostname
Configurations []HostnameConfiguration Args - Custom hostname configuration of the API Management service.
- Identity
Api
Management Service Identity Args - Managed service identity of the Api Management service.
- Location string
- Resource location.
- Nat
Gateway string | NatState Gateway State - Property can be used to enable NAT Gateway for this API Management service.
- Notification
Sender stringEmail - Email address from which the notification will be sent.
- Private
Endpoint []RemoteConnections Private Endpoint Connection Wrapper Args - List of Private Endpoint Connections of this service.
- Public
Ip stringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network.
- Public
Network string | PublicAccess Network Access - Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'
- Restore bool
- Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.
- Service
Name string - The name of the API Management service.
- map[string]string
- Resource tags.
- Virtual
Network VirtualConfiguration Network Configuration Args - Virtual network configuration of the API Management service.
- Virtual
Network string | VirtualType Network Type - The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.
- Zones []string
- A list of availability zones denoting where the resource needs to come from.
- publisher
Email String - Publisher email.
- publisher
Name String - Publisher name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- sku
Api
Management Service Sku Properties - SKU properties of the API Management service.
- additional
Locations List<AdditionalLocation> - Additional datacenter locations of the API Management service.
- api
Version ApiConstraint Version Constraint - Control Plane Apis version constraint for the API Management service.
- certificates
List<Certificate
Configuration> - List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
- custom
Properties Map<String,String> - Custom properties of the API Management service.Setting
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11can be used to disable just TLS 1.1.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10can be used to disable TLS 1.0 on an API Management service.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11can be used to disable just TLS 1.1 for communications with backends.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10can be used to disable TLS 1.0 for communications with backends.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value isTrueif the service was created on or before April 1, 2018 andFalseotherwise. Http2 setting's default value isFalse.You can disable any of the following ciphers by using settingsMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example,Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value istruefor them. Note: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - disable
Gateway Boolean - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
- enable
Client BooleanCertificate - Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.
- hostname
Configurations List<HostnameConfiguration> - Custom hostname configuration of the API Management service.
- identity
Api
Management Service Identity - Managed service identity of the Api Management service.
- location String
- Resource location.
- nat
Gateway String | NatState Gateway State - Property can be used to enable NAT Gateway for this API Management service.
- notification
Sender StringEmail - Email address from which the notification will be sent.
- private
Endpoint List<RemoteConnections Private Endpoint Connection Wrapper> - List of Private Endpoint Connections of this service.
- public
Ip StringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network.
- public
Network String | PublicAccess Network Access - Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'
- restore Boolean
- Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.
- service
Name String - The name of the API Management service.
- Map<String,String>
- Resource tags.
- virtual
Network VirtualConfiguration Network Configuration - Virtual network configuration of the API Management service.
- virtual
Network String | VirtualType Network Type - The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.
- zones List<String>
- A list of availability zones denoting where the resource needs to come from.
- publisher
Email string - Publisher email.
- publisher
Name string - Publisher name.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- sku
Api
Management Service Sku Properties - SKU properties of the API Management service.
- additional
Locations AdditionalLocation[] - Additional datacenter locations of the API Management service.
- api
Version ApiConstraint Version Constraint - Control Plane Apis version constraint for the API Management service.
- certificates
Certificate
Configuration[] - List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
- custom
Properties {[key: string]: string} - Custom properties of the API Management service.Setting
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11can be used to disable just TLS 1.1.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10can be used to disable TLS 1.0 on an API Management service.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11can be used to disable just TLS 1.1 for communications with backends.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10can be used to disable TLS 1.0 for communications with backends.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value isTrueif the service was created on or before April 1, 2018 andFalseotherwise. Http2 setting's default value isFalse.You can disable any of the following ciphers by using settingsMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example,Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value istruefor them. Note: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - disable
Gateway boolean - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
- enable
Client booleanCertificate - Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.
- hostname
Configurations HostnameConfiguration[] - Custom hostname configuration of the API Management service.
- identity
Api
Management Service Identity - Managed service identity of the Api Management service.
- location string
- Resource location.
- nat
Gateway string | NatState Gateway State - Property can be used to enable NAT Gateway for this API Management service.
- notification
Sender stringEmail - Email address from which the notification will be sent.
- private
Endpoint RemoteConnections Private Endpoint Connection Wrapper[] - List of Private Endpoint Connections of this service.
- public
Ip stringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network.
- public
Network string | PublicAccess Network Access - Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'
- restore boolean
- Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.
- service
Name string - The name of the API Management service.
- {[key: string]: string}
- Resource tags.
- virtual
Network VirtualConfiguration Network Configuration - Virtual network configuration of the API Management service.
- virtual
Network string | VirtualType Network Type - The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.
- zones string[]
- A list of availability zones denoting where the resource needs to come from.
- publisher_
email str - Publisher email.
- publisher_
name str - Publisher name.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- sku
Api
Management Service Sku Properties Args - SKU properties of the API Management service.
- additional_
locations Sequence[AdditionalLocation Args] - Additional datacenter locations of the API Management service.
- api_
version_ Apiconstraint Version Constraint Args - Control Plane Apis version constraint for the API Management service.
- certificates
Sequence[Certificate
Configuration Args] - List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
- custom_
properties Mapping[str, str] - Custom properties of the API Management service.Setting
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11can be used to disable just TLS 1.1.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10can be used to disable TLS 1.0 on an API Management service.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11can be used to disable just TLS 1.1 for communications with backends.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10can be used to disable TLS 1.0 for communications with backends.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value isTrueif the service was created on or before April 1, 2018 andFalseotherwise. Http2 setting's default value isFalse.You can disable any of the following ciphers by using settingsMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example,Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value istruefor them. Note: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - disable_
gateway bool - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
- enable_
client_ boolcertificate - Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.
- hostname_
configurations Sequence[HostnameConfiguration Args] - Custom hostname configuration of the API Management service.
- identity
Api
Management Service Identity Args - Managed service identity of the Api Management service.
- location str
- Resource location.
- nat_
gateway_ str | Natstate Gateway State - Property can be used to enable NAT Gateway for this API Management service.
- notification_
sender_ stremail - Email address from which the notification will be sent.
- private_
endpoint_ Sequence[Remoteconnections Private Endpoint Connection Wrapper Args] - List of Private Endpoint Connections of this service.
- public_
ip_ straddress_ id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network.
- public_
network_ str | Publicaccess Network Access - Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'
- restore bool
- Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.
- service_
name str - The name of the API Management service.
- Mapping[str, str]
- Resource tags.
- virtual_
network_ Virtualconfiguration Network Configuration Args - Virtual network configuration of the API Management service.
- virtual_
network_ str | Virtualtype Network Type - The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.
- zones Sequence[str]
- A list of availability zones denoting where the resource needs to come from.
- publisher
Email String - Publisher email.
- publisher
Name String - Publisher name.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- sku Property Map
- SKU properties of the API Management service.
- additional
Locations List<Property Map> - Additional datacenter locations of the API Management service.
- api
Version Property MapConstraint - Control Plane Apis version constraint for the API Management service.
- certificates List<Property Map>
- List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
- custom
Properties Map<String> - Custom properties of the API Management service.Setting
Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11can be used to disable just TLS 1.1.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10can be used to disable TLS 1.0 on an API Management service.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11can be used to disable just TLS 1.1 for communications with backends.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10can be used to disable TLS 1.0 for communications with backends.SettingMicrosoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties' values to their defaults. For all the settings except Http2 the default value isTrueif the service was created on or before April 1, 2018 andFalseotherwise. Http2 setting's default value isFalse.You can disable any of the following ciphers by using settingsMicrosoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example,Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. The default value istruefor them. Note: The following ciphers can't be disabled since they are required by internal platform components: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - disable
Gateway Boolean - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
- enable
Client BooleanCertificate - Property only meant to be used for Consumption SKU Service. This enforces a client certificate to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the policy on the gateway.
- hostname
Configurations List<Property Map> - Custom hostname configuration of the API Management service.
- identity Property Map
- Managed service identity of the Api Management service.
- location String
- Resource location.
- nat
Gateway String | "Enabled" | "Disabled"State - Property can be used to enable NAT Gateway for this API Management service.
- notification
Sender StringEmail - Email address from which the notification will be sent.
- private
Endpoint List<Property Map>Connections - List of Private Endpoint Connections of this service.
- public
Ip StringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network.
- public
Network String | "Enabled" | "Disabled"Access - Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'
- restore Boolean
- Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True all other properties will be ignored.
- service
Name String - The name of the API Management service.
- Map<String>
- Resource tags.
- virtual
Network Property MapConfiguration - Virtual network configuration of the API Management service.
- virtual
Network String | "None" | "External" | "Internal"Type - The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.
- zones List<String>
- A list of availability zones denoting where the resource needs to come from.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApiManagementService resource produces the following output properties:
- Created
At stringUtc - Creation UTC date of the API Management service.The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - Developer
Portal stringUrl - DEveloper Portal endpoint URL of the API Management service.
- Etag string
- ETag of the resource.
- Gateway
Regional stringUrl - Gateway URL of the API Management service in the Default Region.
- Gateway
Url string - Gateway URL of the API Management service.
- Id string
- The provider-assigned unique ID for this managed resource.
- Management
Api stringUrl - Management API endpoint URL of the API Management service.
- Name string
- Resource name.
- Outbound
Public List<string>IPAddresses - Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
- Platform
Version string - Compute Platform Version running the service in this location.
- Portal
Url string - Publisher portal endpoint Url of the API Management service.
- Private
IPAddresses List<string> - Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.
- Provisioning
State string - The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
- Public
IPAddresses List<string> - Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
- Scm
Url string - SCM endpoint URL of the API Management service.
- 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 service, which is targeted by the long running operation started on the service.
- Type string
- Resource type for API Management resource is set to Microsoft.ApiManagement.
- Created
At stringUtc - Creation UTC date of the API Management service.The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - Developer
Portal stringUrl - DEveloper Portal endpoint URL of the API Management service.
- Etag string
- ETag of the resource.
- Gateway
Regional stringUrl - Gateway URL of the API Management service in the Default Region.
- Gateway
Url string - Gateway URL of the API Management service.
- Id string
- The provider-assigned unique ID for this managed resource.
- Management
Api stringUrl - Management API endpoint URL of the API Management service.
- Name string
- Resource name.
- Outbound
Public []stringIPAddresses - Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
- Platform
Version string - Compute Platform Version running the service in this location.
- Portal
Url string - Publisher portal endpoint Url of the API Management service.
- Private
IPAddresses []string - Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.
- Provisioning
State string - The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
- Public
IPAddresses []string - Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
- Scm
Url string - SCM endpoint URL of the API Management service.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- Target
Provisioning stringState - The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
- Type string
- Resource type for API Management resource is set to Microsoft.ApiManagement.
- created
At StringUtc - Creation UTC date of the API Management service.The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - developer
Portal StringUrl - DEveloper Portal endpoint URL of the API Management service.
- etag String
- ETag of the resource.
- gateway
Regional StringUrl - Gateway URL of the API Management service in the Default Region.
- gateway
Url String - Gateway URL of the API Management service.
- id String
- The provider-assigned unique ID for this managed resource.
- management
Api StringUrl - Management API endpoint URL of the API Management service.
- name String
- Resource name.
- outbound
Public List<String>IPAddresses - Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
- platform
Version String - Compute Platform Version running the service in this location.
- portal
Url String - Publisher portal endpoint Url of the API Management service.
- private
IPAddresses List<String> - Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.
- provisioning
State String - The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
- public
IPAddresses List<String> - Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
- scm
Url String - SCM endpoint URL of the API Management service.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- target
Provisioning StringState - The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
- type String
- Resource type for API Management resource is set to Microsoft.ApiManagement.
- created
At stringUtc - Creation UTC date of the API Management service.The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - developer
Portal stringUrl - DEveloper Portal endpoint URL of the API Management service.
- etag string
- ETag of the resource.
- gateway
Regional stringUrl - Gateway URL of the API Management service in the Default Region.
- gateway
Url string - Gateway URL of the API Management service.
- id string
- The provider-assigned unique ID for this managed resource.
- management
Api stringUrl - Management API endpoint URL of the API Management service.
- name string
- Resource name.
- outbound
Public string[]IPAddresses - Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
- platform
Version string - Compute Platform Version running the service in this location.
- portal
Url string - Publisher portal endpoint Url of the API Management service.
- private
IPAddresses string[] - Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.
- provisioning
State string - The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
- public
IPAddresses string[] - Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
- scm
Url string - SCM endpoint URL of the API Management service.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- target
Provisioning stringState - The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
- type string
- Resource type for API Management resource is set to Microsoft.ApiManagement.
- created_
at_ strutc - Creation UTC date of the API Management service.The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - developer_
portal_ strurl - DEveloper Portal endpoint URL of the API Management service.
- etag str
- ETag of the resource.
- gateway_
regional_ strurl - Gateway URL of the API Management service in the Default Region.
- gateway_
url str - Gateway URL of the API Management service.
- id str
- The provider-assigned unique ID for this managed resource.
- management_
api_ strurl - Management API endpoint URL of the API Management service.
- name str
- Resource name.
- outbound_
public_ Sequence[str]ip_ addresses - Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
- platform_
version str - Compute Platform Version running the service in this location.
- portal_
url str - Publisher portal endpoint Url of the API Management service.
- private_
ip_ Sequence[str]addresses - Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.
- provisioning_
state str - The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
- public_
ip_ Sequence[str]addresses - Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
- scm_
url str - SCM endpoint URL of the API Management service.
- system_
data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- target_
provisioning_ strstate - The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
- type str
- Resource type for API Management resource is set to Microsoft.ApiManagement.
- created
At StringUtc - Creation UTC date of the API Management service.The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - developer
Portal StringUrl - DEveloper Portal endpoint URL of the API Management service.
- etag String
- ETag of the resource.
- gateway
Regional StringUrl - Gateway URL of the API Management service in the Default Region.
- gateway
Url String - Gateway URL of the API Management service.
- id String
- The provider-assigned unique ID for this managed resource.
- management
Api StringUrl - Management API endpoint URL of the API Management service.
- name String
- Resource name.
- outbound
Public List<String>IPAddresses - Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
- platform
Version String - Compute Platform Version running the service in this location.
- portal
Url String - Publisher portal endpoint Url of the API Management service.
- private
IPAddresses List<String> - Private Static Load Balanced IP addresses of the API Management service in Primary region which is deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU.
- provisioning
State String - The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
- public
IPAddresses List<String> - Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
- scm
Url String - SCM endpoint URL of the API Management service.
- system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
- target
Provisioning StringState - The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
- type String
- Resource type for API Management resource is set to Microsoft.ApiManagement.
Supporting Types
AdditionalLocation, AdditionalLocationArgs
- Location string
- The location name of the additional region among Azure Data center regions.
- Sku
Pulumi.
Azure Native. Api Management. Inputs. Api Management Service Sku Properties - SKU properties of the API Management service.
- Disable
Gateway bool - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
- Nat
Gateway string | Pulumi.State Azure Native. Api Management. Nat Gateway State - Property can be used to enable NAT Gateway for this API Management service.
- Public
Ip stringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
- Virtual
Network Pulumi.Configuration Azure Native. Api Management. Inputs. Virtual Network Configuration - Virtual network configuration for the location.
- Zones List<string>
- A list of availability zones denoting where the resource needs to come from.
- Location string
- The location name of the additional region among Azure Data center regions.
- Sku
Api
Management Service Sku Properties - SKU properties of the API Management service.
- Disable
Gateway bool - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
- Nat
Gateway string | NatState Gateway State - Property can be used to enable NAT Gateway for this API Management service.
- Public
Ip stringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
- Virtual
Network VirtualConfiguration Network Configuration - Virtual network configuration for the location.
- Zones []string
- A list of availability zones denoting where the resource needs to come from.
- location String
- The location name of the additional region among Azure Data center regions.
- sku
Api
Management Service Sku Properties - SKU properties of the API Management service.
- disable
Gateway Boolean - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
- nat
Gateway String | NatState Gateway State - Property can be used to enable NAT Gateway for this API Management service.
- public
Ip StringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
- virtual
Network VirtualConfiguration Network Configuration - Virtual network configuration for the location.
- zones List<String>
- A list of availability zones denoting where the resource needs to come from.
- location string
- The location name of the additional region among Azure Data center regions.
- sku
Api
Management Service Sku Properties - SKU properties of the API Management service.
- disable
Gateway boolean - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
- nat
Gateway string | NatState Gateway State - Property can be used to enable NAT Gateway for this API Management service.
- public
Ip stringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
- virtual
Network VirtualConfiguration Network Configuration - Virtual network configuration for the location.
- zones string[]
- A list of availability zones denoting where the resource needs to come from.
- location str
- The location name of the additional region among Azure Data center regions.
- sku
Api
Management Service Sku Properties - SKU properties of the API Management service.
- disable_
gateway bool - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
- nat_
gateway_ str | Natstate Gateway State - Property can be used to enable NAT Gateway for this API Management service.
- public_
ip_ straddress_ id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
- virtual_
network_ Virtualconfiguration Network Configuration - Virtual network configuration for the location.
- zones Sequence[str]
- A list of availability zones denoting where the resource needs to come from.
- location String
- The location name of the additional region among Azure Data center regions.
- sku Property Map
- SKU properties of the API Management service.
- disable
Gateway Boolean - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
- nat
Gateway String | "Enabled" | "Disabled"State - Property can be used to enable NAT Gateway for this API Management service.
- public
Ip StringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
- virtual
Network Property MapConfiguration - Virtual network configuration for the location.
- zones List<String>
- A list of availability zones denoting where the resource needs to come from.
AdditionalLocationResponse, AdditionalLocationResponseArgs
- Gateway
Regional stringUrl - Gateway URL of the API Management service in the Region.
- Location string
- The location name of the additional region among Azure Data center regions.
- Outbound
Public List<string>IPAddresses - Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
- Platform
Version string - Compute Platform Version running the service.
- Private
IPAddresses List<string> - Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.
- Public
IPAddresses List<string> - Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU.
- Sku
Pulumi.
Azure Native. Api Management. Inputs. Api Management Service Sku Properties Response - SKU properties of the API Management service.
- Disable
Gateway bool - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
- Nat
Gateway stringState - Property can be used to enable NAT Gateway for this API Management service.
- Public
Ip stringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
- Virtual
Network Pulumi.Configuration Azure Native. Api Management. Inputs. Virtual Network Configuration Response - Virtual network configuration for the location.
- Zones List<string>
- A list of availability zones denoting where the resource needs to come from.
- Gateway
Regional stringUrl - Gateway URL of the API Management service in the Region.
- Location string
- The location name of the additional region among Azure Data center regions.
- Outbound
Public []stringIPAddresses - Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
- Platform
Version string - Compute Platform Version running the service.
- Private
IPAddresses []string - Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.
- Public
IPAddresses []string - Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU.
- Sku
Api
Management Service Sku Properties Response - SKU properties of the API Management service.
- Disable
Gateway bool - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
- Nat
Gateway stringState - Property can be used to enable NAT Gateway for this API Management service.
- Public
Ip stringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
- Virtual
Network VirtualConfiguration Network Configuration Response - Virtual network configuration for the location.
- Zones []string
- A list of availability zones denoting where the resource needs to come from.
- gateway
Regional StringUrl - Gateway URL of the API Management service in the Region.
- location String
- The location name of the additional region among Azure Data center regions.
- outbound
Public List<String>IPAddresses - Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
- platform
Version String - Compute Platform Version running the service.
- private
IPAddresses List<String> - Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.
- public
IPAddresses List<String> - Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU.
- sku
Api
Management Service Sku Properties Response - SKU properties of the API Management service.
- disable
Gateway Boolean - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
- nat
Gateway StringState - Property can be used to enable NAT Gateway for this API Management service.
- public
Ip StringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
- virtual
Network VirtualConfiguration Network Configuration Response - Virtual network configuration for the location.
- zones List<String>
- A list of availability zones denoting where the resource needs to come from.
- gateway
Regional stringUrl - Gateway URL of the API Management service in the Region.
- location string
- The location name of the additional region among Azure Data center regions.
- outbound
Public string[]IPAddresses - Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
- platform
Version string - Compute Platform Version running the service.
- private
IPAddresses string[] - Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.
- public
IPAddresses string[] - Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU.
- sku
Api
Management Service Sku Properties Response - SKU properties of the API Management service.
- disable
Gateway boolean - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
- nat
Gateway stringState - Property can be used to enable NAT Gateway for this API Management service.
- public
Ip stringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
- virtual
Network VirtualConfiguration Network Configuration Response - Virtual network configuration for the location.
- zones string[]
- A list of availability zones denoting where the resource needs to come from.
- gateway_
regional_ strurl - Gateway URL of the API Management service in the Region.
- location str
- The location name of the additional region among Azure Data center regions.
- outbound_
public_ Sequence[str]ip_ addresses - Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
- platform_
version str - Compute Platform Version running the service.
- private_
ip_ Sequence[str]addresses - Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.
- public_
ip_ Sequence[str]addresses - Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU.
- sku
Api
Management Service Sku Properties Response - SKU properties of the API Management service.
- disable_
gateway bool - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
- nat_
gateway_ strstate - Property can be used to enable NAT Gateway for this API Management service.
- public_
ip_ straddress_ id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
- virtual_
network_ Virtualconfiguration Network Configuration Response - Virtual network configuration for the location.
- zones Sequence[str]
- A list of availability zones denoting where the resource needs to come from.
- gateway
Regional StringUrl - Gateway URL of the API Management service in the Region.
- location String
- The location name of the additional region among Azure Data center regions.
- outbound
Public List<String>IPAddresses - Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform.
- platform
Version String - Compute Platform Version running the service.
- private
IPAddresses List<String> - Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU.
- public
IPAddresses List<String> - Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU.
- sku Property Map
- SKU properties of the API Management service.
- disable
Gateway Boolean - Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
- nat
Gateway StringState - Property can be used to enable NAT Gateway for this API Management service.
- public
Ip StringAddress Id - Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network.
- virtual
Network Property MapConfiguration - Virtual network configuration for the location.
- zones List<String>
- A list of availability zones denoting where the resource needs to come from.
ApiManagementServiceIdentity, ApiManagementServiceIdentityArgs
- Type
string | Pulumi.
Azure Native. Api Management. Apim Identity Type - The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Api Management. Inputs. User Identity Properties> - The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- Type
string | Apim
Identity Type - The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- User
Assigned map[string]UserIdentities Identity Properties - The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- type
String | Apim
Identity Type - The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user
Assigned Map<String,UserIdentities Identity Properties> - The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- type
string | Apim
Identity Type - The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user
Assigned {[key: string]: UserIdentities Identity Properties} - The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- type
str | Apim
Identity Type - The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user_
assigned_ Mapping[str, Useridentities Identity Properties] - The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- type
String | "System
Assigned" | "User Assigned" | "System Assigned, User Assigned" | "None" - The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user
Assigned Map<Property Map>Identities - The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
ApiManagementServiceIdentityResponse, ApiManagementServiceIdentityResponseArgs
- Principal
Id string - The principal id of the identity.
- Tenant
Id string - The client tenant id of the identity.
- Type string
- The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Api Management. Inputs. User Identity Properties Response> - The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- Principal
Id string - The principal id of the identity.
- Tenant
Id string - The client tenant id of the identity.
- Type string
- The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- User
Assigned map[string]UserIdentities Identity Properties Response - The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- principal
Id String - The principal id of the identity.
- tenant
Id String - The client tenant id of the identity.
- type String
- The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user
Assigned Map<String,UserIdentities Identity Properties Response> - The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- principal
Id string - The principal id of the identity.
- tenant
Id string - The client tenant id of the identity.
- type string
- The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user
Assigned {[key: string]: UserIdentities Identity Properties Response} - The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- principal_
id str - The principal id of the identity.
- tenant_
id str - The client tenant id of the identity.
- type str
- The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user_
assigned_ Mapping[str, Useridentities Identity Properties Response] - The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- principal
Id String - The principal id of the identity.
- tenant
Id String - The client tenant id of the identity.
- type String
- The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
- user
Assigned Map<Property Map>Identities - The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
ApiManagementServiceSkuProperties, ApiManagementServiceSkuPropertiesArgs
- Capacity int
- Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.
- Name
string | Pulumi.
Azure Native. Api Management. Sku Type - Name of the Sku.
- capacity Number
- Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.
- name String | "Developer" | "Standard" | "Premium" | "Basic" | "Consumption" | "Isolated"
- Name of the Sku.
ApiManagementServiceSkuPropertiesResponse, ApiManagementServiceSkuPropertiesResponseArgs
ApiVersionConstraint, ApiVersionConstraintArgs
- Min
Api stringVersion - Limit control plane API calls to API Management service with version equal to or newer than this value.
- Min
Api stringVersion - Limit control plane API calls to API Management service with version equal to or newer than this value.
- min
Api StringVersion - Limit control plane API calls to API Management service with version equal to or newer than this value.
- min
Api stringVersion - Limit control plane API calls to API Management service with version equal to or newer than this value.
- min_
api_ strversion - Limit control plane API calls to API Management service with version equal to or newer than this value.
- min
Api StringVersion - Limit control plane API calls to API Management service with version equal to or newer than this value.
ApiVersionConstraintResponse, ApiVersionConstraintResponseArgs
- Min
Api stringVersion - Limit control plane API calls to API Management service with version equal to or newer than this value.
- Min
Api stringVersion - Limit control plane API calls to API Management service with version equal to or newer than this value.
- min
Api StringVersion - Limit control plane API calls to API Management service with version equal to or newer than this value.
- min
Api stringVersion - Limit control plane API calls to API Management service with version equal to or newer than this value.
- min_
api_ strversion - Limit control plane API calls to API Management service with version equal to or newer than this value.
- min
Api StringVersion - Limit control plane API calls to API Management service with version equal to or newer than this value.
ApimIdentityType, ApimIdentityTypeArgs
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- System
Assigned_User Assigned - SystemAssigned, UserAssigned
- None
- None
- Apim
Identity Type System Assigned - SystemAssigned
- Apim
Identity Type User Assigned - UserAssigned
- Apim
Identity Type_System Assigned_User Assigned - SystemAssigned, UserAssigned
- Apim
Identity Type None - None
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- System
Assigned_User Assigned - SystemAssigned, UserAssigned
- None
- None
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- System
Assigned_User Assigned - SystemAssigned, UserAssigned
- None
- None
- SYSTEM_ASSIGNED
- SystemAssigned
- USER_ASSIGNED
- UserAssigned
- SYSTEM_ASSIGNED_USER_ASSIGNED
- SystemAssigned, UserAssigned
- NONE
- None
- "System
Assigned" - SystemAssigned
- "User
Assigned" - UserAssigned
- "System
Assigned, User Assigned" - SystemAssigned, UserAssigned
- "None"
- None
ArmIdWrapperResponse, ArmIdWrapperResponseArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
CertificateConfiguration, CertificateConfigurationArgs
- Store
Name string - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
- Certificate
Pulumi.
Azure Native. Api Management. Inputs. Certificate Information - Certificate information.
- Certificate
Password string - Certificate Password.
- Encoded
Certificate string - Base64 Encoded certificate.
- Store
Name string - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
- Certificate
Certificate
Information - Certificate information.
- Certificate
Password string - Certificate Password.
- Encoded
Certificate string - Base64 Encoded certificate.
- store
Name String - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
- certificate
Certificate
Information - Certificate information.
- certificate
Password String - Certificate Password.
- encoded
Certificate String - Base64 Encoded certificate.
- store
Name string - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
- certificate
Certificate
Information - Certificate information.
- certificate
Password string - Certificate Password.
- encoded
Certificate string - Base64 Encoded certificate.
- store_
name str - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
- certificate
Certificate
Information - Certificate information.
- certificate_
password str - Certificate Password.
- encoded_
certificate str - Base64 Encoded certificate.
- store
Name String - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
- certificate Property Map
- Certificate information.
- certificate
Password String - Certificate Password.
- encoded
Certificate String - Base64 Encoded certificate.
CertificateConfigurationResponse, CertificateConfigurationResponseArgs
- Store
Name string - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
- Certificate
Pulumi.
Azure Native. Api Management. Inputs. Certificate Information Response - Certificate information.
- Certificate
Password string - Certificate Password.
- Encoded
Certificate string - Base64 Encoded certificate.
- Store
Name string - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
- Certificate
Certificate
Information Response - Certificate information.
- Certificate
Password string - Certificate Password.
- Encoded
Certificate string - Base64 Encoded certificate.
- store
Name String - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
- certificate
Certificate
Information Response - Certificate information.
- certificate
Password String - Certificate Password.
- encoded
Certificate String - Base64 Encoded certificate.
- store
Name string - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
- certificate
Certificate
Information Response - Certificate information.
- certificate
Password string - Certificate Password.
- encoded
Certificate string - Base64 Encoded certificate.
- store_
name str - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
- certificate
Certificate
Information Response - Certificate information.
- certificate_
password str - Certificate Password.
- encoded_
certificate str - Base64 Encoded certificate.
- store
Name String - The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.
- certificate Property Map
- Certificate information.
- certificate
Password String - Certificate Password.
- encoded
Certificate String - Base64 Encoded certificate.
CertificateInformation, CertificateInformationArgs
- Expiry string
- Expiration date of the certificate. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - Subject string
- Subject of the certificate.
- Thumbprint string
- Thumbprint of the certificate.
- Expiry string
- Expiration date of the certificate. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - Subject string
- Subject of the certificate.
- Thumbprint string
- Thumbprint of the certificate.
- expiry String
- Expiration date of the certificate. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - subject String
- Subject of the certificate.
- thumbprint String
- Thumbprint of the certificate.
- expiry string
- Expiration date of the certificate. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - subject string
- Subject of the certificate.
- thumbprint string
- Thumbprint of the certificate.
- expiry str
- Expiration date of the certificate. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - subject str
- Subject of the certificate.
- thumbprint str
- Thumbprint of the certificate.
- expiry String
- Expiration date of the certificate. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - subject String
- Subject of the certificate.
- thumbprint String
- Thumbprint of the certificate.
CertificateInformationResponse, CertificateInformationResponseArgs
- Expiry string
- Expiration date of the certificate. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - Subject string
- Subject of the certificate.
- Thumbprint string
- Thumbprint of the certificate.
- Expiry string
- Expiration date of the certificate. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - Subject string
- Subject of the certificate.
- Thumbprint string
- Thumbprint of the certificate.
- expiry String
- Expiration date of the certificate. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - subject String
- Subject of the certificate.
- thumbprint String
- Thumbprint of the certificate.
- expiry string
- Expiration date of the certificate. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - subject string
- Subject of the certificate.
- thumbprint string
- Thumbprint of the certificate.
- expiry str
- Expiration date of the certificate. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - subject str
- Subject of the certificate.
- thumbprint str
- Thumbprint of the certificate.
- expiry String
- Expiration date of the certificate. The date conforms to the following format:
yyyy-MM-ddTHH:mm:ssZas specified by the ISO 8601 standard. - subject String
- Subject of the certificate.
- thumbprint String
- Thumbprint of the certificate.
CertificateSource, CertificateSourceArgs
- Managed
- Managed
- Key
Vault - KeyVault
- Custom
- Custom
- Built
In - BuiltIn
- Certificate
Source Managed - Managed
- Certificate
Source Key Vault - KeyVault
- Certificate
Source Custom - Custom
- Certificate
Source Built In - BuiltIn
- Managed
- Managed
- Key
Vault - KeyVault
- Custom
- Custom
- Built
In - BuiltIn
- Managed
- Managed
- Key
Vault - KeyVault
- Custom
- Custom
- Built
In - BuiltIn
- MANAGED
- Managed
- KEY_VAULT
- KeyVault
- CUSTOM
- Custom
- BUILT_IN
- BuiltIn
- "Managed"
- Managed
- "Key
Vault" - KeyVault
- "Custom"
- Custom
- "Built
In" - BuiltIn
CertificateStatus, CertificateStatusArgs
- Completed
- Completed
- Failed
- Failed
- In
Progress - InProgress
- Certificate
Status Completed - Completed
- Certificate
Status Failed - Failed
- Certificate
Status In Progress - InProgress
- Completed
- Completed
- Failed
- Failed
- In
Progress - InProgress
- Completed
- Completed
- Failed
- Failed
- In
Progress - InProgress
- COMPLETED
- Completed
- FAILED
- Failed
- IN_PROGRESS
- InProgress
- "Completed"
- Completed
- "Failed"
- Failed
- "In
Progress" - InProgress
HostnameConfiguration, HostnameConfigurationArgs
- Host
Name string - Hostname to configure on the Api Management service.
- Type
string | Pulumi.
Azure Native. Api Management. Hostname Type - Hostname type.
- Certificate
Pulumi.
Azure Native. Api Management. Inputs. Certificate Information - Certificate information.
- Certificate
Password string - Certificate Password.
- Certificate
Source string | Pulumi.Azure Native. Api Management. Certificate Source - Certificate Source.
- Certificate
Status string | Pulumi.Azure Native. Api Management. Certificate Status - Certificate Status.
- Default
Ssl boolBinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
- Encoded
Certificate string - Base64 Encoded certificate.
- Identity
Client stringId - System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
- Key
Vault stringId - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
- Negotiate
Client boolCertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
- Host
Name string - Hostname to configure on the Api Management service.
- Type
string | Hostname
Type - Hostname type.
- Certificate
Certificate
Information - Certificate information.
- Certificate
Password string - Certificate Password.
- Certificate
Source string | CertificateSource - Certificate Source.
- Certificate
Status string | CertificateStatus - Certificate Status.
- Default
Ssl boolBinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
- Encoded
Certificate string - Base64 Encoded certificate.
- Identity
Client stringId - System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
- Key
Vault stringId - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
- Negotiate
Client boolCertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
- host
Name String - Hostname to configure on the Api Management service.
- type
String | Hostname
Type - Hostname type.
- certificate
Certificate
Information - Certificate information.
- certificate
Password String - Certificate Password.
- certificate
Source String | CertificateSource - Certificate Source.
- certificate
Status String | CertificateStatus - Certificate Status.
- default
Ssl BooleanBinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
- encoded
Certificate String - Base64 Encoded certificate.
- identity
Client StringId - System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
- key
Vault StringId - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
- negotiate
Client BooleanCertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
- host
Name string - Hostname to configure on the Api Management service.
- type
string | Hostname
Type - Hostname type.
- certificate
Certificate
Information - Certificate information.
- certificate
Password string - Certificate Password.
- certificate
Source string | CertificateSource - Certificate Source.
- certificate
Status string | CertificateStatus - Certificate Status.
- default
Ssl booleanBinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
- encoded
Certificate string - Base64 Encoded certificate.
- identity
Client stringId - System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
- key
Vault stringId - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
- negotiate
Client booleanCertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
- host_
name str - Hostname to configure on the Api Management service.
- type
str | Hostname
Type - Hostname type.
- certificate
Certificate
Information - Certificate information.
- certificate_
password str - Certificate Password.
- certificate_
source str | CertificateSource - Certificate Source.
- certificate_
status str | CertificateStatus - Certificate Status.
- default_
ssl_ boolbinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
- encoded_
certificate str - Base64 Encoded certificate.
- identity_
client_ strid - System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
- key_
vault_ strid - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
- negotiate_
client_ boolcertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
- host
Name String - Hostname to configure on the Api Management service.
- type
String | "Proxy" | "Portal" | "Management" | "Scm" | "Developer
Portal" - Hostname type.
- certificate Property Map
- Certificate information.
- certificate
Password String - Certificate Password.
- certificate
Source String | "Managed" | "KeyVault" | "Custom" | "Built In" - Certificate Source.
- certificate
Status String | "Completed" | "Failed" | "InProgress" - Certificate Status.
- default
Ssl BooleanBinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
- encoded
Certificate String - Base64 Encoded certificate.
- identity
Client StringId - System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
- key
Vault StringId - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
- negotiate
Client BooleanCertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
HostnameConfigurationResponse, HostnameConfigurationResponseArgs
- Host
Name string - Hostname to configure on the Api Management service.
- Type string
- Hostname type.
- Certificate
Pulumi.
Azure Native. Api Management. Inputs. Certificate Information Response - Certificate information.
- Certificate
Password string - Certificate Password.
- Certificate
Source string - Certificate Source.
- Certificate
Status string - Certificate Status.
- Default
Ssl boolBinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
- Encoded
Certificate string - Base64 Encoded certificate.
- Identity
Client stringId - System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
- Key
Vault stringId - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
- Negotiate
Client boolCertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
- Host
Name string - Hostname to configure on the Api Management service.
- Type string
- Hostname type.
- Certificate
Certificate
Information Response - Certificate information.
- Certificate
Password string - Certificate Password.
- Certificate
Source string - Certificate Source.
- Certificate
Status string - Certificate Status.
- Default
Ssl boolBinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
- Encoded
Certificate string - Base64 Encoded certificate.
- Identity
Client stringId - System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
- Key
Vault stringId - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
- Negotiate
Client boolCertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
- host
Name String - Hostname to configure on the Api Management service.
- type String
- Hostname type.
- certificate
Certificate
Information Response - Certificate information.
- certificate
Password String - Certificate Password.
- certificate
Source String - Certificate Source.
- certificate
Status String - Certificate Status.
- default
Ssl BooleanBinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
- encoded
Certificate String - Base64 Encoded certificate.
- identity
Client StringId - System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
- key
Vault StringId - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
- negotiate
Client BooleanCertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
- host
Name string - Hostname to configure on the Api Management service.
- type string
- Hostname type.
- certificate
Certificate
Information Response - Certificate information.
- certificate
Password string - Certificate Password.
- certificate
Source string - Certificate Source.
- certificate
Status string - Certificate Status.
- default
Ssl booleanBinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
- encoded
Certificate string - Base64 Encoded certificate.
- identity
Client stringId - System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
- key
Vault stringId - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
- negotiate
Client booleanCertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
- host_
name str - Hostname to configure on the Api Management service.
- type str
- Hostname type.
- certificate
Certificate
Information Response - Certificate information.
- certificate_
password str - Certificate Password.
- certificate_
source str - Certificate Source.
- certificate_
status str - Certificate Status.
- default_
ssl_ boolbinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
- encoded_
certificate str - Base64 Encoded certificate.
- identity_
client_ strid - System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
- key_
vault_ strid - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
- negotiate_
client_ boolcertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
- host
Name String - Hostname to configure on the Api Management service.
- type String
- Hostname type.
- certificate Property Map
- Certificate information.
- certificate
Password String - Certificate Password.
- certificate
Source String - Certificate Source.
- certificate
Status String - Certificate Status.
- default
Ssl BooleanBinding - Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.
- encoded
Certificate String - Base64 Encoded certificate.
- identity
Client StringId - System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
- key
Vault StringId - Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type application/x-pkcs12
- negotiate
Client BooleanCertificate - Specify true to always negotiate client certificate on the hostname. Default Value is false.
HostnameType, HostnameTypeArgs
- Proxy
- Proxy
- Portal
- Portal
- Management
- Management
- Scm
- Scm
- Developer
Portal - DeveloperPortal
- Hostname
Type Proxy - Proxy
- Hostname
Type Portal - Portal
- Hostname
Type Management - Management
- Hostname
Type Scm - Scm
- Hostname
Type Developer Portal - DeveloperPortal
- Proxy
- Proxy
- Portal
- Portal
- Management
- Management
- Scm
- Scm
- Developer
Portal - DeveloperPortal
- Proxy
- Proxy
- Portal
- Portal
- Management
- Management
- Scm
- Scm
- Developer
Portal - DeveloperPortal
- PROXY
- Proxy
- PORTAL
- Portal
- MANAGEMENT
- Management
- SCM
- Scm
- DEVELOPER_PORTAL
- DeveloperPortal
- "Proxy"
- Proxy
- "Portal"
- Portal
- "Management"
- Management
- "Scm"
- Scm
- "Developer
Portal" - DeveloperPortal
NatGatewayState, NatGatewayStateArgs
- Enabled
- EnabledNat Gateway is enabled for the service.
- Disabled
- DisabledNat Gateway is disabled for the service.
- Nat
Gateway State Enabled - EnabledNat Gateway is enabled for the service.
- Nat
Gateway State Disabled - DisabledNat Gateway is disabled for the service.
- Enabled
- EnabledNat Gateway is enabled for the service.
- Disabled
- DisabledNat Gateway is disabled for the service.
- Enabled
- EnabledNat Gateway is enabled for the service.
- Disabled
- DisabledNat Gateway is disabled for the service.
- ENABLED
- EnabledNat Gateway is enabled for the service.
- DISABLED
- DisabledNat Gateway is disabled for the service.
- "Enabled"
- EnabledNat Gateway is enabled for the service.
- "Disabled"
- DisabledNat Gateway is disabled for the service.
PrivateEndpointServiceConnectionStatus, PrivateEndpointServiceConnectionStatusArgs
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- Private
Endpoint Service Connection Status Pending - Pending
- Private
Endpoint Service Connection Status Approved - Approved
- Private
Endpoint Service Connection Status Rejected - Rejected
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- Pending
- Pending
- Approved
- Approved
- Rejected
- Rejected
- PENDING
- Pending
- APPROVED
- Approved
- REJECTED
- Rejected
- "Pending"
- Pending
- "Approved"
- Approved
- "Rejected"
- Rejected
PrivateLinkServiceConnectionState, PrivateLinkServiceConnectionStateArgs
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status
string | Pulumi.
Azure Native. Api Management. Private Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status
string | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status
String | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- description string
- The reason for approval/rejection of the connection.
- status
string | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions_
required str - A message indicating if changes on the service provider require any updates on the consumer.
- description str
- The reason for approval/rejection of the connection.
- status
str | Private
Endpoint Service Connection Status - Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status String | "Pending" | "Approved" | "Rejected"
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status String
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- description string
- The reason for approval/rejection of the connection.
- status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions_
required str - A message indicating if changes on the service provider require any updates on the consumer.
- description str
- The reason for approval/rejection of the connection.
- status str
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status String
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
PublicNetworkAccess, PublicNetworkAccessArgs
- Enabled
- Enabled
- Disabled
- Disabled
- Public
Network Access Enabled - Enabled
- Public
Network Access Disabled - Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- ENABLED
- Enabled
- DISABLED
- Disabled
- "Enabled"
- Enabled
- "Disabled"
- Disabled
RemotePrivateEndpointConnectionWrapper, RemotePrivateEndpointConnectionWrapperArgs
- Private
Link Pulumi.Service Connection State Azure Native. Api Management. Inputs. Private Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- Id string
- Private Endpoint connection resource id
- Name string
- Private Endpoint Connection Name
- Type string
- Private Endpoint Connection Resource Type
- Private
Link PrivateService Connection State Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- Id string
- Private Endpoint connection resource id
- Name string
- Private Endpoint Connection Name
- Type string
- Private Endpoint Connection Resource Type
- private
Link PrivateService Connection State Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- id String
- Private Endpoint connection resource id
- name String
- Private Endpoint Connection Name
- type String
- Private Endpoint Connection Resource Type
- private
Link PrivateService Connection State Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- id string
- Private Endpoint connection resource id
- name string
- Private Endpoint Connection Name
- type string
- Private Endpoint Connection Resource Type
- private_
link_ Privateservice_ connection_ state Link Service Connection State - A collection of information about the state of the connection between service consumer and provider.
- id str
- Private Endpoint connection resource id
- name str
- Private Endpoint Connection Name
- type str
- Private Endpoint Connection Resource Type
- private
Link Property MapService Connection State - A collection of information about the state of the connection between service consumer and provider.
- id String
- Private Endpoint connection resource id
- name String
- Private Endpoint Connection Name
- type String
- Private Endpoint Connection Resource Type
RemotePrivateEndpointConnectionWrapperResponse, RemotePrivateEndpointConnectionWrapperResponseArgs
- Group
Ids List<string> - All the Group ids.
- Private
Link Pulumi.Service Connection State Azure Native. Api Management. Inputs. Private Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State string - The provisioning state of the private endpoint connection resource.
- Id string
- Private Endpoint connection resource id
- Name string
- Private Endpoint Connection Name
- Private
Endpoint Pulumi.Azure Native. Api Management. Inputs. Arm Id Wrapper Response - The resource of private end point.
- Type string
- Private Endpoint Connection Resource Type
- Group
Ids []string - All the Group ids.
- Private
Link PrivateService Connection State Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- Provisioning
State string - The provisioning state of the private endpoint connection resource.
- Id string
- Private Endpoint connection resource id
- Name string
- Private Endpoint Connection Name
- Private
Endpoint ArmId Wrapper Response - The resource of private end point.
- Type string
- Private Endpoint Connection Resource Type
- group
Ids List<String> - All the Group ids.
- private
Link PrivateService Connection State Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- provisioning
State String - The provisioning state of the private endpoint connection resource.
- id String
- Private Endpoint connection resource id
- name String
- Private Endpoint Connection Name
- private
Endpoint ArmId Wrapper Response - The resource of private end point.
- type String
- Private Endpoint Connection Resource Type
- group
Ids string[] - All the Group ids.
- private
Link PrivateService Connection State Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- provisioning
State string - The provisioning state of the private endpoint connection resource.
- id string
- Private Endpoint connection resource id
- name string
- Private Endpoint Connection Name
- private
Endpoint ArmId Wrapper Response - The resource of private end point.
- type string
- Private Endpoint Connection Resource Type
- group_
ids Sequence[str] - All the Group ids.
- private_
link_ Privateservice_ connection_ state Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- provisioning_
state str - The provisioning state of the private endpoint connection resource.
- id str
- Private Endpoint connection resource id
- name str
- Private Endpoint Connection Name
- private_
endpoint ArmId Wrapper Response - The resource of private end point.
- type str
- Private Endpoint Connection Resource Type
- group
Ids List<String> - All the Group ids.
- private
Link Property MapService Connection State - A collection of information about the state of the connection between service consumer and provider.
- provisioning
State String - The provisioning state of the private endpoint connection resource.
- id String
- Private Endpoint connection resource id
- name String
- Private Endpoint Connection Name
- private
Endpoint Property Map - The resource of private end point.
- type String
- Private Endpoint Connection Resource Type
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.
UserIdentityProperties, UserIdentityPropertiesArgs
- Client
Id string - The client id of user assigned identity.
- Principal
Id string - The principal id of user assigned identity.
- Client
Id string - The client id of user assigned identity.
- Principal
Id string - The principal id of user assigned identity.
- client
Id String - The client id of user assigned identity.
- principal
Id String - The principal id of user assigned identity.
- client
Id string - The client id of user assigned identity.
- principal
Id string - The principal id of user assigned identity.
- client_
id str - The client id of user assigned identity.
- principal_
id str - The principal id of user assigned identity.
- client
Id String - The client id of user assigned identity.
- principal
Id String - The principal id of user assigned identity.
UserIdentityPropertiesResponse, UserIdentityPropertiesResponseArgs
- Client
Id string - The client id of user assigned identity.
- Principal
Id string - The principal id of user assigned identity.
- Client
Id string - The client id of user assigned identity.
- Principal
Id string - The principal id of user assigned identity.
- client
Id String - The client id of user assigned identity.
- principal
Id String - The principal id of user assigned identity.
- client
Id string - The client id of user assigned identity.
- principal
Id string - The principal id of user assigned identity.
- client_
id str - The client id of user assigned identity.
- principal_
id str - The principal id of user assigned identity.
- client
Id String - The client id of user assigned identity.
- principal
Id String - The principal id of user assigned identity.
VirtualNetworkConfiguration, VirtualNetworkConfigurationArgs
- Subnet
Resource stringId - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
- Subnet
Resource stringId - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
- subnet
Resource StringId - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
- subnet
Resource stringId - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
- subnet_
resource_ strid - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
- subnet
Resource StringId - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
VirtualNetworkConfigurationResponse, VirtualNetworkConfigurationResponseArgs
- Subnetname string
- The name of the subnet.
- Vnetid string
- The virtual network ID. This is typically a GUID. Expect a null GUID by default.
- Subnet
Resource stringId - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
- Subnetname string
- The name of the subnet.
- Vnetid string
- The virtual network ID. This is typically a GUID. Expect a null GUID by default.
- Subnet
Resource stringId - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
- subnetname String
- The name of the subnet.
- vnetid String
- The virtual network ID. This is typically a GUID. Expect a null GUID by default.
- subnet
Resource StringId - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
- subnetname string
- The name of the subnet.
- vnetid string
- The virtual network ID. This is typically a GUID. Expect a null GUID by default.
- subnet
Resource stringId - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
- subnetname str
- The name of the subnet.
- vnetid str
- The virtual network ID. This is typically a GUID. Expect a null GUID by default.
- subnet_
resource_ strid - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
- subnetname String
- The name of the subnet.
- vnetid String
- The virtual network ID. This is typically a GUID. Expect a null GUID by default.
- subnet
Resource StringId - The full resource ID of a subnet in a virtual network to deploy the API Management service in.
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:ApiManagementService apimService1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
To learn more about importing existing cloud resources, see Importing resources.
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi