1. Docs
  2. Reference
  3. API
  4. Azure
  5. apimanagement
  6. Service

Service

Manages an API Management Service.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleService = new Azure.ApiManagement.Service("exampleService", new Azure.ApiManagement.ServiceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            PublisherName = "My Company",
            PublisherEmail = "company@exmaple.com",
            SkuName = "Developer_1",
            Policy = new Azure.ApiManagement.Inputs.ServicePolicyArgs
            {
                XmlContent = @"    <policies>
      <inbound />
      <backend />
      <outbound />
      <on-error />
    </policies>
",
            },
        });
    }

}

package main

import (
    "fmt"

    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/apimanagement"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West Europe"),
        })
        if err != nil {
            return err
        }
        _, err = apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.Name,
            PublisherName:     pulumi.String("My Company"),
            PublisherEmail:    pulumi.String("company@exmaple.com"),
            SkuName:           pulumi.String("Developer_1"),
            Policy: &apimanagement.ServicePolicyArgs{
                XmlContent: pulumi.String(fmt.Sprintf("%v%v%v%v%v%v", "    <policies>\n", "      <inbound />\n", "      <backend />\n", "      <outbound />\n", "      <on-error />\n", "    </policies>\n")),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@exmaple.com",
    sku_name="Developer_1",
    policy={
        "xml_content": """    <policies>
      <inbound />
      <backend />
      <outbound />
      <on-error />
    </policies>
""",
    })
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@exmaple.com",
    skuName: "Developer_1",
    policy: {
        xmlContent: `    <policies>
      <inbound />
      <backend />
      <outbound />
      <on-error />
    </policies>
`,
    },
});

Create a Service Resource

new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
def Service(resource_name, opts=None, additional_locations=None, certificates=None, hostname_configuration=None, identity=None, location=None, name=None, notification_sender_email=None, policy=None, protocols=None, publisher_email=None, publisher_name=None, resource_group_name=None, security=None, sign_in=None, sign_up=None, sku_name=None, tags=None, virtual_network_configuration=None, virtual_network_type=None, __props__=None);
func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ServiceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Service Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Service resource accepts the following input properties:

PublisherEmail string

The email of publisher/company.

PublisherName string

The name of publisher/company.

ResourceGroupName string

The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.

SkuName string

sku_name is a string consisting of two parts separated by an underscore(_). The fist part is the name, valid values include: Consumption, Developer, Basic, Standard and Premium. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. Developer_1).

AdditionalLocations List<ServiceAdditionalLocationArgs>

One or more additional_location blocks as defined below.

Certificates List<ServiceCertificateArgs>

One or more (up to 10) certificate blocks as defined below.

HostnameConfiguration ServiceHostnameConfigurationArgs

A hostname_configuration block as defined below.

Identity ServiceIdentityArgs

An identity block is documented below.

Location string

The Azure location where the API Management Service exists. Changing this forces a new resource to be created.

Name string

The name of the API Management Service. Changing this forces a new resource to be created.

NotificationSenderEmail string

Email address from which the notification will be sent.

Policy ServicePolicyArgs

A policy block as defined below.

Protocols ServiceProtocolsArgs

A protocols block as defined below.

Security ServiceSecurityArgs

A security block as defined below.

SignIn ServiceSignInArgs

A sign_in block as defined below.

SignUp ServiceSignUpArgs

A sign_up block as defined below.

Tags Dictionary<string, string>

A mapping of tags assigned to the resource.

VirtualNetworkConfiguration ServiceVirtualNetworkConfigurationArgs

A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.

VirtualNetworkType string

The type of virtual network you want to use, valid values include: None, External, Internal.

PublisherEmail string

The email of publisher/company.

PublisherName string

The name of publisher/company.

ResourceGroupName string

The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.

SkuName string

sku_name is a string consisting of two parts separated by an underscore(_). The fist part is the name, valid values include: Consumption, Developer, Basic, Standard and Premium. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. Developer_1).

AdditionalLocations []ServiceAdditionalLocation

One or more additional_location blocks as defined below.

Certificates []ServiceCertificate

One or more (up to 10) certificate blocks as defined below.

HostnameConfiguration ServiceHostnameConfiguration

A hostname_configuration block as defined below.

Identity ServiceIdentity

An identity block is documented below.

Location string

The Azure location where the API Management Service exists. Changing this forces a new resource to be created.

Name string

The name of the API Management Service. Changing this forces a new resource to be created.

NotificationSenderEmail string

Email address from which the notification will be sent.

Policy ServicePolicy

A policy block as defined below.

Protocols ServiceProtocols

A protocols block as defined below.

Security ServiceSecurity

A security block as defined below.

SignIn ServiceSignIn

A sign_in block as defined below.

SignUp ServiceSignUp

A sign_up block as defined below.

Tags map[string]string

A mapping of tags assigned to the resource.

VirtualNetworkConfiguration ServiceVirtualNetworkConfiguration

A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.

VirtualNetworkType string

The type of virtual network you want to use, valid values include: None, External, Internal.

publisherEmail string

The email of publisher/company.

publisherName string

The name of publisher/company.

resourceGroupName string

The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.

skuName string

sku_name is a string consisting of two parts separated by an underscore(_). The fist part is the name, valid values include: Consumption, Developer, Basic, Standard and Premium. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. Developer_1).

additionalLocations ServiceAdditionalLocation[]

One or more additional_location blocks as defined below.

certificates ServiceCertificate[]

One or more (up to 10) certificate blocks as defined below.

hostnameConfiguration ServiceHostnameConfiguration

A hostname_configuration block as defined below.

identity ServiceIdentity

An identity block is documented below.

location string

The Azure location where the API Management Service exists. Changing this forces a new resource to be created.

name string

The name of the API Management Service. Changing this forces a new resource to be created.

notificationSenderEmail string

Email address from which the notification will be sent.

policy ServicePolicy

A policy block as defined below.

protocols ServiceProtocols

A protocols block as defined below.

security ServiceSecurity

A security block as defined below.

signIn ServiceSignIn

A sign_in block as defined below.

signUp ServiceSignUp

A sign_up block as defined below.

tags {[key: string]: string}

A mapping of tags assigned to the resource.

virtualNetworkConfiguration ServiceVirtualNetworkConfiguration

A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.

virtualNetworkType string

The type of virtual network you want to use, valid values include: None, External, Internal.

publisher_email str

The email of publisher/company.

publisher_name str

The name of publisher/company.

resource_group_name str

The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.

sku_name str

sku_name is a string consisting of two parts separated by an underscore(_). The fist part is the name, valid values include: Consumption, Developer, Basic, Standard and Premium. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. Developer_1).

additional_locations List[ServiceAdditionalLocation]

One or more additional_location blocks as defined below.

certificates List[ServiceCertificate]

One or more (up to 10) certificate blocks as defined below.

hostname_configuration Dict[ServiceHostnameConfiguration]

A hostname_configuration block as defined below.

identity Dict[ServiceIdentity]

An identity block is documented below.

location str

The Azure location where the API Management Service exists. Changing this forces a new resource to be created.

name str

The name of the API Management Service. Changing this forces a new resource to be created.

notification_sender_email str

Email address from which the notification will be sent.

policy Dict[ServicePolicy]

A policy block as defined below.

protocols Dict[ServiceProtocols]

A protocols block as defined below.

security Dict[ServiceSecurity]

A security block as defined below.

sign_in Dict[ServiceSignIn]

A sign_in block as defined below.

sign_up Dict[ServiceSignUp]

A sign_up block as defined below.

tags Dict[str, str]

A mapping of tags assigned to the resource.

virtual_network_configuration Dict[ServiceVirtualNetworkConfiguration]

A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.

virtual_network_type str

The type of virtual network you want to use, valid values include: None, External, Internal.

Outputs

All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

DeveloperPortalUrl string

The URL for the Developer Portal associated with this API Management service.

GatewayRegionalUrl string

The URL of the Regional Gateway for the API Management Service in the specified region.

GatewayUrl string

The URL of the Gateway for the API Management Service.

Id string
The provider-assigned unique ID for this managed resource.
ManagementApiUrl string

The URL for the Management API associated with this API Management service.

PortalUrl string

The URL for the Publisher Portal associated with this API Management service.

PrivateIpAddresses List<string>
PublicIpAddresses List<string>

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

ScmUrl string

The URL for the SCM (Source Code Management) Endpoint associated with this API Management service.

DeveloperPortalUrl string

The URL for the Developer Portal associated with this API Management service.

GatewayRegionalUrl string

The URL of the Regional Gateway for the API Management Service in the specified region.

GatewayUrl string

The URL of the Gateway for the API Management Service.

Id string
The provider-assigned unique ID for this managed resource.
ManagementApiUrl string

The URL for the Management API associated with this API Management service.

PortalUrl string

The URL for the Publisher Portal associated with this API Management service.

PrivateIpAddresses []string
PublicIpAddresses []string

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

ScmUrl string

The URL for the SCM (Source Code Management) Endpoint associated with this API Management service.

developerPortalUrl string

The URL for the Developer Portal associated with this API Management service.

gatewayRegionalUrl string

The URL of the Regional Gateway for the API Management Service in the specified region.

gatewayUrl string

The URL of the Gateway for the API Management Service.

id string
The provider-assigned unique ID for this managed resource.
managementApiUrl string

The URL for the Management API associated with this API Management service.

portalUrl string

The URL for the Publisher Portal associated with this API Management service.

privateIpAddresses string[]
publicIpAddresses string[]

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

scmUrl string

The URL for the SCM (Source Code Management) Endpoint associated with this API Management service.

developer_portal_url str

The URL for the Developer Portal associated with this API Management service.

gateway_regional_url str

The URL of the Regional Gateway for the API Management Service in the specified region.

gateway_url str

The URL of the Gateway for the API Management Service.

id str
The provider-assigned unique ID for this managed resource.
management_api_url str

The URL for the Management API associated with this API Management service.

portal_url str

The URL for the Publisher Portal associated with this API Management service.

private_ip_addresses List[str]
public_ip_addresses List[str]

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

scm_url str

The URL for the SCM (Source Code Management) Endpoint associated with this API Management service.

Look up an Existing Service Resource

Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): Service
static get(resource_name, id, opts=None, additional_locations=None, certificates=None, developer_portal_url=None, gateway_regional_url=None, gateway_url=None, hostname_configuration=None, identity=None, location=None, management_api_url=None, name=None, notification_sender_email=None, policy=None, portal_url=None, private_ip_addresses=None, protocols=None, public_ip_addresses=None, publisher_email=None, publisher_name=None, resource_group_name=None, scm_url=None, security=None, sign_in=None, sign_up=None, sku_name=None, tags=None, virtual_network_configuration=None, virtual_network_type=None, __props__=None);
func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AdditionalLocations List<ServiceAdditionalLocationArgs>

One or more additional_location blocks as defined below.

Certificates List<ServiceCertificateArgs>

One or more (up to 10) certificate blocks as defined below.

DeveloperPortalUrl string

The URL for the Developer Portal associated with this API Management service.

GatewayRegionalUrl string

The URL of the Regional Gateway for the API Management Service in the specified region.

GatewayUrl string

The URL of the Gateway for the API Management Service.

HostnameConfiguration ServiceHostnameConfigurationArgs

A hostname_configuration block as defined below.

Identity ServiceIdentityArgs

An identity block is documented below.

Location string

The Azure location where the API Management Service exists. Changing this forces a new resource to be created.

ManagementApiUrl string

The URL for the Management API associated with this API Management service.

Name string

The name of the API Management Service. Changing this forces a new resource to be created.

NotificationSenderEmail string

Email address from which the notification will be sent.

Policy ServicePolicyArgs

A policy block as defined below.

PortalUrl string

The URL for the Publisher Portal associated with this API Management service.

PrivateIpAddresses List<string>
Protocols ServiceProtocolsArgs

A protocols block as defined below.

PublicIpAddresses List<string>

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

PublisherEmail string

The email of publisher/company.

PublisherName string

The name of publisher/company.

ResourceGroupName string

The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.

ScmUrl string

The URL for the SCM (Source Code Management) Endpoint associated with this API Management service.

Security ServiceSecurityArgs

A security block as defined below.

SignIn ServiceSignInArgs

A sign_in block as defined below.

SignUp ServiceSignUpArgs

A sign_up block as defined below.

SkuName string

sku_name is a string consisting of two parts separated by an underscore(_). The fist part is the name, valid values include: Consumption, Developer, Basic, Standard and Premium. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. Developer_1).

Tags Dictionary<string, string>

A mapping of tags assigned to the resource.

VirtualNetworkConfiguration ServiceVirtualNetworkConfigurationArgs

A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.

VirtualNetworkType string

The type of virtual network you want to use, valid values include: None, External, Internal.

AdditionalLocations []ServiceAdditionalLocation

One or more additional_location blocks as defined below.

Certificates []ServiceCertificate

One or more (up to 10) certificate blocks as defined below.

DeveloperPortalUrl string

The URL for the Developer Portal associated with this API Management service.

GatewayRegionalUrl string

The URL of the Regional Gateway for the API Management Service in the specified region.

GatewayUrl string

The URL of the Gateway for the API Management Service.

HostnameConfiguration ServiceHostnameConfiguration

A hostname_configuration block as defined below.

Identity ServiceIdentity

An identity block is documented below.

Location string

The Azure location where the API Management Service exists. Changing this forces a new resource to be created.

ManagementApiUrl string

The URL for the Management API associated with this API Management service.

Name string

The name of the API Management Service. Changing this forces a new resource to be created.

NotificationSenderEmail string

Email address from which the notification will be sent.

Policy ServicePolicy

A policy block as defined below.

PortalUrl string

The URL for the Publisher Portal associated with this API Management service.

PrivateIpAddresses []string
Protocols ServiceProtocols

A protocols block as defined below.

PublicIpAddresses []string

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

PublisherEmail string

The email of publisher/company.

PublisherName string

The name of publisher/company.

ResourceGroupName string

The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.

ScmUrl string

The URL for the SCM (Source Code Management) Endpoint associated with this API Management service.

Security ServiceSecurity

A security block as defined below.

SignIn ServiceSignIn

A sign_in block as defined below.

SignUp ServiceSignUp

A sign_up block as defined below.

SkuName string

sku_name is a string consisting of two parts separated by an underscore(_). The fist part is the name, valid values include: Consumption, Developer, Basic, Standard and Premium. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. Developer_1).

Tags map[string]string

A mapping of tags assigned to the resource.

VirtualNetworkConfiguration ServiceVirtualNetworkConfiguration

A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.

VirtualNetworkType string

The type of virtual network you want to use, valid values include: None, External, Internal.

additionalLocations ServiceAdditionalLocation[]

One or more additional_location blocks as defined below.

certificates ServiceCertificate[]

One or more (up to 10) certificate blocks as defined below.

developerPortalUrl string

The URL for the Developer Portal associated with this API Management service.

gatewayRegionalUrl string

The URL of the Regional Gateway for the API Management Service in the specified region.

gatewayUrl string

The URL of the Gateway for the API Management Service.

hostnameConfiguration ServiceHostnameConfiguration

A hostname_configuration block as defined below.

identity ServiceIdentity

An identity block is documented below.

location string

The Azure location where the API Management Service exists. Changing this forces a new resource to be created.

managementApiUrl string

The URL for the Management API associated with this API Management service.

name string

The name of the API Management Service. Changing this forces a new resource to be created.

notificationSenderEmail string

Email address from which the notification will be sent.

policy ServicePolicy

A policy block as defined below.

portalUrl string

The URL for the Publisher Portal associated with this API Management service.

privateIpAddresses string[]
protocols ServiceProtocols

A protocols block as defined below.

publicIpAddresses string[]

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

publisherEmail string

The email of publisher/company.

publisherName string

The name of publisher/company.

resourceGroupName string

The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.

scmUrl string

The URL for the SCM (Source Code Management) Endpoint associated with this API Management service.

security ServiceSecurity

A security block as defined below.

signIn ServiceSignIn

A sign_in block as defined below.

signUp ServiceSignUp

A sign_up block as defined below.

skuName string

sku_name is a string consisting of two parts separated by an underscore(_). The fist part is the name, valid values include: Consumption, Developer, Basic, Standard and Premium. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. Developer_1).

tags {[key: string]: string}

A mapping of tags assigned to the resource.

virtualNetworkConfiguration ServiceVirtualNetworkConfiguration

A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.

virtualNetworkType string

The type of virtual network you want to use, valid values include: None, External, Internal.

additional_locations List[ServiceAdditionalLocation]

One or more additional_location blocks as defined below.

certificates List[ServiceCertificate]

One or more (up to 10) certificate blocks as defined below.

developer_portal_url str

The URL for the Developer Portal associated with this API Management service.

gateway_regional_url str

The URL of the Regional Gateway for the API Management Service in the specified region.

gateway_url str

The URL of the Gateway for the API Management Service.

hostname_configuration Dict[ServiceHostnameConfiguration]

A hostname_configuration block as defined below.

identity Dict[ServiceIdentity]

An identity block is documented below.

location str

The Azure location where the API Management Service exists. Changing this forces a new resource to be created.

management_api_url str

The URL for the Management API associated with this API Management service.

name str

The name of the API Management Service. Changing this forces a new resource to be created.

notification_sender_email str

Email address from which the notification will be sent.

policy Dict[ServicePolicy]

A policy block as defined below.

portal_url str

The URL for the Publisher Portal associated with this API Management service.

private_ip_addresses List[str]
protocols Dict[ServiceProtocols]

A protocols block as defined below.

public_ip_addresses List[str]

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

publisher_email str

The email of publisher/company.

publisher_name str

The name of publisher/company.

resource_group_name str

The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.

scm_url str

The URL for the SCM (Source Code Management) Endpoint associated with this API Management service.

security Dict[ServiceSecurity]

A security block as defined below.

sign_in Dict[ServiceSignIn]

A sign_in block as defined below.

sign_up Dict[ServiceSignUp]

A sign_up block as defined below.

sku_name str

sku_name is a string consisting of two parts separated by an underscore(_). The fist part is the name, valid values include: Consumption, Developer, Basic, Standard and Premium. The second part is the capacity (e.g. the number of deployed units of the sku), which must be a positive integer (e.g. Developer_1).

tags Dict[str, str]

A mapping of tags assigned to the resource.

virtual_network_configuration Dict[ServiceVirtualNetworkConfiguration]

A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.

virtual_network_type str

The type of virtual network you want to use, valid values include: None, External, Internal.

Supporting Types

ServiceAdditionalLocation

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Location string

The name of the Azure Region in which the API Management Service should be expanded to.

GatewayRegionalUrl string

The URL of the Regional Gateway for the API Management Service in the specified region.

PublicIpAddresses List<string>

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

Location string

The name of the Azure Region in which the API Management Service should be expanded to.

GatewayRegionalUrl string

The URL of the Regional Gateway for the API Management Service in the specified region.

PublicIpAddresses []string

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

location string

The name of the Azure Region in which the API Management Service should be expanded to.

gatewayRegionalUrl string

The URL of the Regional Gateway for the API Management Service in the specified region.

publicIpAddresses string[]

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

location str

The name of the Azure Region in which the API Management Service should be expanded to.

gateway_regional_url str

The URL of the Regional Gateway for the API Management Service in the specified region.

public_ip_addresses List[str]

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

ServiceCertificate

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

CertificatePassword string

The password for the certificate.

EncodedCertificate string

The Base64 Encoded PFX Certificate.

StoreName string

The name of the Certificate Store where this certificate should be stored. Possible values are CertificateAuthority and Root.

CertificatePassword string

The password for the certificate.

EncodedCertificate string

The Base64 Encoded PFX Certificate.

StoreName string

The name of the Certificate Store where this certificate should be stored. Possible values are CertificateAuthority and Root.

certificatePassword string

The password for the certificate.

encodedCertificate string

The Base64 Encoded PFX Certificate.

storeName string

The name of the Certificate Store where this certificate should be stored. Possible values are CertificateAuthority and Root.

certificatePassword str

The password for the certificate.

encodedCertificate str

The Base64 Encoded PFX Certificate.

storeName str

The name of the Certificate Store where this certificate should be stored. Possible values are CertificateAuthority and Root.

ServiceHostnameConfiguration

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

DeveloperPortals List<ServiceHostnameConfigurationDeveloperPortalArgs>

One or more developer_portal blocks as documented below.

Managements List<ServiceHostnameConfigurationManagementArgs>

One or more management blocks as documented below.

Portals List<ServiceHostnameConfigurationPortalArgs>

One or more portal blocks as documented below.

Proxies List<ServiceHostnameConfigurationProxyArgs>

One or more proxy blocks as documented below.

Scms List<ServiceHostnameConfigurationScmArgs>

One or more scm blocks as documented below.

DeveloperPortals []ServiceHostnameConfigurationDeveloperPortal

One or more developer_portal blocks as documented below.

Managements []ServiceHostnameConfigurationManagement

One or more management blocks as documented below.

Portals []ServiceHostnameConfigurationPortal

One or more portal blocks as documented below.

Proxies []ServiceHostnameConfigurationProxy

One or more proxy blocks as documented below.

Scms []ServiceHostnameConfigurationScm

One or more scm blocks as documented below.

developerPortals ServiceHostnameConfigurationDeveloperPortal[]

One or more developer_portal blocks as documented below.

managements ServiceHostnameConfigurationManagement[]

One or more management blocks as documented below.

portals ServiceHostnameConfigurationPortal[]

One or more portal blocks as documented below.

proxies ServiceHostnameConfigurationProxy[]

One or more proxy blocks as documented below.

scms ServiceHostnameConfigurationScm[]

One or more scm blocks as documented below.

developerPortals List[ServiceHostnameConfigurationDeveloperPortal]

One or more developer_portal blocks as documented below.

managements List[ServiceHostnameConfigurationManagement]

One or more management blocks as documented below.

portals List[ServiceHostnameConfigurationPortal]

One or more portal blocks as documented below.

proxies List[ServiceHostnameConfigurationProxy]

One or more proxy blocks as documented below.

scms List[ServiceHostnameConfigurationScm]

One or more scm blocks as documented below.

ServiceHostnameConfigurationDeveloperPortal

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HostName string

The Hostname to use for the Management API.

Certificate string

One or more (up to 10) certificate blocks as defined below.

CertificatePassword string

The password for the certificate.

KeyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

NegotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

HostName string

The Hostname to use for the Management API.

Certificate string

One or more (up to 10) certificate blocks as defined below.

CertificatePassword string

The password for the certificate.

KeyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

NegotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

hostName string

The Hostname to use for the Management API.

certificate string

One or more (up to 10) certificate blocks as defined below.

certificatePassword string

The password for the certificate.

keyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

negotiateClientCertificate boolean

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

host_name str

The Hostname to use for the Management API.

certificate str

One or more (up to 10) certificate blocks as defined below.

certificatePassword str

The password for the certificate.

key_vault_id str

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

negotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

ServiceHostnameConfigurationManagement

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HostName string

The Hostname to use for the Management API.

Certificate string

The Base64 Encoded Certificate.

CertificatePassword string

The password associated with the certificate provided above.

KeyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

NegotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

HostName string

The Hostname to use for the Management API.

Certificate string

The Base64 Encoded Certificate.

CertificatePassword string

The password associated with the certificate provided above.

KeyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

NegotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

hostName string

The Hostname to use for the Management API.

certificate string

The Base64 Encoded Certificate.

certificatePassword string

The password associated with the certificate provided above.

keyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

negotiateClientCertificate boolean

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

host_name str

The Hostname to use for the Management API.

certificate str

The Base64 Encoded Certificate.

certificatePassword str

The password associated with the certificate provided above.

key_vault_id str

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

negotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

ServiceHostnameConfigurationPortal

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HostName string

The Hostname to use for the Management API.

Certificate string

One or more (up to 10) certificate blocks as defined below.

CertificatePassword string

The password for the certificate.

KeyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

NegotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

HostName string

The Hostname to use for the Management API.

Certificate string

One or more (up to 10) certificate blocks as defined below.

CertificatePassword string

The password for the certificate.

KeyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

NegotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

hostName string

The Hostname to use for the Management API.

certificate string

One or more (up to 10) certificate blocks as defined below.

certificatePassword string

The password for the certificate.

keyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

negotiateClientCertificate boolean

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

host_name str

The Hostname to use for the Management API.

certificate str

One or more (up to 10) certificate blocks as defined below.

certificatePassword str

The password for the certificate.

key_vault_id str

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

negotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

ServiceHostnameConfigurationProxy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HostName string

The Hostname to use for the Management API.

Certificate string

The Base64 Encoded Certificate.

CertificatePassword string

The password associated with the certificate provided above.

DefaultSslBinding bool

Is the certificate associated with this Hostname the Default SSL Certificate? This is used when an SNI header isn’t specified by a client. Defaults to false.

KeyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

NegotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

HostName string

The Hostname to use for the Management API.

Certificate string

The Base64 Encoded Certificate.

CertificatePassword string

The password associated with the certificate provided above.

DefaultSslBinding bool

Is the certificate associated with this Hostname the Default SSL Certificate? This is used when an SNI header isn’t specified by a client. Defaults to false.

KeyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

NegotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

hostName string

The Hostname to use for the Management API.

certificate string

The Base64 Encoded Certificate.

certificatePassword string

The password associated with the certificate provided above.

defaultSslBinding boolean

Is the certificate associated with this Hostname the Default SSL Certificate? This is used when an SNI header isn’t specified by a client. Defaults to false.

keyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

negotiateClientCertificate boolean

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

host_name str

The Hostname to use for the Management API.

certificate str

The Base64 Encoded Certificate.

certificatePassword str

The password associated with the certificate provided above.

defaultSslBinding bool

Is the certificate associated with this Hostname the Default SSL Certificate? This is used when an SNI header isn’t specified by a client. Defaults to false.

key_vault_id str

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

negotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

ServiceHostnameConfigurationScm

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HostName string

The Hostname to use for the Management API.

Certificate string

One or more (up to 10) certificate blocks as defined below.

CertificatePassword string

The password for the certificate.

KeyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

NegotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

HostName string

The Hostname to use for the Management API.

Certificate string

One or more (up to 10) certificate blocks as defined below.

CertificatePassword string

The password for the certificate.

KeyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

NegotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

hostName string

The Hostname to use for the Management API.

certificate string

One or more (up to 10) certificate blocks as defined below.

certificatePassword string

The password for the certificate.

keyVaultId string

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

negotiateClientCertificate boolean

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

host_name str

The Hostname to use for the Management API.

certificate str

One or more (up to 10) certificate blocks as defined below.

certificatePassword str

The password for the certificate.

key_vault_id str

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

negotiateClientCertificate bool

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

ServiceIdentity

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

IdentityIds List<string>

A list of IDs for User Assigned Managed Identity resources to be assigned.

PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The Tenant ID associated with this Managed Service Identity.

Type string

Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned (to enable both).

IdentityIds []string

A list of IDs for User Assigned Managed Identity resources to be assigned.

PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The Tenant ID associated with this Managed Service Identity.

Type string

Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned (to enable both).

identityIds string[]

A list of IDs for User Assigned Managed Identity resources to be assigned.

principalId string

The Principal ID associated with this Managed Service Identity.

tenantId string

The Tenant ID associated with this Managed Service Identity.

type string

Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned (to enable both).

identityIds List[str]

A list of IDs for User Assigned Managed Identity resources to be assigned.

principal_id str

The Principal ID associated with this Managed Service Identity.

tenant_id str

The Tenant ID associated with this Managed Service Identity.

type str

Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned (to enable both).

ServicePolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

XmlContent string

The XML Content for this Policy.

XmlLink string

A link to an API Management Policy XML Document, which must be publicly available.

XmlContent string

The XML Content for this Policy.

XmlLink string

A link to an API Management Policy XML Document, which must be publicly available.

xmlContent string

The XML Content for this Policy.

xmlLink string

A link to an API Management Policy XML Document, which must be publicly available.

xml_content str

The XML Content for this Policy.

xml_link str

A link to an API Management Policy XML Document, which must be publicly available.

ServiceProtocols

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

EnableHttp2 bool

Should HTTP/2 be supported by the API Management Service? Defaults to false.

EnableHttp2 bool

Should HTTP/2 be supported by the API Management Service? Defaults to false.

enableHttp2 boolean

Should HTTP/2 be supported by the API Management Service? Defaults to false.

enable_http2 bool

Should HTTP/2 be supported by the API Management Service? Defaults to false.

ServiceSecurity

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

EnableBackendSsl30 bool

Should SSL 3.0 be enabled on the backend of the gateway? Defaults to false.

EnableBackendTls10 bool

Should TLS 1.0 be enabled on the backend of the gateway? Defaults to false.

EnableBackendTls11 bool

Should TLS 1.1 be enabled on the backend of the gateway? Defaults to false.

EnableFrontendSsl30 bool

Should SSL 3.0 be enabled on the frontend of the gateway? Defaults to false.

EnableFrontendTls10 bool

Should TLS 1.0 be enabled on the frontend of the gateway? Defaults to false.

EnableFrontendTls11 bool

Should TLS 1.1 be enabled on the frontend of the gateway? Defaults to false.

EnableTripleDesCiphers bool

Should the TLS_RSA_WITH_3DES_EDE_CBC_SHA cipher be enabled for alL TLS versions (1.0, 1.1 and 1.2)? Defaults to false.

EnableBackendSsl30 bool

Should SSL 3.0 be enabled on the backend of the gateway? Defaults to false.

EnableBackendTls10 bool

Should TLS 1.0 be enabled on the backend of the gateway? Defaults to false.

EnableBackendTls11 bool

Should TLS 1.1 be enabled on the backend of the gateway? Defaults to false.

EnableFrontendSsl30 bool

Should SSL 3.0 be enabled on the frontend of the gateway? Defaults to false.

EnableFrontendTls10 bool

Should TLS 1.0 be enabled on the frontend of the gateway? Defaults to false.

EnableFrontendTls11 bool

Should TLS 1.1 be enabled on the frontend of the gateway? Defaults to false.

EnableTripleDesCiphers bool

Should the TLS_RSA_WITH_3DES_EDE_CBC_SHA cipher be enabled for alL TLS versions (1.0, 1.1 and 1.2)? Defaults to false.

enableBackendSsl30 boolean

Should SSL 3.0 be enabled on the backend of the gateway? Defaults to false.

enableBackendTls10 boolean

Should TLS 1.0 be enabled on the backend of the gateway? Defaults to false.

enableBackendTls11 boolean

Should TLS 1.1 be enabled on the backend of the gateway? Defaults to false.

enableFrontendSsl30 boolean

Should SSL 3.0 be enabled on the frontend of the gateway? Defaults to false.

enableFrontendTls10 boolean

Should TLS 1.0 be enabled on the frontend of the gateway? Defaults to false.

enableFrontendTls11 boolean

Should TLS 1.1 be enabled on the frontend of the gateway? Defaults to false.

enableTripleDesCiphers boolean

Should the TLS_RSA_WITH_3DES_EDE_CBC_SHA cipher be enabled for alL TLS versions (1.0, 1.1 and 1.2)? Defaults to false.

enableBackendSsl30 bool

Should SSL 3.0 be enabled on the backend of the gateway? Defaults to false.

enableBackendTls10 bool

Should TLS 1.0 be enabled on the backend of the gateway? Defaults to false.

enableBackendTls11 bool

Should TLS 1.1 be enabled on the backend of the gateway? Defaults to false.

enableFrontendSsl30 bool

Should SSL 3.0 be enabled on the frontend of the gateway? Defaults to false.

enableFrontendTls10 bool

Should TLS 1.0 be enabled on the frontend of the gateway? Defaults to false.

enableFrontendTls11 bool

Should TLS 1.1 be enabled on the frontend of the gateway? Defaults to false.

enableTripleDesCiphers bool

Should the TLS_RSA_WITH_3DES_EDE_CBC_SHA cipher be enabled for alL TLS versions (1.0, 1.1 and 1.2)? Defaults to false.

ServiceSignIn

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Enabled bool

Should anonymous users be redirected to the sign in page?

Enabled bool

Should anonymous users be redirected to the sign in page?

enabled boolean

Should anonymous users be redirected to the sign in page?

enabled bool

Should anonymous users be redirected to the sign in page?

ServiceSignUp

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Enabled bool

Can users sign up on the development portal?

TermsOfService ServiceSignUpTermsOfServiceArgs

A terms_of_service block as defined below.

Enabled bool

Can users sign up on the development portal?

TermsOfService ServiceSignUpTermsOfService

A terms_of_service block as defined below.

enabled boolean

Can users sign up on the development portal?

termsOfService ServiceSignUpTermsOfService

A terms_of_service block as defined below.

enabled bool

Can users sign up on the development portal?

termsOfService Dict[ServiceSignUpTermsOfService]

A terms_of_service block as defined below.

ServiceSignUpTermsOfService

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ConsentRequired bool

Should the user be asked for consent during sign up?

Enabled bool

Should Terms of Service be displayed during sign up?.

Text string

The Terms of Service which users are required to agree to in order to sign up.

ConsentRequired bool

Should the user be asked for consent during sign up?

Enabled bool

Should Terms of Service be displayed during sign up?.

Text string

The Terms of Service which users are required to agree to in order to sign up.

consentRequired boolean

Should the user be asked for consent during sign up?

enabled boolean

Should Terms of Service be displayed during sign up?.

text string

The Terms of Service which users are required to agree to in order to sign up.

consentRequired bool

Should the user be asked for consent during sign up?

enabled bool

Should Terms of Service be displayed during sign up?.

text str

The Terms of Service which users are required to agree to in order to sign up.

ServiceVirtualNetworkConfiguration

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

SubnetId string

The id of the subnet that will be used for the API Management.

SubnetId string

The id of the subnet that will be used for the API Management.

subnetId string

The id of the subnet that will be used for the API Management.

subnet_id str

The id of the subnet that will be used for the API Management.

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.