Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.0 published on Wednesday, May 4, 2022 by Pulumi

ApiManagementService

A single API Management service resource in List or Get response. API Version: 2020-12-01.

Example Usage

ApiManagementCreateMultiRegionServiceWithCustomHostname

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new AzureNative.ApiManagement.ApiManagementServiceArgs
        {
            AdditionalLocations = 
            {
                new AzureNative.ApiManagement.Inputs.AdditionalLocationArgs
                {
                    DisableGateway = true,
                    Location = "East US",
                    Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
                    {
                        Capacity = 1,
                        Name = "Premium",
                    },
                },
            },
            ApiVersionConstraint = new AzureNative.ApiManagement.Inputs.ApiVersionConstraintArgs
            {
                MinApiVersion = "2019-01-01",
            },
            HostnameConfigurations = 
            {
                new AzureNative.ApiManagement.Inputs.HostnameConfigurationArgs
                {
                    CertificatePassword = "Password",
                    DefaultSslBinding = true,
                    EncodedCertificate = "****** Base 64 Encoded Certificate ************",
                    HostName = "gateway1.msitesting.net",
                    Type = "Proxy",
                },
                new AzureNative.ApiManagement.Inputs.HostnameConfigurationArgs
                {
                    CertificatePassword = "Password",
                    EncodedCertificate = "****** Base 64 Encoded Certificate ************",
                    HostName = "mgmt.msitesting.net",
                    Type = "Management",
                },
                new AzureNative.ApiManagement.Inputs.HostnameConfigurationArgs
                {
                    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 = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
            {
                Capacity = 1,
                Name = "Premium",
            },
            Tags = 
            {
                { "tag1", "value1" },
                { "tag2", "value2" },
                { "tag3", "value3" },
            },
            VirtualNetworkType = "None",
        });
    }

}
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"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.AdditionalLocationArgs{
				&apimanagement.AdditionalLocationArgs{
					DisableGateway: pulumi.Bool(true),
					Location:       pulumi.String("East US"),
					Sku: &apimanagement.ApiManagementServiceSkuPropertiesArgs{
						Capacity: pulumi.Int(1),
						Name:     pulumi.String("Premium"),
					},
				},
			},
			ApiVersionConstraint: &apimanagement.ApiVersionConstraintArgs{
				MinApiVersion: pulumi.String("2019-01-01"),
			},
			HostnameConfigurations: []apimanagement.HostnameConfigurationArgs{
				&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("Proxy"),
				},
				&apimanagement.HostnameConfigurationArgs{
					CertificatePassword: pulumi.String("Password"),
					EncodedCertificate:  pulumi.String("****** Base 64 Encoded Certificate ************"),
					HostName:            pulumi.String("mgmt.msitesting.net"),
					Type:                pulumi.String("Management"),
				},
				&apimanagement.HostnameConfigurationArgs{
					CertificatePassword: pulumi.String("Password"),
					EncodedCertificate:  pulumi.String("****** Base 64 Encoded Certificate ************"),
					HostName:            pulumi.String("portal1.msitesting.net"),
					Type:                pulumi.String("Portal"),
				},
			},
			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("Premium"),
			},
			Tags: pulumi.StringMap{
				"tag1": pulumi.String("value1"),
				"tag2": pulumi.String("value2"),
				"tag3": pulumi.String("value3"),
			},
			VirtualNetworkType: pulumi.String("None"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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(Map.ofEntries(
                Map.entry("disableGateway", true),
                Map.entry("location", "East US"),
                Map.entry("sku", Map.ofEntries(
                    Map.entry("capacity", 1),
                    Map.entry("name", "Premium")
                ))
            ))
            .apiVersionConstraint(Map.of("minApiVersion", "2019-01-01"))
            .hostnameConfigurations(            
                Map.ofEntries(
                    Map.entry("certificatePassword", "Password"),
                    Map.entry("defaultSslBinding", true),
                    Map.entry("encodedCertificate", "****** Base 64 Encoded Certificate ************"),
                    Map.entry("hostName", "gateway1.msitesting.net"),
                    Map.entry("type", "Proxy")
                ),
                Map.ofEntries(
                    Map.entry("certificatePassword", "Password"),
                    Map.entry("encodedCertificate", "****** Base 64 Encoded Certificate ************"),
                    Map.entry("hostName", "mgmt.msitesting.net"),
                    Map.entry("type", "Management")
                ),
                Map.ofEntries(
                    Map.entry("certificatePassword", "Password"),
                    Map.entry("encodedCertificate", "****** Base 64 Encoded Certificate ************"),
                    Map.entry("hostName", "portal1.msitesting.net"),
                    Map.entry("type", "Portal")
                ))
            .location("West US")
            .publisherEmail("apim@autorestsdk.com")
            .publisherName("autorestsdk")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .sku(Map.ofEntries(
                Map.entry("capacity", 1),
                Map.entry("name", "Premium")
            ))
            .tags(Map.ofEntries(
                Map.entry("tag1", "value1"),
                Map.entry("tag2", "value2"),
                Map.entry("tag3", "value3")
            ))
            .virtualNetworkType("None")
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
    additional_locations=[azure_native.apimanagement.AdditionalLocationArgs(
        disable_gateway=True,
        location="East US",
        sku=azure_native.apimanagement.ApiManagementServiceSkuPropertiesArgs(
            capacity=1,
            name="Premium",
        ),
    )],
    api_version_constraint=azure_native.apimanagement.ApiVersionConstraintArgs(
        min_api_version="2019-01-01",
    ),
    hostname_configurations=[
        azure_native.apimanagement.HostnameConfigurationArgs(
            certificate_password="Password",
            default_ssl_binding=True,
            encoded_certificate="****** Base 64 Encoded Certificate ************",
            host_name="gateway1.msitesting.net",
            type="Proxy",
        ),
        azure_native.apimanagement.HostnameConfigurationArgs(
            certificate_password="Password",
            encoded_certificate="****** Base 64 Encoded Certificate ************",
            host_name="mgmt.msitesting.net",
            type="Management",
        ),
        azure_native.apimanagement.HostnameConfigurationArgs(
            certificate_password="Password",
            encoded_certificate="****** Base 64 Encoded Certificate ************",
            host_name="portal1.msitesting.net",
            type="Portal",
        ),
    ],
    location="West US",
    publisher_email="apim@autorestsdk.com",
    publisher_name="autorestsdk",
    resource_group_name="rg1",
    service_name="apimService1",
    sku=azure_native.apimanagement.ApiManagementServiceSkuPropertiesArgs(
        capacity=1,
        name="Premium",
    ),
    tags={
        "tag1": "value1",
        "tag2": "value2",
        "tag3": "value3",
    },
    virtual_network_type="None")
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: "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",
});
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 Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new AzureNative.ApiManagement.ApiManagementServiceArgs
        {
            Location = "South Central US",
            PublisherEmail = "foo@contoso.com",
            PublisherName = "foo",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
            Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
            {
                Capacity = 1,
                Name = "Developer",
            },
            Tags = 
            {
                { "Name", "Contoso" },
                { "Test", "User" },
            },
        });
    }

}
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"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("Developer"),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Contoso"),
				"Test": pulumi.String("User"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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(Map.ofEntries(
                Map.entry("capacity", 1),
                Map.entry("name", "Developer")
            ))
            .tags(Map.ofEntries(
                Map.entry("Name", "Contoso"),
                Map.entry("Test", "User")
            ))
            .build());

        }
}
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=azure_native.apimanagement.ApiManagementServiceSkuPropertiesArgs(
        capacity=1,
        name="Developer",
    ),
    tags={
        "Name": "Contoso",
        "Test": "User",
    })
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: "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 Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new AzureNative.ApiManagement.ApiManagementServiceArgs
        {
            Identity = new AzureNative.ApiManagement.Inputs.ApiManagementServiceIdentityArgs
            {
                Type = "SystemAssigned",
            },
            Location = "West US",
            PublisherEmail = "apim@autorestsdk.com",
            PublisherName = "autorestsdk",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
            Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
            {
                Capacity = 0,
                Name = "Consumption",
            },
            Tags = 
            {
                { "tag1", "value1" },
                { "tag2", "value2" },
                { "tag3", "value3" },
            },
        });
    }

}
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"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("SystemAssigned"),
			},
			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("Consumption"),
			},
			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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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(Map.of("type", "SystemAssigned"))
            .location("West US")
            .publisherEmail("apim@autorestsdk.com")
            .publisherName("autorestsdk")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .sku(Map.ofEntries(
                Map.entry("capacity", 0),
                Map.entry("name", "Consumption")
            ))
            .tags(Map.ofEntries(
                Map.entry("tag1", "value1"),
                Map.entry("tag2", "value2"),
                Map.entry("tag3", "value3")
            ))
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
    identity=azure_native.apimanagement.ApiManagementServiceIdentityArgs(
        type="SystemAssigned",
    ),
    location="West US",
    publisher_email="apim@autorestsdk.com",
    publisher_name="autorestsdk",
    resource_group_name="rg1",
    service_name="apimService1",
    sku=azure_native.apimanagement.ApiManagementServiceSkuPropertiesArgs(
        capacity=0,
        name="Consumption",
    ),
    tags={
        "tag1": "value1",
        "tag2": "value2",
        "tag3": "value3",
    })
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const apiManagementService = new azure_native.apimanagement.ApiManagementService("apiManagementService", {
    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",
    },
});
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

ApiManagementCreateServiceInZones

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new AzureNative.ApiManagement.ApiManagementServiceArgs
        {
            Location = "North europe",
            PublisherEmail = "apim@autorestsdk.com",
            PublisherName = "autorestsdk",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
            Sku = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
            {
                Capacity = 1,
                Name = "Premium",
            },
            Tags = 
            {
                { "tag1", "value1" },
                { "tag2", "value2" },
                { "tag3", "value3" },
            },
            Zones = 
            {
                "1",
                "2",
            },
        });
    }

}
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"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(1),
				Name:     pulumi.String("Premium"),
			},
			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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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(Map.ofEntries(
                Map.entry("capacity", 1),
                Map.entry("name", "Premium")
            ))
            .tags(Map.ofEntries(
                Map.entry("tag1", "value1"),
                Map.entry("tag2", "value2"),
                Map.entry("tag3", "value3")
            ))
            .zones(            
                "1",
                "2")
            .build());

        }
}
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=azure_native.apimanagement.ApiManagementServiceSkuPropertiesArgs(
        capacity=1,
        name="Premium",
    ),
    tags={
        "tag1": "value1",
        "tag2": "value2",
        "tag3": "value3",
    },
    zones=[
        "1",
        "2",
    ])
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: 1,
        name: "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: 1
        name: Premium
      tags:
        tag1: value1
        tag2: value2
        tag3: value3
      zones:
        - 1
        - 2

ApiManagementCreateServiceWithCustomHostnameKeyVault

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new AzureNative.ApiManagement.ApiManagementServiceArgs
        {
            ApiVersionConstraint = new AzureNative.ApiManagement.Inputs.ApiVersionConstraintArgs
            {
                MinApiVersion = "2019-01-01",
            },
            HostnameConfigurations = 
            {
                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 = "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 = "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 = "Portal",
                },
            },
            Identity = new AzureNative.ApiManagement.Inputs.ApiManagementServiceIdentityArgs
            {
                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 = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
            {
                Capacity = 1,
                Name = "Premium",
            },
            Tags = 
            {
                { "tag1", "value1" },
                { "tag2", "value2" },
                { "tag3", "value3" },
            },
            VirtualNetworkType = "None",
        });
    }

}
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"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.HostnameConfigurationArgs{
				&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("Proxy"),
				},
				&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("Management"),
				},
				&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("Portal"),
				},
			},
			Identity: &apimanagement.ApiManagementServiceIdentityArgs{
				Type: pulumi.String("UserAssigned"),
				UserAssignedIdentities: apimanagement.UserIdentityPropertiesMap{
					"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": nil,
				},
			},
			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("Premium"),
			},
			Tags: pulumi.StringMap{
				"tag1": pulumi.String("value1"),
				"tag2": pulumi.String("value2"),
				"tag3": pulumi.String("value3"),
			},
			VirtualNetworkType: pulumi.String("None"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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(Map.of("minApiVersion", "2019-01-01"))
            .hostnameConfigurations(            
                Map.ofEntries(
                    Map.entry("defaultSslBinding", true),
                    Map.entry("hostName", "gateway1.msitesting.net"),
                    Map.entry("identityClientId", "329419bc-adec-4dce-9568-25a6d486e468"),
                    Map.entry("keyVaultId", "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert"),
                    Map.entry("type", "Proxy")
                ),
                Map.ofEntries(
                    Map.entry("hostName", "mgmt.msitesting.net"),
                    Map.entry("identityClientId", "329419bc-adec-4dce-9568-25a6d486e468"),
                    Map.entry("keyVaultId", "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert"),
                    Map.entry("type", "Management")
                ),
                Map.ofEntries(
                    Map.entry("hostName", "portal1.msitesting.net"),
                    Map.entry("identityClientId", "329419bc-adec-4dce-9568-25a6d486e468"),
                    Map.entry("keyVaultId", "https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert"),
                    Map.entry("type", "Portal")
                ))
            .identity(Map.ofEntries(
                Map.entry("type", "UserAssigned"),
                Map.entry("userAssignedIdentities", Map.of("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1", ))
            ))
            .location("North Europe")
            .publisherEmail("apim@autorestsdk.com")
            .publisherName("autorestsdk")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .sku(Map.ofEntries(
                Map.entry("capacity", 1),
                Map.entry("name", "Premium")
            ))
            .tags(Map.ofEntries(
                Map.entry("tag1", "value1"),
                Map.entry("tag2", "value2"),
                Map.entry("tag3", "value3")
            ))
            .virtualNetworkType("None")
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
    api_version_constraint=azure_native.apimanagement.ApiVersionConstraintArgs(
        min_api_version="2019-01-01",
    ),
    hostname_configurations=[
        azure_native.apimanagement.HostnameConfigurationArgs(
            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="Proxy",
        ),
        azure_native.apimanagement.HostnameConfigurationArgs(
            host_name="mgmt.msitesting.net",
            identity_client_id="329419bc-adec-4dce-9568-25a6d486e468",
            key_vault_id="https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
            type="Management",
        ),
        azure_native.apimanagement.HostnameConfigurationArgs(
            host_name="portal1.msitesting.net",
            identity_client_id="329419bc-adec-4dce-9568-25a6d486e468",
            key_vault_id="https://rpbvtkeyvaultintegration.vault.azure.net/secrets/msitestingCert",
            type="Portal",
        ),
    ],
    identity=azure_native.apimanagement.ApiManagementServiceIdentityArgs(
        type="UserAssigned",
        user_assigned_identities={
            "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": azure_native.apimanagement.UserIdentityPropertiesArgs(),
        },
    ),
    location="North Europe",
    publisher_email="apim@autorestsdk.com",
    publisher_name="autorestsdk",
    resource_group_name="rg1",
    service_name="apimService1",
    sku=azure_native.apimanagement.ApiManagementServiceSkuPropertiesArgs(
        capacity=1,
        name="Premium",
    ),
    tags={
        "tag1": "value1",
        "tag2": "value2",
        "tag3": "value3",
    },
    virtual_network_type="None")
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: "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",
});
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

ApiManagementCreateServiceWithSystemCertificates

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new AzureNative.ApiManagement.ApiManagementServiceArgs
        {
            Certificates = 
            {
                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 = "Basic",
            },
            Tags = 
            {
                { "tag1", "value1" },
                { "tag2", "value2" },
                { "tag3", "value3" },
            },
        });
    }

}
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"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.CertificateConfigurationArgs{
				&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("Basic"),
			},
			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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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(Map.ofEntries(
                Map.entry("certificatePassword", "Password"),
                Map.entry("encodedCertificate", "*******Base64 encoded Certificate******************"),
                Map.entry("storeName", "CertificateAuthority")
            ))
            .location("Central US")
            .publisherEmail("apim@autorestsdk.com")
            .publisherName("autorestsdk")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .sku(Map.ofEntries(
                Map.entry("capacity", 1),
                Map.entry("name", "Basic")
            ))
            .tags(Map.ofEntries(
                Map.entry("tag1", "value1"),
                Map.entry("tag2", "value2"),
                Map.entry("tag3", "value3")
            ))
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
    certificates=[azure_native.apimanagement.CertificateConfigurationArgs(
        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=azure_native.apimanagement.ApiManagementServiceSkuPropertiesArgs(
        capacity=1,
        name="Basic",
    ),
    tags={
        "tag1": "value1",
        "tag2": "value2",
        "tag3": "value3",
    })
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: "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 Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new AzureNative.ApiManagement.ApiManagementServiceArgs
        {
            Identity = new AzureNative.ApiManagement.Inputs.ApiManagementServiceIdentityArgs
            {
                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 = new AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs
            {
                Capacity = 0,
                Name = "Consumption",
            },
            Tags = 
            {
                { "tag1", "value1" },
                { "tag2", "value2" },
                { "tag3", "value3" },
            },
        });
    }

}
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"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("UserAssigned"),
				UserAssignedIdentities: apimanagement.UserIdentityPropertiesMap{
					"/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": nil,
				},
			},
			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("Consumption"),
			},
			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 java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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(Map.ofEntries(
                Map.entry("type", "UserAssigned"),
                Map.entry("userAssignedIdentities", Map.of("/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1", ))
            ))
            .location("West US")
            .publisherEmail("apim@autorestsdk.com")
            .publisherName("autorestsdk")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .sku(Map.ofEntries(
                Map.entry("capacity", 0),
                Map.entry("name", "Consumption")
            ))
            .tags(Map.ofEntries(
                Map.entry("tag1", "value1"),
                Map.entry("tag2", "value2"),
                Map.entry("tag3", "value3")
            ))
            .build());

        }
}
import pulumi
import pulumi_azure_native as azure_native

api_management_service = azure_native.apimanagement.ApiManagementService("apiManagementService",
    identity=azure_native.apimanagement.ApiManagementServiceIdentityArgs(
        type="UserAssigned",
        user_assigned_identities={
            "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/apimService1": azure_native.apimanagement.UserIdentityPropertiesArgs(),
        },
    ),
    location="West US",
    publisher_email="apim@autorestsdk.com",
    publisher_name="autorestsdk",
    resource_group_name="rg1",
    service_name="apimService1",
    sku=azure_native.apimanagement.ApiManagementServiceSkuPropertiesArgs(
        capacity=0,
        name="Consumption",
    ),
    tags={
        "tag1": "value1",
        "tag2": "value2",
        "tag3": "value3",
    })
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const apiManagementService = new azure_native.apimanagement.ApiManagementService("apiManagementService", {
    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",
    },
});
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 Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var apiManagementService = new AzureNative.ApiManagement.ApiManagementService("apiManagementService", new AzureNative.ApiManagement.ApiManagementServiceArgs
        {
            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 = "Developer",
            },
        });
    }

}
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"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("Developer"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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(Map.ofEntries(
                Map.entry("capacity", 1),
                Map.entry("name", "Developer")
            ))
            .build());

        }
}
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=azure_native.apimanagement.ApiManagementServiceSkuPropertiesArgs(
        capacity=1,
        name="Developer",
    ))
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: "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 a ApiManagementService Resource

new ApiManagementService(name: string, args: ApiManagementServiceArgs, opts?: CustomResourceOptions);
@overload
def ApiManagementService(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         additional_locations: Optional[Sequence[AdditionalLocationArgs]] = None,
                         api_version_constraint: Optional[ApiVersionConstraintArgs] = None,
                         certificates: Optional[Sequence[CertificateConfigurationArgs]] = None,
                         custom_properties: Optional[Mapping[str, str]] = None,
                         disable_gateway: Optional[bool] = None,
                         enable_client_certificate: Optional[bool] = None,
                         hostname_configurations: Optional[Sequence[HostnameConfigurationArgs]] = None,
                         identity: Optional[ApiManagementServiceIdentityArgs] = None,
                         location: Optional[str] = None,
                         notification_sender_email: Optional[str] = None,
                         publisher_email: Optional[str] = None,
                         publisher_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         restore: Optional[bool] = None,
                         service_name: Optional[str] = None,
                         sku: Optional[ApiManagementServiceSkuPropertiesArgs] = 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)
@overload
def ApiManagementService(resource_name: str,
                         args: ApiManagementServiceArgs,
                         opts: Optional[ResourceOptions] = 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.

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.

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

The ApiManagementService resource accepts the following input properties:

PublisherEmail string

Publisher email.

PublisherName string

Publisher name.

ResourceGroupName string

The name of the resource group.

Sku Pulumi.AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesArgs

SKU properties of the API Management service.

AdditionalLocations List<Pulumi.AzureNative.ApiManagement.Inputs.AdditionalLocationArgs>

Additional datacenter locations of the API Management service.

ApiVersionConstraint Pulumi.AzureNative.ApiManagement.Inputs.ApiVersionConstraintArgs

Control Plane Apis version constraint for the API Management service.

Certificates List<Pulumi.AzureNative.ApiManagement.Inputs.CertificateConfigurationArgs>

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

CustomProperties Dictionary<string, string>

Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can 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 is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.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 is true for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: 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,TLS_RSA_WITH_AES_256_GCM_SHA384

DisableGateway bool

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

EnableClientCertificate bool

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.

HostnameConfigurations List<Pulumi.AzureNative.ApiManagement.Inputs.HostnameConfigurationArgs>

Custom hostname configuration of the API Management service.

Identity Pulumi.AzureNative.ApiManagement.Inputs.ApiManagementServiceIdentityArgs

Managed service identity of the Api Management service.

Location string

Resource location.

NotificationSenderEmail string

Email address from which the notification will be sent.

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.

ServiceName string

The name of the API Management service.

Tags Dictionary<string, string>

Resource tags.

VirtualNetworkConfiguration Pulumi.AzureNative.ApiManagement.Inputs.VirtualNetworkConfigurationArgs

Virtual network configuration of the API Management service.

VirtualNetworkType string | Pulumi.AzureNative.ApiManagement.VirtualNetworkType

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.

PublisherEmail string

Publisher email.

PublisherName string

Publisher name.

ResourceGroupName string

The name of the resource group.

Sku ApiManagementServiceSkuPropertiesArgs

SKU properties of the API Management service.

AdditionalLocations []AdditionalLocationArgs

Additional datacenter locations of the API Management service.

ApiVersionConstraint ApiVersionConstraintArgs

Control Plane Apis version constraint for the API Management service.

Certificates []CertificateConfigurationArgs

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

CustomProperties map[string]string

Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can 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 is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.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 is true for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: 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,TLS_RSA_WITH_AES_256_GCM_SHA384

DisableGateway bool

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

EnableClientCertificate bool

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.

HostnameConfigurations []HostnameConfigurationArgs

Custom hostname configuration of the API Management service.

Identity ApiManagementServiceIdentityArgs

Managed service identity of the Api Management service.

Location string

Resource location.

NotificationSenderEmail string

Email address from which the notification will be sent.

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.

ServiceName string

The name of the API Management service.

Tags map[string]string

Resource tags.

VirtualNetworkConfiguration VirtualNetworkConfigurationArgs

Virtual network configuration of the API Management service.

VirtualNetworkType string | VirtualNetworkType

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.

publisherEmail String

Publisher email.

publisherName String

Publisher name.

resourceGroupName String

The name of the resource group.

sku ApiManagementServiceSkuPropertiesArgs

SKU properties of the API Management service.

additionalLocations ListLocationArgs>

Additional datacenter locations of the API Management service.

apiVersionConstraint ApiVersionConstraintArgs

Control Plane Apis version constraint for the API Management service.

certificates ListConfigurationArgs>

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

customProperties Map

Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can 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 is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.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 is true for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: 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,TLS_RSA_WITH_AES_256_GCM_SHA384

disableGateway Boolean

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

enableClientCertificate Boolean

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.

hostnameConfigurations ListConfigurationArgs>

Custom hostname configuration of the API Management service.

identity ApiManagementServiceIdentityArgs

Managed service identity of the Api Management service.

location String

Resource location.

notificationSenderEmail String

Email address from which the notification will be sent.

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.

serviceName String

The name of the API Management service.

tags Map

Resource tags.

virtualNetworkConfiguration VirtualNetworkConfigurationArgs

Virtual network configuration of the API Management service.

virtualNetworkType String | VirtualNetworkType

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

A list of availability zones denoting where the resource needs to come from.

publisherEmail string

Publisher email.

publisherName string

Publisher name.

resourceGroupName string

The name of the resource group.

sku ApiManagementServiceSkuPropertiesArgs

SKU properties of the API Management service.

additionalLocations AdditionalLocationArgs[]

Additional datacenter locations of the API Management service.

apiVersionConstraint ApiVersionConstraintArgs

Control Plane Apis version constraint for the API Management service.

certificates CertificateConfigurationArgs[]

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

customProperties {[key: string]: string}

Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can 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 is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.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 is true for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: 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,TLS_RSA_WITH_AES_256_GCM_SHA384

disableGateway boolean

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

enableClientCertificate boolean

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.

hostnameConfigurations HostnameConfigurationArgs[]

Custom hostname configuration of the API Management service.

identity ApiManagementServiceIdentityArgs

Managed service identity of the Api Management service.

location string

Resource location.

notificationSenderEmail string

Email address from which the notification will be sent.

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.

serviceName string

The name of the API Management service.

tags {[key: string]: string}

Resource tags.

virtualNetworkConfiguration VirtualNetworkConfigurationArgs

Virtual network configuration of the API Management service.

virtualNetworkType string | VirtualNetworkType

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_name str

The name of the resource group.

sku ApiManagementServiceSkuPropertiesArgs

SKU properties of the API Management service.

additional_locations Sequence[AdditionalLocationArgs]

Additional datacenter locations of the API Management service.

api_version_constraint ApiVersionConstraintArgs

Control Plane Apis version constraint for the API Management service.

certificates Sequence[CertificateConfigurationArgs]

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.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can 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 is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.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 is true for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: 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,TLS_RSA_WITH_AES_256_GCM_SHA384

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_certificate bool

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[HostnameConfigurationArgs]

Custom hostname configuration of the API Management service.

identity ApiManagementServiceIdentityArgs

Managed service identity of the Api Management service.

location str

Resource location.

notification_sender_email str

Email address from which the notification will be sent.

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.

tags Mapping[str, str]

Resource tags.

virtual_network_configuration VirtualNetworkConfigurationArgs

Virtual network configuration of the API Management service.

virtual_network_type str | VirtualNetworkType

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.

publisherEmail String

Publisher email.

publisherName String

Publisher name.

resourceGroupName String

The name of the resource group.

sku Property Map

SKU properties of the API Management service.

additionalLocations List

Additional datacenter locations of the API Management service.

apiVersionConstraint Property Map

Control Plane Apis version constraint for the API Management service.

certificates List

List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.

customProperties Map

Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can 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 is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting's default value is False.You can disable any of next ciphers by using settings Microsoft.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 is true for them. Note: next ciphers can't be disabled since they are required by Azure CloudService internal components: 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,TLS_RSA_WITH_AES_256_GCM_SHA384

disableGateway Boolean

Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.

enableClientCertificate Boolean

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.

hostnameConfigurations List

Custom hostname configuration of the API Management service.

identity Property Map

Managed service identity of the Api Management service.

location String

Resource location.

notificationSenderEmail String

Email address from which the notification will be sent.

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.

serviceName String

The name of the API Management service.

tags Map

Resource tags.

virtualNetworkConfiguration Property Map

Virtual network configuration of the API Management service.

virtualNetworkType String | "None" | "External" | "Internal"

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

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:

CreatedAtUtc string

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

DeveloperPortalUrl string

DEveloper Portal endpoint URL of the API Management service.

Etag string

ETag of the resource.

GatewayRegionalUrl string

Gateway URL of the API Management service in the Default Region.

GatewayUrl string

Gateway URL of the API Management service.

Id string

The provider-assigned unique ID for this managed resource.

ManagementApiUrl string

Management API endpoint URL of the API Management service.

Name string

Resource name.

PortalUrl string

Publisher portal endpoint Url of the API Management service.

PrivateIPAddresses 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.

ProvisioningState 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.

PublicIPAddresses 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.

ScmUrl string

SCM endpoint URL of the API Management service.

TargetProvisioningState string

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.

CreatedAtUtc string

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

DeveloperPortalUrl string

DEveloper Portal endpoint URL of the API Management service.

Etag string

ETag of the resource.

GatewayRegionalUrl string

Gateway URL of the API Management service in the Default Region.

GatewayUrl string

Gateway URL of the API Management service.

Id string

The provider-assigned unique ID for this managed resource.

ManagementApiUrl string

Management API endpoint URL of the API Management service.

Name string

Resource name.

PortalUrl string

Publisher portal endpoint Url of the API Management service.

PrivateIPAddresses []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.

ProvisioningState 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.

PublicIPAddresses []string

Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.

ScmUrl string

SCM endpoint URL of the API Management service.

TargetProvisioningState string

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.

createdAtUtc String

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

developerPortalUrl String

DEveloper Portal endpoint URL of the API Management service.

etag String

ETag of the resource.

gatewayRegionalUrl String

Gateway URL of the API Management service in the Default Region.

gatewayUrl String

Gateway URL of the API Management service.

id String

The provider-assigned unique ID for this managed resource.

managementApiUrl String

Management API endpoint URL of the API Management service.

name String

Resource name.

portalUrl String

Publisher portal endpoint Url of the API Management service.

privateIPAddresses List

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.

provisioningState 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.

publicIPAddresses List

Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.

scmUrl String

SCM endpoint URL of the API Management service.

targetProvisioningState String

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.

createdAtUtc string

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

developerPortalUrl string

DEveloper Portal endpoint URL of the API Management service.

etag string

ETag of the resource.

gatewayRegionalUrl string

Gateway URL of the API Management service in the Default Region.

gatewayUrl string

Gateway URL of the API Management service.

id string

The provider-assigned unique ID for this managed resource.

managementApiUrl string

Management API endpoint URL of the API Management service.

name string

Resource name.

portalUrl string

Publisher portal endpoint Url of the API Management service.

privateIPAddresses 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.

provisioningState 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.

publicIPAddresses string[]

Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.

scmUrl string

SCM endpoint URL of the API Management service.

targetProvisioningState string

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_utc str

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

developer_portal_url str

DEveloper Portal endpoint URL of the API Management service.

etag str

ETag of the resource.

gateway_regional_url str

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_url str

Management API endpoint URL of the API Management service.

name str

Resource name.

portal_url str

Publisher portal endpoint Url of the API Management service.

private_ip_addresses Sequence[str]

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_addresses Sequence[str]

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.

target_provisioning_state str

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.

createdAtUtc String

Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

developerPortalUrl String

DEveloper Portal endpoint URL of the API Management service.

etag String

ETag of the resource.

gatewayRegionalUrl String

Gateway URL of the API Management service in the Default Region.

gatewayUrl String

Gateway URL of the API Management service.

id String

The provider-assigned unique ID for this managed resource.

managementApiUrl String

Management API endpoint URL of the API Management service.

name String

Resource name.

portalUrl String

Publisher portal endpoint Url of the API Management service.

privateIPAddresses List

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.

provisioningState 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.

publicIPAddresses List

Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.

scmUrl String

SCM endpoint URL of the API Management service.

targetProvisioningState String

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

Location string

The location name of the additional region among Azure Data center regions.

Sku Pulumi.AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuProperties

SKU properties of the API Management service.

DisableGateway 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.

VirtualNetworkConfiguration Pulumi.AzureNative.ApiManagement.Inputs.VirtualNetworkConfiguration

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 ApiManagementServiceSkuProperties

SKU properties of the API Management service.

DisableGateway 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.

VirtualNetworkConfiguration VirtualNetworkConfiguration

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 ApiManagementServiceSkuProperties

SKU properties of the API Management service.

disableGateway 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.

virtualNetworkConfiguration VirtualNetworkConfiguration

Virtual network configuration for the location.

zones List

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 ApiManagementServiceSkuProperties

SKU properties of the API Management service.

disableGateway 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.

virtualNetworkConfiguration VirtualNetworkConfiguration

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 ApiManagementServiceSkuProperties

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.

virtual_network_configuration VirtualNetworkConfiguration

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.

disableGateway 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.

virtualNetworkConfiguration Property Map

Virtual network configuration for the location.

zones List

A list of availability zones denoting where the resource needs to come from.

AdditionalLocationResponse

GatewayRegionalUrl string

Gateway URL of the API Management service in the Region.

Location string

The location name of the additional region among Azure Data center regions.

PrivateIPAddresses 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.

PublicIPAddresses 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.AzureNative.ApiManagement.Inputs.ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

DisableGateway 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.

VirtualNetworkConfiguration Pulumi.AzureNative.ApiManagement.Inputs.VirtualNetworkConfigurationResponse

Virtual network configuration for the location.

Zones List<string>

A list of availability zones denoting where the resource needs to come from.

GatewayRegionalUrl string

Gateway URL of the API Management service in the Region.

Location string

The location name of the additional region among Azure Data center regions.

PrivateIPAddresses []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.

PublicIPAddresses []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 ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

DisableGateway 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.

VirtualNetworkConfiguration VirtualNetworkConfigurationResponse

Virtual network configuration for the location.

Zones []string

A list of availability zones denoting where the resource needs to come from.

gatewayRegionalUrl String

Gateway URL of the API Management service in the Region.

location String

The location name of the additional region among Azure Data center regions.

privateIPAddresses List

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.

publicIPAddresses List

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 ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

disableGateway 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.

virtualNetworkConfiguration VirtualNetworkConfigurationResponse

Virtual network configuration for the location.

zones List

A list of availability zones denoting where the resource needs to come from.

gatewayRegionalUrl string

Gateway URL of the API Management service in the Region.

location string

The location name of the additional region among Azure Data center regions.

privateIPAddresses 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.

publicIPAddresses 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 ApiManagementServiceSkuPropertiesResponse

SKU properties of the API Management service.

disableGateway 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.

virtualNetworkConfiguration VirtualNetworkConfigurationResponse

Virtual network configuration for the location.

zones string[]

A list of availability zones denoting where the resource needs to come from.

gateway_regional_url str

Gateway URL of the API Management service in the Region.

location str

The location name of the additional region among Azure Data center regions.

private_ip_addresses Sequence[str]

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_addresses Sequence[str]

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 ApiManagementServiceSkuPropertiesResponse

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.

virtual_network_configuration VirtualNetworkConfigurationResponse

Virtual network configuration for the location.

zones Sequence[str]

A list of availability zones denoting where the resource needs to come from.

gatewayRegionalUrl String

Gateway URL of the API Management service in the Region.

location String

The location name of the additional region among Azure Data center regions.

privateIPAddresses List

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.

publicIPAddresses List

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.

disableGateway 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.

virtualNetworkConfiguration Property Map

Virtual network configuration for the location.

zones List

A list of availability zones denoting where the resource needs to come from.

ApiManagementServiceIdentity

Type string | Pulumi.AzureNative.ApiManagement.ApimIdentityType

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.

UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.ApiManagement.Inputs.UserIdentityProperties>

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 | ApimIdentityType

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.

UserAssignedIdentities map[string]UserIdentityProperties

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 | ApimIdentityType

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.

userAssignedIdentities MapIdentityProperties>

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 | ApimIdentityType

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.

userAssignedIdentities {[key: string]: UserIdentityProperties}

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 | ApimIdentityType

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_identities Mapping[str, UserIdentityProperties]

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 | "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "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.

userAssignedIdentities Map

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

PrincipalId string

The principal id of the identity.

TenantId 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.

UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.ApiManagement.Inputs.UserIdentityPropertiesResponse>

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}'.

PrincipalId string

The principal id of the identity.

TenantId 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.

UserAssignedIdentities map[string]UserIdentityPropertiesResponse

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}'.

principalId String

The principal id of the identity.

tenantId 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.

userAssignedIdentities MapIdentityPropertiesResponse>

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}'.

principalId string

The principal id of the identity.

tenantId 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.

userAssignedIdentities {[key: string]: UserIdentityPropertiesResponse}

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_identities Mapping[str, UserIdentityPropertiesResponse]

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}'.

principalId String

The principal id of the identity.

tenantId 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.

userAssignedIdentities Map

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

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.AzureNative.ApiManagement.SkuType

Name of the Sku.

Capacity int

Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

Name string | SkuType

Name of the Sku.

capacity Integer

Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

name String | SkuType

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 | SkuType

Name of the Sku.

capacity int

Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

name str | SkuType

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

Capacity int

Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

Name string

Name of the Sku.

Capacity int

Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

Name string

Name of the Sku.

capacity Integer

Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

name String

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

Name of the Sku.

capacity int

Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0.

name str

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

Name of the Sku.

ApiVersionConstraint

MinApiVersion string

Limit control plane API calls to API Management service with version equal to or newer than this value.

MinApiVersion string

Limit control plane API calls to API Management service with version equal to or newer than this value.

minApiVersion String

Limit control plane API calls to API Management service with version equal to or newer than this value.

minApiVersion string

Limit control plane API calls to API Management service with version equal to or newer than this value.

min_api_version str

Limit control plane API calls to API Management service with version equal to or newer than this value.

minApiVersion String

Limit control plane API calls to API Management service with version equal to or newer than this value.

ApiVersionConstraintResponse

MinApiVersion string

Limit control plane API calls to API Management service with version equal to or newer than this value.

MinApiVersion string

Limit control plane API calls to API Management service with version equal to or newer than this value.

minApiVersion String

Limit control plane API calls to API Management service with version equal to or newer than this value.

minApiVersion string

Limit control plane API calls to API Management service with version equal to or newer than this value.

min_api_version str

Limit control plane API calls to API Management service with version equal to or newer than this value.

minApiVersion String

Limit control plane API calls to API Management service with version equal to or newer than this value.

ApimIdentityType

SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SystemAssigned_UserAssigned
SystemAssigned, UserAssigned
None
None
ApimIdentityTypeSystemAssigned
SystemAssigned
ApimIdentityTypeUserAssigned
UserAssigned
ApimIdentityType_SystemAssigned_UserAssigned
SystemAssigned, UserAssigned
ApimIdentityTypeNone
None
SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SystemAssigned_UserAssigned
SystemAssigned, UserAssigned
None
None
SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SystemAssigned_UserAssigned
SystemAssigned, UserAssigned
None
None
SYSTEM_ASSIGNED
SystemAssigned
USER_ASSIGNED
UserAssigned
SYSTEM_ASSIGNED_USER_ASSIGNED
SystemAssigned, UserAssigned
NONE
None
"SystemAssigned"
SystemAssigned
"UserAssigned"
UserAssigned
"SystemAssigned, UserAssigned"
SystemAssigned, UserAssigned
"None"
None

CertificateConfiguration

StoreName string

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

Certificate Pulumi.AzureNative.ApiManagement.Inputs.CertificateInformation

Certificate information.

CertificatePassword string

Certificate Password.

EncodedCertificate string

Base64 Encoded certificate.

StoreName string

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

Certificate CertificateInformation

Certificate information.

CertificatePassword string

Certificate Password.

EncodedCertificate string

Base64 Encoded certificate.

storeName String

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

certificate CertificateInformation

Certificate information.

certificatePassword String

Certificate Password.

encodedCertificate String

Base64 Encoded certificate.

storeName string

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

certificate CertificateInformation

Certificate information.

certificatePassword string

Certificate Password.

encodedCertificate string

Base64 Encoded certificate.

store_name str

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

certificate CertificateInformation

Certificate information.

certificate_password str

Certificate Password.

encoded_certificate str

Base64 Encoded certificate.

storeName String

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

certificate Property Map

Certificate information.

certificatePassword String

Certificate Password.

encodedCertificate String

Base64 Encoded certificate.

CertificateConfigurationResponse

StoreName string

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

Certificate Pulumi.AzureNative.ApiManagement.Inputs.CertificateInformationResponse

Certificate information.

CertificatePassword string

Certificate Password.

EncodedCertificate string

Base64 Encoded certificate.

StoreName string

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

Certificate CertificateInformationResponse

Certificate information.

CertificatePassword string

Certificate Password.

EncodedCertificate string

Base64 Encoded certificate.

storeName String

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

certificate CertificateInformationResponse

Certificate information.

certificatePassword String

Certificate Password.

encodedCertificate String

Base64 Encoded certificate.

storeName string

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

certificate CertificateInformationResponse

Certificate information.

certificatePassword string

Certificate Password.

encodedCertificate string

Base64 Encoded certificate.

store_name str

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

certificate CertificateInformationResponse

Certificate information.

certificate_password str

Certificate Password.

encoded_certificate str

Base64 Encoded certificate.

storeName String

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

certificate Property Map

Certificate information.

certificatePassword String

Certificate Password.

encodedCertificate String

Base64 Encoded certificate.

CertificateInformation

Expiry string

Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as 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:ssZ as 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:ssZ as 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:ssZ as 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:ssZ as 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:ssZ as specified by the ISO 8601 standard.

subject String

Subject of the certificate.

thumbprint String

Thumbprint of the certificate.

CertificateInformationResponse

Expiry string

Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as 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:ssZ as 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:ssZ as 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:ssZ as 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:ssZ as 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:ssZ as specified by the ISO 8601 standard.

subject String

Subject of the certificate.

thumbprint String

Thumbprint of the certificate.

HostnameConfiguration

HostName string

Hostname to configure on the Api Management service.

Type string | Pulumi.AzureNative.ApiManagement.HostnameType

Hostname type.

Certificate Pulumi.AzureNative.ApiManagement.Inputs.CertificateInformation

Certificate information.

CertificatePassword string

Certificate Password.

DefaultSslBinding bool

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 Proxy Hostname Type.

EncodedCertificate string

Base64 Encoded certificate.

IdentityClientId string

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

KeyVaultId string

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

NegotiateClientCertificate bool

Specify true to always negotiate client certificate on the hostname. Default Value is false.

HostName string

Hostname to configure on the Api Management service.

Type string | HostnameType

Hostname type.

Certificate CertificateInformation

Certificate information.

CertificatePassword string

Certificate Password.

DefaultSslBinding bool

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 Proxy Hostname Type.

EncodedCertificate string

Base64 Encoded certificate.

IdentityClientId string

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

KeyVaultId string

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

NegotiateClientCertificate bool

Specify true to always negotiate client certificate on the hostname. Default Value is false.

hostName String

Hostname to configure on the Api Management service.

type String | HostnameType

Hostname type.

certificate CertificateInformation

Certificate information.

certificatePassword String

Certificate Password.

defaultSslBinding Boolean

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 Proxy Hostname Type.

encodedCertificate String

Base64 Encoded certificate.

identityClientId String

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

keyVaultId String

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

negotiateClientCertificate Boolean

Specify true to always negotiate client certificate on the hostname. Default Value is false.

hostName string

Hostname to configure on the Api Management service.

type string | HostnameType

Hostname type.

certificate CertificateInformation

Certificate information.

certificatePassword string

Certificate Password.

defaultSslBinding boolean

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 Proxy Hostname Type.

encodedCertificate string

Base64 Encoded certificate.

identityClientId string

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

keyVaultId string

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

negotiateClientCertificate boolean

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 | HostnameType

Hostname type.

certificate CertificateInformation

Certificate information.

certificate_password str

Certificate Password.

default_ssl_binding bool

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 Proxy Hostname Type.

encoded_certificate str

Base64 Encoded certificate.

identity_client_id str

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_id str

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_certificate bool

Specify true to always negotiate client certificate on the hostname. Default Value is false.

hostName String

Hostname to configure on the Api Management service.

type String | "Proxy" | "Portal" | "Management" | "Scm" | "DeveloperPortal"

Hostname type.

certificate Property Map

Certificate information.

certificatePassword String

Certificate Password.

defaultSslBinding Boolean

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 Proxy Hostname Type.

encodedCertificate String

Base64 Encoded certificate.

identityClientId String

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

keyVaultId String

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

negotiateClientCertificate Boolean

Specify true to always negotiate client certificate on the hostname. Default Value is false.

HostnameConfigurationResponse

HostName string

Hostname to configure on the Api Management service.

Type string

Hostname type.

Certificate Pulumi.AzureNative.ApiManagement.Inputs.CertificateInformationResponse

Certificate information.

CertificatePassword string

Certificate Password.

DefaultSslBinding bool

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 Proxy Hostname Type.

EncodedCertificate string

Base64 Encoded certificate.

IdentityClientId string

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

KeyVaultId string

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

NegotiateClientCertificate bool

Specify true to always negotiate client certificate on the hostname. Default Value is false.

HostName string

Hostname to configure on the Api Management service.

Type string

Hostname type.

Certificate CertificateInformationResponse

Certificate information.

CertificatePassword string

Certificate Password.

DefaultSslBinding bool

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 Proxy Hostname Type.

EncodedCertificate string

Base64 Encoded certificate.

IdentityClientId string

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

KeyVaultId string

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

NegotiateClientCertificate bool

Specify true to always negotiate client certificate on the hostname. Default Value is false.

hostName String

Hostname to configure on the Api Management service.

type String

Hostname type.

certificate CertificateInformationResponse

Certificate information.

certificatePassword String

Certificate Password.

defaultSslBinding Boolean

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 Proxy Hostname Type.

encodedCertificate String

Base64 Encoded certificate.

identityClientId String

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

keyVaultId String

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

negotiateClientCertificate Boolean

Specify true to always negotiate client certificate on the hostname. Default Value is false.

hostName string

Hostname to configure on the Api Management service.

type string

Hostname type.

certificate CertificateInformationResponse

Certificate information.

certificatePassword string

Certificate Password.

defaultSslBinding boolean

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 Proxy Hostname Type.

encodedCertificate string

Base64 Encoded certificate.

identityClientId string

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

keyVaultId string

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

negotiateClientCertificate boolean

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 CertificateInformationResponse

Certificate information.

certificate_password str

Certificate Password.

default_ssl_binding bool

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 Proxy Hostname Type.

encoded_certificate str

Base64 Encoded certificate.

identity_client_id str

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_id str

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_certificate bool

Specify true to always negotiate client certificate on the hostname. Default Value is false.

hostName String

Hostname to configure on the Api Management service.

type String

Hostname type.

certificate Property Map

Certificate information.

certificatePassword String

Certificate Password.

defaultSslBinding Boolean

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 Proxy Hostname Type.

encodedCertificate String

Base64 Encoded certificate.

identityClientId String

System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

keyVaultId String

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

negotiateClientCertificate Boolean

Specify true to always negotiate client certificate on the hostname. Default Value is false.

HostnameType

Proxy
Proxy
Portal
Portal
Management
Management
Scm
Scm
DeveloperPortal
DeveloperPortal
HostnameTypeProxy
Proxy
HostnameTypePortal
Portal
HostnameTypeManagement
Management
HostnameTypeScm
Scm
HostnameTypeDeveloperPortal
DeveloperPortal
Proxy
Proxy
Portal
Portal
Management
Management
Scm
Scm
DeveloperPortal
DeveloperPortal
Proxy
Proxy
Portal
Portal
Management
Management
Scm
Scm
DeveloperPortal
DeveloperPortal
PROXY
Proxy
PORTAL
Portal
MANAGEMENT
Management
SCM
Scm
DEVELOPER_PORTAL
DeveloperPortal
"Proxy"
Proxy
"Portal"
Portal
"Management"
Management
"Scm"
Scm
"DeveloperPortal"
DeveloperPortal

SkuType

Developer
Developer

Developer SKU of Api Management.

Standard
Standard

Standard SKU of Api Management.

Premium
Premium

Premium SKU of Api Management.

Basic
Basic

Basic SKU of Api Management.

Consumption
Consumption

Consumption SKU of Api Management.

Isolated
Isolated

Isolated SKU of Api Management.

SkuTypeDeveloper
Developer

Developer SKU of Api Management.

SkuTypeStandard
Standard

Standard SKU of Api Management.

SkuTypePremium
Premium

Premium SKU of Api Management.

SkuTypeBasic
Basic

Basic SKU of Api Management.

SkuTypeConsumption
Consumption

Consumption SKU of Api Management.

SkuTypeIsolated
Isolated

Isolated SKU of Api Management.

Developer
Developer

Developer SKU of Api Management.

Standard
Standard

Standard SKU of Api Management.

Premium
Premium

Premium SKU of Api Management.

Basic
Basic

Basic SKU of Api Management.

Consumption
Consumption

Consumption SKU of Api Management.

Isolated
Isolated

Isolated SKU of Api Management.

Developer
Developer

Developer SKU of Api Management.

Standard
Standard

Standard SKU of Api Management.

Premium
Premium

Premium SKU of Api Management.

Basic
Basic

Basic SKU of Api Management.

Consumption
Consumption

Consumption SKU of Api Management.

Isolated
Isolated

Isolated SKU of Api Management.

DEVELOPER
Developer

Developer SKU of Api Management.

STANDARD
Standard

Standard SKU of Api Management.

PREMIUM
Premium

Premium SKU of Api Management.

BASIC
Basic

Basic SKU of Api Management.

CONSUMPTION
Consumption

Consumption SKU of Api Management.

ISOLATED
Isolated

Isolated SKU of Api Management.

"Developer"
Developer

Developer SKU of Api Management.

"Standard"
Standard

Standard SKU of Api Management.

"Premium"
Premium

Premium SKU of Api Management.

"Basic"
Basic

Basic SKU of Api Management.

"Consumption"
Consumption

Consumption SKU of Api Management.

"Isolated"
Isolated

Isolated SKU of Api Management.

UserIdentityProperties

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

clientId string

The client id of user assigned identity.

principalId 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.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

UserIdentityPropertiesResponse

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

ClientId string

The client id of user assigned identity.

PrincipalId string

The principal id of user assigned identity.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

clientId string

The client id of user assigned identity.

principalId 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.

clientId String

The client id of user assigned identity.

principalId String

The principal id of user assigned identity.

VirtualNetworkConfiguration

SubnetResourceId string

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

SubnetResourceId string

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

subnetResourceId String

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

subnetResourceId string

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

subnet_resource_id str

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

subnetResourceId String

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

VirtualNetworkConfigurationResponse

Subnetname string

The name of the subnet.

Vnetid string

The virtual network ID. This is typically a GUID. Expect a null GUID by default.

SubnetResourceId string

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.

SubnetResourceId string

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.

subnetResourceId String

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.

subnetResourceId string

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_id str

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.

subnetResourceId String

The full resource ID of a subnet in a virtual network to deploy the API Management service in.

VirtualNetworkType

None
None

The service is not part of any Virtual Network.

External
External

The service is part of Virtual Network and it is accessible from Internet.

Internal
Internal

The service is part of Virtual Network and it is only accessible from within the virtual network.

VirtualNetworkTypeNone
None

The service is not part of any Virtual Network.

VirtualNetworkTypeExternal
External

The service is part of Virtual Network and it is accessible from Internet.

VirtualNetworkTypeInternal
Internal

The service is part of Virtual Network and it is only accessible from within the virtual network.

None
None

The service is not part of any Virtual Network.

External
External

The service is part of Virtual Network and it is accessible from Internet.

Internal
Internal

The service is part of Virtual Network and it is only accessible from within the virtual network.

None
None

The service is not part of any Virtual Network.

External
External

The service is part of Virtual Network and it is accessible from Internet.

Internal
Internal

The service is part of Virtual Network and it is only accessible from within the virtual network.

NONE
None

The service is not part of any Virtual Network.

EXTERNAL
External

The service is part of Virtual Network and it is accessible from Internet.

INTERNAL
Internal

The service is part of Virtual Network and it is only accessible from within the virtual network.

"None"
None

The service is not part of any Virtual Network.

"External"
External

The service is part of Virtual Network and it is accessible from Internet.

"Internal"
Internal

The 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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0