Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. Service

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.Service

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleService = new azure.apimanagement.Service("example", {
    name: "example-apim",
    location: example.location,
    resourceGroupName: example.name,
    publisherName: "My Company",
    publisherEmail: "company@exmaple.com",
    skuName: "Developer_1",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_service = azure.apimanagement.Service("example",
    name="example-apim",
    location=example.location,
    resource_group_name=example.name,
    publisher_name="My Company",
    publisher_email="company@exmaple.com",
    sku_name="Developer_1")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
			Name:              pulumi.String("example-apim"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			PublisherName:     pulumi.String("My Company"),
			PublisherEmail:    pulumi.String("company@exmaple.com"),
			SkuName:           pulumi.String("Developer_1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleService = new Azure.ApiManagement.Service("example", new()
    {
        Name = "example-apim",
        Location = example.Location,
        ResourceGroupName = example.Name,
        PublisherName = "My Company",
        PublisherEmail = "company@exmaple.com",
        SkuName = "Developer_1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("example-apim")
            .location(example.location())
            .resourceGroupName(example.name())
            .publisherName("My Company")
            .publisherEmail("company@exmaple.com")
            .skuName("Developer_1")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleService:
    type: azure:apimanagement:Service
    name: example
    properties:
      name: example-apim
      location: ${example.location}
      resourceGroupName: ${example.name}
      publisherName: My Company
      publisherEmail: company@exmaple.com
      skuName: Developer_1
Copy

Create Service Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
@overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            publisher_email: Optional[str] = None,
            sku_name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            publisher_name: Optional[str] = None,
            public_ip_address_id: Optional[str] = None,
            delegation: Optional[ServiceDelegationArgs] = None,
            identity: Optional[ServiceIdentityArgs] = None,
            location: Optional[str] = None,
            min_api_version: Optional[str] = None,
            name: Optional[str] = None,
            notification_sender_email: Optional[str] = None,
            protocols: Optional[ServiceProtocolsArgs] = None,
            additional_locations: Optional[Sequence[ServiceAdditionalLocationArgs]] = None,
            public_network_access_enabled: Optional[bool] = None,
            gateway_disabled: Optional[bool] = None,
            hostname_configuration: Optional[ServiceHostnameConfigurationArgs] = None,
            client_certificate_enabled: Optional[bool] = None,
            security: Optional[ServiceSecurityArgs] = None,
            sign_in: Optional[ServiceSignInArgs] = None,
            sign_up: Optional[ServiceSignUpArgs] = None,
            certificates: Optional[Sequence[ServiceCertificateArgs]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tenant_access: Optional[ServiceTenantAccessArgs] = None,
            virtual_network_configuration: Optional[ServiceVirtualNetworkConfigurationArgs] = None,
            virtual_network_type: Optional[str] = None,
            zones: Optional[Sequence[str]] = None)
func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

type: azure:apimanagement:Service
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var serviceResource = new Azure.ApiManagement.Service("serviceResource", new()
{
    PublisherEmail = "string",
    SkuName = "string",
    ResourceGroupName = "string",
    PublisherName = "string",
    PublicIpAddressId = "string",
    Delegation = new Azure.ApiManagement.Inputs.ServiceDelegationArgs
    {
        SubscriptionsEnabled = false,
        Url = "string",
        UserRegistrationEnabled = false,
        ValidationKey = "string",
    },
    Identity = new Azure.ApiManagement.Inputs.ServiceIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    Location = "string",
    MinApiVersion = "string",
    Name = "string",
    NotificationSenderEmail = "string",
    Protocols = new Azure.ApiManagement.Inputs.ServiceProtocolsArgs
    {
        EnableHttp2 = false,
    },
    AdditionalLocations = new[]
    {
        new Azure.ApiManagement.Inputs.ServiceAdditionalLocationArgs
        {
            Location = "string",
            Capacity = 0,
            GatewayDisabled = false,
            GatewayRegionalUrl = "string",
            PrivateIpAddresses = new[]
            {
                "string",
            },
            PublicIpAddressId = "string",
            PublicIpAddresses = new[]
            {
                "string",
            },
            VirtualNetworkConfiguration = new Azure.ApiManagement.Inputs.ServiceAdditionalLocationVirtualNetworkConfigurationArgs
            {
                SubnetId = "string",
            },
            Zones = new[]
            {
                "string",
            },
        },
    },
    PublicNetworkAccessEnabled = false,
    GatewayDisabled = false,
    HostnameConfiguration = new Azure.ApiManagement.Inputs.ServiceHostnameConfigurationArgs
    {
        DeveloperPortals = new[]
        {
            new Azure.ApiManagement.Inputs.ServiceHostnameConfigurationDeveloperPortalArgs
            {
                HostName = "string",
                Certificate = "string",
                CertificatePassword = "string",
                CertificateSource = "string",
                CertificateStatus = "string",
                Expiry = "string",
                KeyVaultId = "string",
                NegotiateClientCertificate = false,
                SslKeyvaultIdentityClientId = "string",
                Subject = "string",
                Thumbprint = "string",
            },
        },
        Managements = new[]
        {
            new Azure.ApiManagement.Inputs.ServiceHostnameConfigurationManagementArgs
            {
                HostName = "string",
                Certificate = "string",
                CertificatePassword = "string",
                CertificateSource = "string",
                CertificateStatus = "string",
                Expiry = "string",
                KeyVaultId = "string",
                NegotiateClientCertificate = false,
                SslKeyvaultIdentityClientId = "string",
                Subject = "string",
                Thumbprint = "string",
            },
        },
        Portals = new[]
        {
            new Azure.ApiManagement.Inputs.ServiceHostnameConfigurationPortalArgs
            {
                HostName = "string",
                Certificate = "string",
                CertificatePassword = "string",
                CertificateSource = "string",
                CertificateStatus = "string",
                Expiry = "string",
                KeyVaultId = "string",
                NegotiateClientCertificate = false,
                SslKeyvaultIdentityClientId = "string",
                Subject = "string",
                Thumbprint = "string",
            },
        },
        Proxies = new[]
        {
            new Azure.ApiManagement.Inputs.ServiceHostnameConfigurationProxyArgs
            {
                HostName = "string",
                Certificate = "string",
                CertificatePassword = "string",
                CertificateSource = "string",
                CertificateStatus = "string",
                DefaultSslBinding = false,
                Expiry = "string",
                KeyVaultId = "string",
                NegotiateClientCertificate = false,
                SslKeyvaultIdentityClientId = "string",
                Subject = "string",
                Thumbprint = "string",
            },
        },
        Scms = new[]
        {
            new Azure.ApiManagement.Inputs.ServiceHostnameConfigurationScmArgs
            {
                HostName = "string",
                Certificate = "string",
                CertificatePassword = "string",
                CertificateSource = "string",
                CertificateStatus = "string",
                Expiry = "string",
                KeyVaultId = "string",
                NegotiateClientCertificate = false,
                SslKeyvaultIdentityClientId = "string",
                Subject = "string",
                Thumbprint = "string",
            },
        },
    },
    ClientCertificateEnabled = false,
    Security = new Azure.ApiManagement.Inputs.ServiceSecurityArgs
    {
        EnableBackendSsl30 = false,
        EnableBackendTls10 = false,
        EnableBackendTls11 = false,
        EnableFrontendSsl30 = false,
        EnableFrontendTls10 = false,
        EnableFrontendTls11 = false,
        TlsEcdheEcdsaWithAes128CbcShaCiphersEnabled = false,
        TlsEcdheEcdsaWithAes256CbcShaCiphersEnabled = false,
        TlsEcdheRsaWithAes128CbcShaCiphersEnabled = false,
        TlsEcdheRsaWithAes256CbcShaCiphersEnabled = false,
        TlsRsaWithAes128CbcSha256CiphersEnabled = false,
        TlsRsaWithAes128CbcShaCiphersEnabled = false,
        TlsRsaWithAes128GcmSha256CiphersEnabled = false,
        TlsRsaWithAes256CbcSha256CiphersEnabled = false,
        TlsRsaWithAes256CbcShaCiphersEnabled = false,
        TlsRsaWithAes256GcmSha384CiphersEnabled = false,
        TripleDesCiphersEnabled = false,
    },
    SignIn = new Azure.ApiManagement.Inputs.ServiceSignInArgs
    {
        Enabled = false,
    },
    SignUp = new Azure.ApiManagement.Inputs.ServiceSignUpArgs
    {
        Enabled = false,
        TermsOfService = new Azure.ApiManagement.Inputs.ServiceSignUpTermsOfServiceArgs
        {
            ConsentRequired = false,
            Enabled = false,
            Text = "string",
        },
    },
    Certificates = new[]
    {
        new Azure.ApiManagement.Inputs.ServiceCertificateArgs
        {
            EncodedCertificate = "string",
            StoreName = "string",
            CertificatePassword = "string",
            Expiry = "string",
            Subject = "string",
            Thumbprint = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    TenantAccess = new Azure.ApiManagement.Inputs.ServiceTenantAccessArgs
    {
        Enabled = false,
        PrimaryKey = "string",
        SecondaryKey = "string",
        TenantId = "string",
    },
    VirtualNetworkConfiguration = new Azure.ApiManagement.Inputs.ServiceVirtualNetworkConfigurationArgs
    {
        SubnetId = "string",
    },
    VirtualNetworkType = "string",
    Zones = new[]
    {
        "string",
    },
});
Copy
example, err := apimanagement.NewService(ctx, "serviceResource", &apimanagement.ServiceArgs{
	PublisherEmail:    pulumi.String("string"),
	SkuName:           pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	PublisherName:     pulumi.String("string"),
	PublicIpAddressId: pulumi.String("string"),
	Delegation: &apimanagement.ServiceDelegationArgs{
		SubscriptionsEnabled:    pulumi.Bool(false),
		Url:                     pulumi.String("string"),
		UserRegistrationEnabled: pulumi.Bool(false),
		ValidationKey:           pulumi.String("string"),
	},
	Identity: &apimanagement.ServiceIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	Location:                pulumi.String("string"),
	MinApiVersion:           pulumi.String("string"),
	Name:                    pulumi.String("string"),
	NotificationSenderEmail: pulumi.String("string"),
	Protocols: &apimanagement.ServiceProtocolsArgs{
		EnableHttp2: pulumi.Bool(false),
	},
	AdditionalLocations: apimanagement.ServiceAdditionalLocationArray{
		&apimanagement.ServiceAdditionalLocationArgs{
			Location:           pulumi.String("string"),
			Capacity:           pulumi.Int(0),
			GatewayDisabled:    pulumi.Bool(false),
			GatewayRegionalUrl: pulumi.String("string"),
			PrivateIpAddresses: pulumi.StringArray{
				pulumi.String("string"),
			},
			PublicIpAddressId: pulumi.String("string"),
			PublicIpAddresses: pulumi.StringArray{
				pulumi.String("string"),
			},
			VirtualNetworkConfiguration: &apimanagement.ServiceAdditionalLocationVirtualNetworkConfigurationArgs{
				SubnetId: pulumi.String("string"),
			},
			Zones: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	GatewayDisabled:            pulumi.Bool(false),
	HostnameConfiguration: &apimanagement.ServiceHostnameConfigurationArgs{
		DeveloperPortals: apimanagement.ServiceHostnameConfigurationDeveloperPortalArray{
			&apimanagement.ServiceHostnameConfigurationDeveloperPortalArgs{
				HostName:                    pulumi.String("string"),
				Certificate:                 pulumi.String("string"),
				CertificatePassword:         pulumi.String("string"),
				CertificateSource:           pulumi.String("string"),
				CertificateStatus:           pulumi.String("string"),
				Expiry:                      pulumi.String("string"),
				KeyVaultId:                  pulumi.String("string"),
				NegotiateClientCertificate:  pulumi.Bool(false),
				SslKeyvaultIdentityClientId: pulumi.String("string"),
				Subject:                     pulumi.String("string"),
				Thumbprint:                  pulumi.String("string"),
			},
		},
		Managements: apimanagement.ServiceHostnameConfigurationManagementArray{
			&apimanagement.ServiceHostnameConfigurationManagementArgs{
				HostName:                    pulumi.String("string"),
				Certificate:                 pulumi.String("string"),
				CertificatePassword:         pulumi.String("string"),
				CertificateSource:           pulumi.String("string"),
				CertificateStatus:           pulumi.String("string"),
				Expiry:                      pulumi.String("string"),
				KeyVaultId:                  pulumi.String("string"),
				NegotiateClientCertificate:  pulumi.Bool(false),
				SslKeyvaultIdentityClientId: pulumi.String("string"),
				Subject:                     pulumi.String("string"),
				Thumbprint:                  pulumi.String("string"),
			},
		},
		Portals: apimanagement.ServiceHostnameConfigurationPortalArray{
			&apimanagement.ServiceHostnameConfigurationPortalArgs{
				HostName:                    pulumi.String("string"),
				Certificate:                 pulumi.String("string"),
				CertificatePassword:         pulumi.String("string"),
				CertificateSource:           pulumi.String("string"),
				CertificateStatus:           pulumi.String("string"),
				Expiry:                      pulumi.String("string"),
				KeyVaultId:                  pulumi.String("string"),
				NegotiateClientCertificate:  pulumi.Bool(false),
				SslKeyvaultIdentityClientId: pulumi.String("string"),
				Subject:                     pulumi.String("string"),
				Thumbprint:                  pulumi.String("string"),
			},
		},
		Proxies: apimanagement.ServiceHostnameConfigurationProxyArray{
			&apimanagement.ServiceHostnameConfigurationProxyArgs{
				HostName:                    pulumi.String("string"),
				Certificate:                 pulumi.String("string"),
				CertificatePassword:         pulumi.String("string"),
				CertificateSource:           pulumi.String("string"),
				CertificateStatus:           pulumi.String("string"),
				DefaultSslBinding:           pulumi.Bool(false),
				Expiry:                      pulumi.String("string"),
				KeyVaultId:                  pulumi.String("string"),
				NegotiateClientCertificate:  pulumi.Bool(false),
				SslKeyvaultIdentityClientId: pulumi.String("string"),
				Subject:                     pulumi.String("string"),
				Thumbprint:                  pulumi.String("string"),
			},
		},
		Scms: apimanagement.ServiceHostnameConfigurationScmArray{
			&apimanagement.ServiceHostnameConfigurationScmArgs{
				HostName:                    pulumi.String("string"),
				Certificate:                 pulumi.String("string"),
				CertificatePassword:         pulumi.String("string"),
				CertificateSource:           pulumi.String("string"),
				CertificateStatus:           pulumi.String("string"),
				Expiry:                      pulumi.String("string"),
				KeyVaultId:                  pulumi.String("string"),
				NegotiateClientCertificate:  pulumi.Bool(false),
				SslKeyvaultIdentityClientId: pulumi.String("string"),
				Subject:                     pulumi.String("string"),
				Thumbprint:                  pulumi.String("string"),
			},
		},
	},
	ClientCertificateEnabled: pulumi.Bool(false),
	Security: &apimanagement.ServiceSecurityArgs{
		EnableBackendSsl30:                          pulumi.Bool(false),
		EnableBackendTls10:                          pulumi.Bool(false),
		EnableBackendTls11:                          pulumi.Bool(false),
		EnableFrontendSsl30:                         pulumi.Bool(false),
		EnableFrontendTls10:                         pulumi.Bool(false),
		EnableFrontendTls11:                         pulumi.Bool(false),
		TlsEcdheEcdsaWithAes128CbcShaCiphersEnabled: pulumi.Bool(false),
		TlsEcdheEcdsaWithAes256CbcShaCiphersEnabled: pulumi.Bool(false),
		TlsEcdheRsaWithAes128CbcShaCiphersEnabled:   pulumi.Bool(false),
		TlsEcdheRsaWithAes256CbcShaCiphersEnabled:   pulumi.Bool(false),
		TlsRsaWithAes128CbcSha256CiphersEnabled:     pulumi.Bool(false),
		TlsRsaWithAes128CbcShaCiphersEnabled:        pulumi.Bool(false),
		TlsRsaWithAes128GcmSha256CiphersEnabled:     pulumi.Bool(false),
		TlsRsaWithAes256CbcSha256CiphersEnabled:     pulumi.Bool(false),
		TlsRsaWithAes256CbcShaCiphersEnabled:        pulumi.Bool(false),
		TlsRsaWithAes256GcmSha384CiphersEnabled:     pulumi.Bool(false),
		TripleDesCiphersEnabled:                     pulumi.Bool(false),
	},
	SignIn: &apimanagement.ServiceSignInArgs{
		Enabled: pulumi.Bool(false),
	},
	SignUp: &apimanagement.ServiceSignUpArgs{
		Enabled: pulumi.Bool(false),
		TermsOfService: &apimanagement.ServiceSignUpTermsOfServiceArgs{
			ConsentRequired: pulumi.Bool(false),
			Enabled:         pulumi.Bool(false),
			Text:            pulumi.String("string"),
		},
	},
	Certificates: apimanagement.ServiceCertificateArray{
		&apimanagement.ServiceCertificateArgs{
			EncodedCertificate:  pulumi.String("string"),
			StoreName:           pulumi.String("string"),
			CertificatePassword: pulumi.String("string"),
			Expiry:              pulumi.String("string"),
			Subject:             pulumi.String("string"),
			Thumbprint:          pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TenantAccess: &apimanagement.ServiceTenantAccessArgs{
		Enabled:      pulumi.Bool(false),
		PrimaryKey:   pulumi.String("string"),
		SecondaryKey: pulumi.String("string"),
		TenantId:     pulumi.String("string"),
	},
	VirtualNetworkConfiguration: &apimanagement.ServiceVirtualNetworkConfigurationArgs{
		SubnetId: pulumi.String("string"),
	},
	VirtualNetworkType: pulumi.String("string"),
	Zones: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var serviceResource = new Service("serviceResource", ServiceArgs.builder()
    .publisherEmail("string")
    .skuName("string")
    .resourceGroupName("string")
    .publisherName("string")
    .publicIpAddressId("string")
    .delegation(ServiceDelegationArgs.builder()
        .subscriptionsEnabled(false)
        .url("string")
        .userRegistrationEnabled(false)
        .validationKey("string")
        .build())
    .identity(ServiceIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .location("string")
    .minApiVersion("string")
    .name("string")
    .notificationSenderEmail("string")
    .protocols(ServiceProtocolsArgs.builder()
        .enableHttp2(false)
        .build())
    .additionalLocations(ServiceAdditionalLocationArgs.builder()
        .location("string")
        .capacity(0)
        .gatewayDisabled(false)
        .gatewayRegionalUrl("string")
        .privateIpAddresses("string")
        .publicIpAddressId("string")
        .publicIpAddresses("string")
        .virtualNetworkConfiguration(ServiceAdditionalLocationVirtualNetworkConfigurationArgs.builder()
            .subnetId("string")
            .build())
        .zones("string")
        .build())
    .publicNetworkAccessEnabled(false)
    .gatewayDisabled(false)
    .hostnameConfiguration(ServiceHostnameConfigurationArgs.builder()
        .developerPortals(ServiceHostnameConfigurationDeveloperPortalArgs.builder()
            .hostName("string")
            .certificate("string")
            .certificatePassword("string")
            .certificateSource("string")
            .certificateStatus("string")
            .expiry("string")
            .keyVaultId("string")
            .negotiateClientCertificate(false)
            .sslKeyvaultIdentityClientId("string")
            .subject("string")
            .thumbprint("string")
            .build())
        .managements(ServiceHostnameConfigurationManagementArgs.builder()
            .hostName("string")
            .certificate("string")
            .certificatePassword("string")
            .certificateSource("string")
            .certificateStatus("string")
            .expiry("string")
            .keyVaultId("string")
            .negotiateClientCertificate(false)
            .sslKeyvaultIdentityClientId("string")
            .subject("string")
            .thumbprint("string")
            .build())
        .portals(ServiceHostnameConfigurationPortalArgs.builder()
            .hostName("string")
            .certificate("string")
            .certificatePassword("string")
            .certificateSource("string")
            .certificateStatus("string")
            .expiry("string")
            .keyVaultId("string")
            .negotiateClientCertificate(false)
            .sslKeyvaultIdentityClientId("string")
            .subject("string")
            .thumbprint("string")
            .build())
        .proxies(ServiceHostnameConfigurationProxyArgs.builder()
            .hostName("string")
            .certificate("string")
            .certificatePassword("string")
            .certificateSource("string")
            .certificateStatus("string")
            .defaultSslBinding(false)
            .expiry("string")
            .keyVaultId("string")
            .negotiateClientCertificate(false)
            .sslKeyvaultIdentityClientId("string")
            .subject("string")
            .thumbprint("string")
            .build())
        .scms(ServiceHostnameConfigurationScmArgs.builder()
            .hostName("string")
            .certificate("string")
            .certificatePassword("string")
            .certificateSource("string")
            .certificateStatus("string")
            .expiry("string")
            .keyVaultId("string")
            .negotiateClientCertificate(false)
            .sslKeyvaultIdentityClientId("string")
            .subject("string")
            .thumbprint("string")
            .build())
        .build())
    .clientCertificateEnabled(false)
    .security(ServiceSecurityArgs.builder()
        .enableBackendSsl30(false)
        .enableBackendTls10(false)
        .enableBackendTls11(false)
        .enableFrontendSsl30(false)
        .enableFrontendTls10(false)
        .enableFrontendTls11(false)
        .tlsEcdheEcdsaWithAes128CbcShaCiphersEnabled(false)
        .tlsEcdheEcdsaWithAes256CbcShaCiphersEnabled(false)
        .tlsEcdheRsaWithAes128CbcShaCiphersEnabled(false)
        .tlsEcdheRsaWithAes256CbcShaCiphersEnabled(false)
        .tlsRsaWithAes128CbcSha256CiphersEnabled(false)
        .tlsRsaWithAes128CbcShaCiphersEnabled(false)
        .tlsRsaWithAes128GcmSha256CiphersEnabled(false)
        .tlsRsaWithAes256CbcSha256CiphersEnabled(false)
        .tlsRsaWithAes256CbcShaCiphersEnabled(false)
        .tlsRsaWithAes256GcmSha384CiphersEnabled(false)
        .tripleDesCiphersEnabled(false)
        .build())
    .signIn(ServiceSignInArgs.builder()
        .enabled(false)
        .build())
    .signUp(ServiceSignUpArgs.builder()
        .enabled(false)
        .termsOfService(ServiceSignUpTermsOfServiceArgs.builder()
            .consentRequired(false)
            .enabled(false)
            .text("string")
            .build())
        .build())
    .certificates(ServiceCertificateArgs.builder()
        .encodedCertificate("string")
        .storeName("string")
        .certificatePassword("string")
        .expiry("string")
        .subject("string")
        .thumbprint("string")
        .build())
    .tags(Map.of("string", "string"))
    .tenantAccess(ServiceTenantAccessArgs.builder()
        .enabled(false)
        .primaryKey("string")
        .secondaryKey("string")
        .tenantId("string")
        .build())
    .virtualNetworkConfiguration(ServiceVirtualNetworkConfigurationArgs.builder()
        .subnetId("string")
        .build())
    .virtualNetworkType("string")
    .zones("string")
    .build());
Copy
service_resource = azure.apimanagement.Service("serviceResource",
    publisher_email="string",
    sku_name="string",
    resource_group_name="string",
    publisher_name="string",
    public_ip_address_id="string",
    delegation={
        "subscriptions_enabled": False,
        "url": "string",
        "user_registration_enabled": False,
        "validation_key": "string",
    },
    identity={
        "type": "string",
        "identity_ids": ["string"],
        "principal_id": "string",
        "tenant_id": "string",
    },
    location="string",
    min_api_version="string",
    name="string",
    notification_sender_email="string",
    protocols={
        "enable_http2": False,
    },
    additional_locations=[{
        "location": "string",
        "capacity": 0,
        "gateway_disabled": False,
        "gateway_regional_url": "string",
        "private_ip_addresses": ["string"],
        "public_ip_address_id": "string",
        "public_ip_addresses": ["string"],
        "virtual_network_configuration": {
            "subnet_id": "string",
        },
        "zones": ["string"],
    }],
    public_network_access_enabled=False,
    gateway_disabled=False,
    hostname_configuration={
        "developer_portals": [{
            "host_name": "string",
            "certificate": "string",
            "certificate_password": "string",
            "certificate_source": "string",
            "certificate_status": "string",
            "expiry": "string",
            "key_vault_id": "string",
            "negotiate_client_certificate": False,
            "ssl_keyvault_identity_client_id": "string",
            "subject": "string",
            "thumbprint": "string",
        }],
        "managements": [{
            "host_name": "string",
            "certificate": "string",
            "certificate_password": "string",
            "certificate_source": "string",
            "certificate_status": "string",
            "expiry": "string",
            "key_vault_id": "string",
            "negotiate_client_certificate": False,
            "ssl_keyvault_identity_client_id": "string",
            "subject": "string",
            "thumbprint": "string",
        }],
        "portals": [{
            "host_name": "string",
            "certificate": "string",
            "certificate_password": "string",
            "certificate_source": "string",
            "certificate_status": "string",
            "expiry": "string",
            "key_vault_id": "string",
            "negotiate_client_certificate": False,
            "ssl_keyvault_identity_client_id": "string",
            "subject": "string",
            "thumbprint": "string",
        }],
        "proxies": [{
            "host_name": "string",
            "certificate": "string",
            "certificate_password": "string",
            "certificate_source": "string",
            "certificate_status": "string",
            "default_ssl_binding": False,
            "expiry": "string",
            "key_vault_id": "string",
            "negotiate_client_certificate": False,
            "ssl_keyvault_identity_client_id": "string",
            "subject": "string",
            "thumbprint": "string",
        }],
        "scms": [{
            "host_name": "string",
            "certificate": "string",
            "certificate_password": "string",
            "certificate_source": "string",
            "certificate_status": "string",
            "expiry": "string",
            "key_vault_id": "string",
            "negotiate_client_certificate": False,
            "ssl_keyvault_identity_client_id": "string",
            "subject": "string",
            "thumbprint": "string",
        }],
    },
    client_certificate_enabled=False,
    security={
        "enable_backend_ssl30": False,
        "enable_backend_tls10": False,
        "enable_backend_tls11": False,
        "enable_frontend_ssl30": False,
        "enable_frontend_tls10": False,
        "enable_frontend_tls11": False,
        "tls_ecdhe_ecdsa_with_aes128_cbc_sha_ciphers_enabled": False,
        "tls_ecdhe_ecdsa_with_aes256_cbc_sha_ciphers_enabled": False,
        "tls_ecdhe_rsa_with_aes128_cbc_sha_ciphers_enabled": False,
        "tls_ecdhe_rsa_with_aes256_cbc_sha_ciphers_enabled": False,
        "tls_rsa_with_aes128_cbc_sha256_ciphers_enabled": False,
        "tls_rsa_with_aes128_cbc_sha_ciphers_enabled": False,
        "tls_rsa_with_aes128_gcm_sha256_ciphers_enabled": False,
        "tls_rsa_with_aes256_cbc_sha256_ciphers_enabled": False,
        "tls_rsa_with_aes256_cbc_sha_ciphers_enabled": False,
        "tls_rsa_with_aes256_gcm_sha384_ciphers_enabled": False,
        "triple_des_ciphers_enabled": False,
    },
    sign_in={
        "enabled": False,
    },
    sign_up={
        "enabled": False,
        "terms_of_service": {
            "consent_required": False,
            "enabled": False,
            "text": "string",
        },
    },
    certificates=[{
        "encoded_certificate": "string",
        "store_name": "string",
        "certificate_password": "string",
        "expiry": "string",
        "subject": "string",
        "thumbprint": "string",
    }],
    tags={
        "string": "string",
    },
    tenant_access={
        "enabled": False,
        "primary_key": "string",
        "secondary_key": "string",
        "tenant_id": "string",
    },
    virtual_network_configuration={
        "subnet_id": "string",
    },
    virtual_network_type="string",
    zones=["string"])
Copy
const serviceResource = new azure.apimanagement.Service("serviceResource", {
    publisherEmail: "string",
    skuName: "string",
    resourceGroupName: "string",
    publisherName: "string",
    publicIpAddressId: "string",
    delegation: {
        subscriptionsEnabled: false,
        url: "string",
        userRegistrationEnabled: false,
        validationKey: "string",
    },
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    location: "string",
    minApiVersion: "string",
    name: "string",
    notificationSenderEmail: "string",
    protocols: {
        enableHttp2: false,
    },
    additionalLocations: [{
        location: "string",
        capacity: 0,
        gatewayDisabled: false,
        gatewayRegionalUrl: "string",
        privateIpAddresses: ["string"],
        publicIpAddressId: "string",
        publicIpAddresses: ["string"],
        virtualNetworkConfiguration: {
            subnetId: "string",
        },
        zones: ["string"],
    }],
    publicNetworkAccessEnabled: false,
    gatewayDisabled: false,
    hostnameConfiguration: {
        developerPortals: [{
            hostName: "string",
            certificate: "string",
            certificatePassword: "string",
            certificateSource: "string",
            certificateStatus: "string",
            expiry: "string",
            keyVaultId: "string",
            negotiateClientCertificate: false,
            sslKeyvaultIdentityClientId: "string",
            subject: "string",
            thumbprint: "string",
        }],
        managements: [{
            hostName: "string",
            certificate: "string",
            certificatePassword: "string",
            certificateSource: "string",
            certificateStatus: "string",
            expiry: "string",
            keyVaultId: "string",
            negotiateClientCertificate: false,
            sslKeyvaultIdentityClientId: "string",
            subject: "string",
            thumbprint: "string",
        }],
        portals: [{
            hostName: "string",
            certificate: "string",
            certificatePassword: "string",
            certificateSource: "string",
            certificateStatus: "string",
            expiry: "string",
            keyVaultId: "string",
            negotiateClientCertificate: false,
            sslKeyvaultIdentityClientId: "string",
            subject: "string",
            thumbprint: "string",
        }],
        proxies: [{
            hostName: "string",
            certificate: "string",
            certificatePassword: "string",
            certificateSource: "string",
            certificateStatus: "string",
            defaultSslBinding: false,
            expiry: "string",
            keyVaultId: "string",
            negotiateClientCertificate: false,
            sslKeyvaultIdentityClientId: "string",
            subject: "string",
            thumbprint: "string",
        }],
        scms: [{
            hostName: "string",
            certificate: "string",
            certificatePassword: "string",
            certificateSource: "string",
            certificateStatus: "string",
            expiry: "string",
            keyVaultId: "string",
            negotiateClientCertificate: false,
            sslKeyvaultIdentityClientId: "string",
            subject: "string",
            thumbprint: "string",
        }],
    },
    clientCertificateEnabled: false,
    security: {
        enableBackendSsl30: false,
        enableBackendTls10: false,
        enableBackendTls11: false,
        enableFrontendSsl30: false,
        enableFrontendTls10: false,
        enableFrontendTls11: false,
        tlsEcdheEcdsaWithAes128CbcShaCiphersEnabled: false,
        tlsEcdheEcdsaWithAes256CbcShaCiphersEnabled: false,
        tlsEcdheRsaWithAes128CbcShaCiphersEnabled: false,
        tlsEcdheRsaWithAes256CbcShaCiphersEnabled: false,
        tlsRsaWithAes128CbcSha256CiphersEnabled: false,
        tlsRsaWithAes128CbcShaCiphersEnabled: false,
        tlsRsaWithAes128GcmSha256CiphersEnabled: false,
        tlsRsaWithAes256CbcSha256CiphersEnabled: false,
        tlsRsaWithAes256CbcShaCiphersEnabled: false,
        tlsRsaWithAes256GcmSha384CiphersEnabled: false,
        tripleDesCiphersEnabled: false,
    },
    signIn: {
        enabled: false,
    },
    signUp: {
        enabled: false,
        termsOfService: {
            consentRequired: false,
            enabled: false,
            text: "string",
        },
    },
    certificates: [{
        encodedCertificate: "string",
        storeName: "string",
        certificatePassword: "string",
        expiry: "string",
        subject: "string",
        thumbprint: "string",
    }],
    tags: {
        string: "string",
    },
    tenantAccess: {
        enabled: false,
        primaryKey: "string",
        secondaryKey: "string",
        tenantId: "string",
    },
    virtualNetworkConfiguration: {
        subnetId: "string",
    },
    virtualNetworkType: "string",
    zones: ["string"],
});
Copy
type: azure:apimanagement:Service
properties:
    additionalLocations:
        - capacity: 0
          gatewayDisabled: false
          gatewayRegionalUrl: string
          location: string
          privateIpAddresses:
            - string
          publicIpAddressId: string
          publicIpAddresses:
            - string
          virtualNetworkConfiguration:
            subnetId: string
          zones:
            - string
    certificates:
        - certificatePassword: string
          encodedCertificate: string
          expiry: string
          storeName: string
          subject: string
          thumbprint: string
    clientCertificateEnabled: false
    delegation:
        subscriptionsEnabled: false
        url: string
        userRegistrationEnabled: false
        validationKey: string
    gatewayDisabled: false
    hostnameConfiguration:
        developerPortals:
            - certificate: string
              certificatePassword: string
              certificateSource: string
              certificateStatus: string
              expiry: string
              hostName: string
              keyVaultId: string
              negotiateClientCertificate: false
              sslKeyvaultIdentityClientId: string
              subject: string
              thumbprint: string
        managements:
            - certificate: string
              certificatePassword: string
              certificateSource: string
              certificateStatus: string
              expiry: string
              hostName: string
              keyVaultId: string
              negotiateClientCertificate: false
              sslKeyvaultIdentityClientId: string
              subject: string
              thumbprint: string
        portals:
            - certificate: string
              certificatePassword: string
              certificateSource: string
              certificateStatus: string
              expiry: string
              hostName: string
              keyVaultId: string
              negotiateClientCertificate: false
              sslKeyvaultIdentityClientId: string
              subject: string
              thumbprint: string
        proxies:
            - certificate: string
              certificatePassword: string
              certificateSource: string
              certificateStatus: string
              defaultSslBinding: false
              expiry: string
              hostName: string
              keyVaultId: string
              negotiateClientCertificate: false
              sslKeyvaultIdentityClientId: string
              subject: string
              thumbprint: string
        scms:
            - certificate: string
              certificatePassword: string
              certificateSource: string
              certificateStatus: string
              expiry: string
              hostName: string
              keyVaultId: string
              negotiateClientCertificate: false
              sslKeyvaultIdentityClientId: string
              subject: string
              thumbprint: string
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    location: string
    minApiVersion: string
    name: string
    notificationSenderEmail: string
    protocols:
        enableHttp2: false
    publicIpAddressId: string
    publicNetworkAccessEnabled: false
    publisherEmail: string
    publisherName: string
    resourceGroupName: string
    security:
        enableBackendSsl30: false
        enableBackendTls10: false
        enableBackendTls11: false
        enableFrontendSsl30: false
        enableFrontendTls10: false
        enableFrontendTls11: false
        tlsEcdheEcdsaWithAes128CbcShaCiphersEnabled: false
        tlsEcdheEcdsaWithAes256CbcShaCiphersEnabled: false
        tlsEcdheRsaWithAes128CbcShaCiphersEnabled: false
        tlsEcdheRsaWithAes256CbcShaCiphersEnabled: false
        tlsRsaWithAes128CbcSha256CiphersEnabled: false
        tlsRsaWithAes128CbcShaCiphersEnabled: false
        tlsRsaWithAes128GcmSha256CiphersEnabled: false
        tlsRsaWithAes256CbcSha256CiphersEnabled: false
        tlsRsaWithAes256CbcShaCiphersEnabled: false
        tlsRsaWithAes256GcmSha384CiphersEnabled: false
        tripleDesCiphersEnabled: false
    signIn:
        enabled: false
    signUp:
        enabled: false
        termsOfService:
            consentRequired: false
            enabled: false
            text: string
    skuName: string
    tags:
        string: string
    tenantAccess:
        enabled: false
        primaryKey: string
        secondaryKey: string
        tenantId: string
    virtualNetworkConfiguration:
        subnetId: string
    virtualNetworkType: string
    zones:
        - string
Copy

Service Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Service resource accepts the following input properties:

PublisherEmail This property is required. string
The email of publisher/company.
PublisherName This property is required. string
The name of publisher/company.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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 This property is required. string

sku_name is a string consisting of two parts separated by an underscore(_). The first 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).

NOTE: Premium SKU's are limited to a default maximum of 12 (i.e. Premium_12), this can, however, be increased via support request.

NOTE: Consumption SKU capacity should be 0 (e.g. Consumption_0) as this tier includes automatic scaling.

AdditionalLocations List<ServiceAdditionalLocation>
One or more additional_location blocks as defined below.
Certificates List<ServiceCertificate>
One or more certificate blocks (up to 10) as defined below.
ClientCertificateEnabled bool
Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.
Delegation ServiceDelegation
A delegation block as defined below.
GatewayDisabled bool
Disable the gateway in main region? This is only supported when additional_location is set.
HostnameConfiguration ServiceHostnameConfiguration
A hostname_configuration block as defined below.
Identity ServiceIdentity
An identity block as defined below.
Location Changes to this property will trigger replacement. string
The Azure location where the API Management Service exists. Changing this forces a new resource to be created.
MinApiVersion string
The version which the control plane API calls to API Management service are limited with version equal to or newer than.
Name Changes to this property will trigger replacement. 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.
Protocols ServiceProtocols
A protocols block as defined below.
PublicIpAddressId string

ID of a standard SKU IPv4 Public IP.

NOTE: Custom public IPs are only supported on the Premium and Developer tiers when deployed in a virtual network.

PublicNetworkAccessEnabled bool

Is public access to the service allowed? Defaults to true.

NOTE: This option is applicable only to the Management plane, not the API gateway or Developer portal. It is required to be true on the creation.

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 Dictionary<string, string>
A mapping of tags assigned to the resource.
TenantAccess ServiceTenantAccess
A tenant_access block as defined below.
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. Defaults to None.

NOTE: Please ensure that in the subnet, inbound port 3443 is open when virtual_network_type is Internal or External. And please ensure other necessary ports are open according to api management network configuration.

Zones List<string>

Specifies a list of Availability Zones in which this API Management service should be located.

NOTE: Availability zones are only supported in the Premium tier.

PublisherEmail This property is required. string
The email of publisher/company.
PublisherName This property is required. string
The name of publisher/company.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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 This property is required. string

sku_name is a string consisting of two parts separated by an underscore(_). The first 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).

NOTE: Premium SKU's are limited to a default maximum of 12 (i.e. Premium_12), this can, however, be increased via support request.

NOTE: Consumption SKU capacity should be 0 (e.g. Consumption_0) as this tier includes automatic scaling.

AdditionalLocations []ServiceAdditionalLocationArgs
One or more additional_location blocks as defined below.
Certificates []ServiceCertificateArgs
One or more certificate blocks (up to 10) as defined below.
ClientCertificateEnabled bool
Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.
Delegation ServiceDelegationArgs
A delegation block as defined below.
GatewayDisabled bool
Disable the gateway in main region? This is only supported when additional_location is set.
HostnameConfiguration ServiceHostnameConfigurationArgs
A hostname_configuration block as defined below.
Identity ServiceIdentityArgs
An identity block as defined below.
Location Changes to this property will trigger replacement. string
The Azure location where the API Management Service exists. Changing this forces a new resource to be created.
MinApiVersion string
The version which the control plane API calls to API Management service are limited with version equal to or newer than.
Name Changes to this property will trigger replacement. 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.
Protocols ServiceProtocolsArgs
A protocols block as defined below.
PublicIpAddressId string

ID of a standard SKU IPv4 Public IP.

NOTE: Custom public IPs are only supported on the Premium and Developer tiers when deployed in a virtual network.

PublicNetworkAccessEnabled bool

Is public access to the service allowed? Defaults to true.

NOTE: This option is applicable only to the Management plane, not the API gateway or Developer portal. It is required to be true on the creation.

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 map[string]string
A mapping of tags assigned to the resource.
TenantAccess ServiceTenantAccessArgs
A tenant_access block as defined below.
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. Defaults to None.

NOTE: Please ensure that in the subnet, inbound port 3443 is open when virtual_network_type is Internal or External. And please ensure other necessary ports are open according to api management network configuration.

Zones []string

Specifies a list of Availability Zones in which this API Management service should be located.

NOTE: Availability zones are only supported in the Premium tier.

publisherEmail This property is required. String
The email of publisher/company.
publisherName This property is required. String
The name of publisher/company.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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 This property is required. String

sku_name is a string consisting of two parts separated by an underscore(_). The first 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).

NOTE: Premium SKU's are limited to a default maximum of 12 (i.e. Premium_12), this can, however, be increased via support request.

NOTE: Consumption SKU capacity should be 0 (e.g. Consumption_0) as this tier includes automatic scaling.

additionalLocations List<ServiceAdditionalLocation>
One or more additional_location blocks as defined below.
certificates List<ServiceCertificate>
One or more certificate blocks (up to 10) as defined below.
clientCertificateEnabled Boolean
Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.
delegation ServiceDelegation
A delegation block as defined below.
gatewayDisabled Boolean
Disable the gateway in main region? This is only supported when additional_location is set.
hostnameConfiguration ServiceHostnameConfiguration
A hostname_configuration block as defined below.
identity ServiceIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. String
The Azure location where the API Management Service exists. Changing this forces a new resource to be created.
minApiVersion String
The version which the control plane API calls to API Management service are limited with version equal to or newer than.
name Changes to this property will trigger replacement. 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.
protocols ServiceProtocols
A protocols block as defined below.
publicIpAddressId String

ID of a standard SKU IPv4 Public IP.

NOTE: Custom public IPs are only supported on the Premium and Developer tiers when deployed in a virtual network.

publicNetworkAccessEnabled Boolean

Is public access to the service allowed? Defaults to true.

NOTE: This option is applicable only to the Management plane, not the API gateway or Developer portal. It is required to be true on the creation.

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.
tenantAccess ServiceTenantAccess
A tenant_access block as defined below.
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. Defaults to None.

NOTE: Please ensure that in the subnet, inbound port 3443 is open when virtual_network_type is Internal or External. And please ensure other necessary ports are open according to api management network configuration.

zones List<String>

Specifies a list of Availability Zones in which this API Management service should be located.

NOTE: Availability zones are only supported in the Premium tier.

publisherEmail This property is required. string
The email of publisher/company.
publisherName This property is required. string
The name of publisher/company.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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 This property is required. string

sku_name is a string consisting of two parts separated by an underscore(_). The first 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).

NOTE: Premium SKU's are limited to a default maximum of 12 (i.e. Premium_12), this can, however, be increased via support request.

NOTE: Consumption SKU capacity should be 0 (e.g. Consumption_0) as this tier includes automatic scaling.

additionalLocations ServiceAdditionalLocation[]
One or more additional_location blocks as defined below.
certificates ServiceCertificate[]
One or more certificate blocks (up to 10) as defined below.
clientCertificateEnabled boolean
Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.
delegation ServiceDelegation
A delegation block as defined below.
gatewayDisabled boolean
Disable the gateway in main region? This is only supported when additional_location is set.
hostnameConfiguration ServiceHostnameConfiguration
A hostname_configuration block as defined below.
identity ServiceIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. string
The Azure location where the API Management Service exists. Changing this forces a new resource to be created.
minApiVersion string
The version which the control plane API calls to API Management service are limited with version equal to or newer than.
name Changes to this property will trigger replacement. 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.
protocols ServiceProtocols
A protocols block as defined below.
publicIpAddressId string

ID of a standard SKU IPv4 Public IP.

NOTE: Custom public IPs are only supported on the Premium and Developer tiers when deployed in a virtual network.

publicNetworkAccessEnabled boolean

Is public access to the service allowed? Defaults to true.

NOTE: This option is applicable only to the Management plane, not the API gateway or Developer portal. It is required to be true on the creation.

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.
tenantAccess ServiceTenantAccess
A tenant_access block as defined below.
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. Defaults to None.

NOTE: Please ensure that in the subnet, inbound port 3443 is open when virtual_network_type is Internal or External. And please ensure other necessary ports are open according to api management network configuration.

zones string[]

Specifies a list of Availability Zones in which this API Management service should be located.

NOTE: Availability zones are only supported in the Premium tier.

publisher_email This property is required. str
The email of publisher/company.
publisher_name This property is required. str
The name of publisher/company.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
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 This property is required. str

sku_name is a string consisting of two parts separated by an underscore(_). The first 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).

NOTE: Premium SKU's are limited to a default maximum of 12 (i.e. Premium_12), this can, however, be increased via support request.

NOTE: Consumption SKU capacity should be 0 (e.g. Consumption_0) as this tier includes automatic scaling.

additional_locations Sequence[ServiceAdditionalLocationArgs]
One or more additional_location blocks as defined below.
certificates Sequence[ServiceCertificateArgs]
One or more certificate blocks (up to 10) as defined below.
client_certificate_enabled bool
Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.
delegation ServiceDelegationArgs
A delegation block as defined below.
gateway_disabled bool
Disable the gateway in main region? This is only supported when additional_location is set.
hostname_configuration ServiceHostnameConfigurationArgs
A hostname_configuration block as defined below.
identity ServiceIdentityArgs
An identity block as defined below.
location Changes to this property will trigger replacement. str
The Azure location where the API Management Service exists. Changing this forces a new resource to be created.
min_api_version str
The version which the control plane API calls to API Management service are limited with version equal to or newer than.
name Changes to this property will trigger replacement. 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.
protocols ServiceProtocolsArgs
A protocols block as defined below.
public_ip_address_id str

ID of a standard SKU IPv4 Public IP.

NOTE: Custom public IPs are only supported on the Premium and Developer tiers when deployed in a virtual network.

public_network_access_enabled bool

Is public access to the service allowed? Defaults to true.

NOTE: This option is applicable only to the Management plane, not the API gateway or Developer portal. It is required to be true on the creation.

security ServiceSecurityArgs
A security block as defined below.
sign_in ServiceSignInArgs
A sign_in block as defined below.
sign_up ServiceSignUpArgs
A sign_up block as defined below.
tags Mapping[str, str]
A mapping of tags assigned to the resource.
tenant_access ServiceTenantAccessArgs
A tenant_access block as defined below.
virtual_network_configuration ServiceVirtualNetworkConfigurationArgs
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. Defaults to None.

NOTE: Please ensure that in the subnet, inbound port 3443 is open when virtual_network_type is Internal or External. And please ensure other necessary ports are open according to api management network configuration.

zones Sequence[str]

Specifies a list of Availability Zones in which this API Management service should be located.

NOTE: Availability zones are only supported in the Premium tier.

publisherEmail This property is required. String
The email of publisher/company.
publisherName This property is required. String
The name of publisher/company.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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 This property is required. String

sku_name is a string consisting of two parts separated by an underscore(_). The first 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).

NOTE: Premium SKU's are limited to a default maximum of 12 (i.e. Premium_12), this can, however, be increased via support request.

NOTE: Consumption SKU capacity should be 0 (e.g. Consumption_0) as this tier includes automatic scaling.

additionalLocations List<Property Map>
One or more additional_location blocks as defined below.
certificates List<Property Map>
One or more certificate blocks (up to 10) as defined below.
clientCertificateEnabled Boolean
Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.
delegation Property Map
A delegation block as defined below.
gatewayDisabled Boolean
Disable the gateway in main region? This is only supported when additional_location is set.
hostnameConfiguration Property Map
A hostname_configuration block as defined below.
identity Property Map
An identity block as defined below.
location Changes to this property will trigger replacement. String
The Azure location where the API Management Service exists. Changing this forces a new resource to be created.
minApiVersion String
The version which the control plane API calls to API Management service are limited with version equal to or newer than.
name Changes to this property will trigger replacement. 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.
protocols Property Map
A protocols block as defined below.
publicIpAddressId String

ID of a standard SKU IPv4 Public IP.

NOTE: Custom public IPs are only supported on the Premium and Developer tiers when deployed in a virtual network.

publicNetworkAccessEnabled Boolean

Is public access to the service allowed? Defaults to true.

NOTE: This option is applicable only to the Management plane, not the API gateway or Developer portal. It is required to be true on the creation.

security Property Map
A security block as defined below.
signIn Property Map
A sign_in block as defined below.
signUp Property Map
A sign_up block as defined below.
tags Map<String>
A mapping of tags assigned to the resource.
tenantAccess Property Map
A tenant_access block as defined below.
virtualNetworkConfiguration Property Map
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. Defaults to None.

NOTE: Please ensure that in the subnet, inbound port 3443 is open when virtual_network_type is Internal or External. And please ensure other necessary ports are open according to api management network configuration.

zones List<String>

Specifies a list of Availability Zones in which this API Management service should be located.

NOTE: Availability zones are only supported in the Premium tier.

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>
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
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
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
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 List<String>
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
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[]
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
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 Sequence[str]
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
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 and Premium SKU.
scm_url str
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 List<String>
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
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.

Look up 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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_locations: Optional[Sequence[ServiceAdditionalLocationArgs]] = None,
        certificates: Optional[Sequence[ServiceCertificateArgs]] = None,
        client_certificate_enabled: Optional[bool] = None,
        delegation: Optional[ServiceDelegationArgs] = None,
        developer_portal_url: Optional[str] = None,
        gateway_disabled: Optional[bool] = None,
        gateway_regional_url: Optional[str] = None,
        gateway_url: Optional[str] = None,
        hostname_configuration: Optional[ServiceHostnameConfigurationArgs] = None,
        identity: Optional[ServiceIdentityArgs] = None,
        location: Optional[str] = None,
        management_api_url: Optional[str] = None,
        min_api_version: Optional[str] = None,
        name: Optional[str] = None,
        notification_sender_email: Optional[str] = None,
        portal_url: Optional[str] = None,
        private_ip_addresses: Optional[Sequence[str]] = None,
        protocols: Optional[ServiceProtocolsArgs] = None,
        public_ip_address_id: Optional[str] = None,
        public_ip_addresses: Optional[Sequence[str]] = None,
        public_network_access_enabled: Optional[bool] = None,
        publisher_email: Optional[str] = None,
        publisher_name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        scm_url: Optional[str] = None,
        security: Optional[ServiceSecurityArgs] = None,
        sign_in: Optional[ServiceSignInArgs] = None,
        sign_up: Optional[ServiceSignUpArgs] = None,
        sku_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tenant_access: Optional[ServiceTenantAccessArgs] = None,
        virtual_network_configuration: Optional[ServiceVirtualNetworkConfigurationArgs] = None,
        virtual_network_type: Optional[str] = None,
        zones: Optional[Sequence[str]] = None) -> Service
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)
public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
resources:  _:    type: azure:apimanagement:Service    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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<ServiceAdditionalLocation>
One or more additional_location blocks as defined below.
Certificates List<ServiceCertificate>
One or more certificate blocks (up to 10) as defined below.
ClientCertificateEnabled bool
Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.
Delegation ServiceDelegation
A delegation block as defined below.
DeveloperPortalUrl string
The URL for the Developer Portal associated with this API Management service.
GatewayDisabled bool
Disable the gateway in main region? This is only supported when additional_location is set.
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 as defined below.
Location Changes to this property will trigger replacement. 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.
MinApiVersion string
The version which the control plane API calls to API Management service are limited with version equal to or newer than.
Name Changes to this property will trigger replacement. 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.
PortalUrl string
The URL for the Publisher Portal associated with this API Management service.
PrivateIpAddresses List<string>
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
Protocols ServiceProtocols
A protocols block as defined below.
PublicIpAddressId string

ID of a standard SKU IPv4 Public IP.

NOTE: Custom public IPs are only supported on the Premium and Developer tiers when deployed in a virtual network.

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.
PublicNetworkAccessEnabled bool

Is public access to the service allowed? Defaults to true.

NOTE: This option is applicable only to the Management plane, not the API gateway or Developer portal. It is required to be true on the creation.

PublisherEmail string
The email of publisher/company.
PublisherName string
The name of publisher/company.
ResourceGroupName Changes to this property will trigger replacement. 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 first 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).

NOTE: Premium SKU's are limited to a default maximum of 12 (i.e. Premium_12), this can, however, be increased via support request.

NOTE: Consumption SKU capacity should be 0 (e.g. Consumption_0) as this tier includes automatic scaling.

Tags Dictionary<string, string>
A mapping of tags assigned to the resource.
TenantAccess ServiceTenantAccess
A tenant_access block as defined below.
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. Defaults to None.

NOTE: Please ensure that in the subnet, inbound port 3443 is open when virtual_network_type is Internal or External. And please ensure other necessary ports are open according to api management network configuration.

Zones List<string>

Specifies a list of Availability Zones in which this API Management service should be located.

NOTE: Availability zones are only supported in the Premium tier.

AdditionalLocations []ServiceAdditionalLocationArgs
One or more additional_location blocks as defined below.
Certificates []ServiceCertificateArgs
One or more certificate blocks (up to 10) as defined below.
ClientCertificateEnabled bool
Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.
Delegation ServiceDelegationArgs
A delegation block as defined below.
DeveloperPortalUrl string
The URL for the Developer Portal associated with this API Management service.
GatewayDisabled bool
Disable the gateway in main region? This is only supported when additional_location is set.
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 as defined below.
Location Changes to this property will trigger replacement. 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.
MinApiVersion string
The version which the control plane API calls to API Management service are limited with version equal to or newer than.
Name Changes to this property will trigger replacement. 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.
PortalUrl string
The URL for the Publisher Portal associated with this API Management service.
PrivateIpAddresses []string
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
Protocols ServiceProtocolsArgs
A protocols block as defined below.
PublicIpAddressId string

ID of a standard SKU IPv4 Public IP.

NOTE: Custom public IPs are only supported on the Premium and Developer tiers when deployed in a virtual network.

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.
PublicNetworkAccessEnabled bool

Is public access to the service allowed? Defaults to true.

NOTE: This option is applicable only to the Management plane, not the API gateway or Developer portal. It is required to be true on the creation.

PublisherEmail string
The email of publisher/company.
PublisherName string
The name of publisher/company.
ResourceGroupName Changes to this property will trigger replacement. 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 first 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).

NOTE: Premium SKU's are limited to a default maximum of 12 (i.e. Premium_12), this can, however, be increased via support request.

NOTE: Consumption SKU capacity should be 0 (e.g. Consumption_0) as this tier includes automatic scaling.

Tags map[string]string
A mapping of tags assigned to the resource.
TenantAccess ServiceTenantAccessArgs
A tenant_access block as defined below.
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. Defaults to None.

NOTE: Please ensure that in the subnet, inbound port 3443 is open when virtual_network_type is Internal or External. And please ensure other necessary ports are open according to api management network configuration.

Zones []string

Specifies a list of Availability Zones in which this API Management service should be located.

NOTE: Availability zones are only supported in the Premium tier.

additionalLocations List<ServiceAdditionalLocation>
One or more additional_location blocks as defined below.
certificates List<ServiceCertificate>
One or more certificate blocks (up to 10) as defined below.
clientCertificateEnabled Boolean
Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.
delegation ServiceDelegation
A delegation block as defined below.
developerPortalUrl String
The URL for the Developer Portal associated with this API Management service.
gatewayDisabled Boolean
Disable the gateway in main region? This is only supported when additional_location is set.
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 as defined below.
location Changes to this property will trigger replacement. 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.
minApiVersion String
The version which the control plane API calls to API Management service are limited with version equal to or newer than.
name Changes to this property will trigger replacement. 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.
portalUrl String
The URL for the Publisher Portal associated with this API Management service.
privateIpAddresses List<String>
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
protocols ServiceProtocols
A protocols block as defined below.
publicIpAddressId String

ID of a standard SKU IPv4 Public IP.

NOTE: Custom public IPs are only supported on the Premium and Developer tiers when deployed in a virtual network.

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.
publicNetworkAccessEnabled Boolean

Is public access to the service allowed? Defaults to true.

NOTE: This option is applicable only to the Management plane, not the API gateway or Developer portal. It is required to be true on the creation.

publisherEmail String
The email of publisher/company.
publisherName String
The name of publisher/company.
resourceGroupName Changes to this property will trigger replacement. 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 first 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).

NOTE: Premium SKU's are limited to a default maximum of 12 (i.e. Premium_12), this can, however, be increased via support request.

NOTE: Consumption SKU capacity should be 0 (e.g. Consumption_0) as this tier includes automatic scaling.

tags Map<String,String>
A mapping of tags assigned to the resource.
tenantAccess ServiceTenantAccess
A tenant_access block as defined below.
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. Defaults to None.

NOTE: Please ensure that in the subnet, inbound port 3443 is open when virtual_network_type is Internal or External. And please ensure other necessary ports are open according to api management network configuration.

zones List<String>

Specifies a list of Availability Zones in which this API Management service should be located.

NOTE: Availability zones are only supported in the Premium tier.

additionalLocations ServiceAdditionalLocation[]
One or more additional_location blocks as defined below.
certificates ServiceCertificate[]
One or more certificate blocks (up to 10) as defined below.
clientCertificateEnabled boolean
Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.
delegation ServiceDelegation
A delegation block as defined below.
developerPortalUrl string
The URL for the Developer Portal associated with this API Management service.
gatewayDisabled boolean
Disable the gateway in main region? This is only supported when additional_location is set.
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 as defined below.
location Changes to this property will trigger replacement. 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.
minApiVersion string
The version which the control plane API calls to API Management service are limited with version equal to or newer than.
name Changes to this property will trigger replacement. 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.
portalUrl string
The URL for the Publisher Portal associated with this API Management service.
privateIpAddresses string[]
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
protocols ServiceProtocols
A protocols block as defined below.
publicIpAddressId string

ID of a standard SKU IPv4 Public IP.

NOTE: Custom public IPs are only supported on the Premium and Developer tiers when deployed in a virtual network.

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.
publicNetworkAccessEnabled boolean

Is public access to the service allowed? Defaults to true.

NOTE: This option is applicable only to the Management plane, not the API gateway or Developer portal. It is required to be true on the creation.

publisherEmail string
The email of publisher/company.
publisherName string
The name of publisher/company.
resourceGroupName Changes to this property will trigger replacement. 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 first 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).

NOTE: Premium SKU's are limited to a default maximum of 12 (i.e. Premium_12), this can, however, be increased via support request.

NOTE: Consumption SKU capacity should be 0 (e.g. Consumption_0) as this tier includes automatic scaling.

tags {[key: string]: string}
A mapping of tags assigned to the resource.
tenantAccess ServiceTenantAccess
A tenant_access block as defined below.
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. Defaults to None.

NOTE: Please ensure that in the subnet, inbound port 3443 is open when virtual_network_type is Internal or External. And please ensure other necessary ports are open according to api management network configuration.

zones string[]

Specifies a list of Availability Zones in which this API Management service should be located.

NOTE: Availability zones are only supported in the Premium tier.

additional_locations Sequence[ServiceAdditionalLocationArgs]
One or more additional_location blocks as defined below.
certificates Sequence[ServiceCertificateArgs]
One or more certificate blocks (up to 10) as defined below.
client_certificate_enabled bool
Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.
delegation ServiceDelegationArgs
A delegation block as defined below.
developer_portal_url str
The URL for the Developer Portal associated with this API Management service.
gateway_disabled bool
Disable the gateway in main region? This is only supported when additional_location is set.
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 ServiceHostnameConfigurationArgs
A hostname_configuration block as defined below.
identity ServiceIdentityArgs
An identity block as defined below.
location Changes to this property will trigger replacement. 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.
min_api_version str
The version which the control plane API calls to API Management service are limited with version equal to or newer than.
name Changes to this property will trigger replacement. 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.
portal_url str
The URL for the Publisher Portal associated with this API Management service.
private_ip_addresses Sequence[str]
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
protocols ServiceProtocolsArgs
A protocols block as defined below.
public_ip_address_id str

ID of a standard SKU IPv4 Public IP.

NOTE: Custom public IPs are only supported on the Premium and Developer tiers when deployed in a virtual network.

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 and Premium SKU.
public_network_access_enabled bool

Is public access to the service allowed? Defaults to true.

NOTE: This option is applicable only to the Management plane, not the API gateway or Developer portal. It is required to be true on the creation.

publisher_email str
The email of publisher/company.
publisher_name str
The name of publisher/company.
resource_group_name Changes to this property will trigger replacement. 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 ServiceSecurityArgs
A security block as defined below.
sign_in ServiceSignInArgs
A sign_in block as defined below.
sign_up ServiceSignUpArgs
A sign_up block as defined below.
sku_name str

sku_name is a string consisting of two parts separated by an underscore(_). The first 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).

NOTE: Premium SKU's are limited to a default maximum of 12 (i.e. Premium_12), this can, however, be increased via support request.

NOTE: Consumption SKU capacity should be 0 (e.g. Consumption_0) as this tier includes automatic scaling.

tags Mapping[str, str]
A mapping of tags assigned to the resource.
tenant_access ServiceTenantAccessArgs
A tenant_access block as defined below.
virtual_network_configuration ServiceVirtualNetworkConfigurationArgs
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. Defaults to None.

NOTE: Please ensure that in the subnet, inbound port 3443 is open when virtual_network_type is Internal or External. And please ensure other necessary ports are open according to api management network configuration.

zones Sequence[str]

Specifies a list of Availability Zones in which this API Management service should be located.

NOTE: Availability zones are only supported in the Premium tier.

additionalLocations List<Property Map>
One or more additional_location blocks as defined below.
certificates List<Property Map>
One or more certificate blocks (up to 10) as defined below.
clientCertificateEnabled Boolean
Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.
delegation Property Map
A delegation block as defined below.
developerPortalUrl String
The URL for the Developer Portal associated with this API Management service.
gatewayDisabled Boolean
Disable the gateway in main region? This is only supported when additional_location is set.
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 Property Map
A hostname_configuration block as defined below.
identity Property Map
An identity block as defined below.
location Changes to this property will trigger replacement. 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.
minApiVersion String
The version which the control plane API calls to API Management service are limited with version equal to or newer than.
name Changes to this property will trigger replacement. 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.
portalUrl String
The URL for the Publisher Portal associated with this API Management service.
privateIpAddresses List<String>
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
protocols Property Map
A protocols block as defined below.
publicIpAddressId String

ID of a standard SKU IPv4 Public IP.

NOTE: Custom public IPs are only supported on the Premium and Developer tiers when deployed in a virtual network.

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.
publicNetworkAccessEnabled Boolean

Is public access to the service allowed? Defaults to true.

NOTE: This option is applicable only to the Management plane, not the API gateway or Developer portal. It is required to be true on the creation.

publisherEmail String
The email of publisher/company.
publisherName String
The name of publisher/company.
resourceGroupName Changes to this property will trigger replacement. 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 Property Map
A security block as defined below.
signIn Property Map
A sign_in block as defined below.
signUp Property Map
A sign_up block as defined below.
skuName String

sku_name is a string consisting of two parts separated by an underscore(_). The first 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).

NOTE: Premium SKU's are limited to a default maximum of 12 (i.e. Premium_12), this can, however, be increased via support request.

NOTE: Consumption SKU capacity should be 0 (e.g. Consumption_0) as this tier includes automatic scaling.

tags Map<String>
A mapping of tags assigned to the resource.
tenantAccess Property Map
A tenant_access block as defined below.
virtualNetworkConfiguration Property Map
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. Defaults to None.

NOTE: Please ensure that in the subnet, inbound port 3443 is open when virtual_network_type is Internal or External. And please ensure other necessary ports are open according to api management network configuration.

zones List<String>

Specifies a list of Availability Zones in which this API Management service should be located.

NOTE: Availability zones are only supported in the Premium tier.

Supporting Types

ServiceAdditionalLocation
, ServiceAdditionalLocationArgs

Location This property is required. string
The name of the Azure Region in which the API Management Service should be expanded to.
Capacity int
The number of compute units in this region. Defaults to the capacity of the main region.
GatewayDisabled bool
Only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
GatewayRegionalUrl string
The URL of the Regional Gateway for the API Management Service in the specified region.
PrivateIpAddresses List<string>
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
PublicIpAddressId string

ID of a standard SKU IPv4 Public IP.

NOTE: Availability zones and custom public IPs are only supported in the Premium tier.

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.
VirtualNetworkConfiguration ServiceAdditionalLocationVirtualNetworkConfiguration
A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.
Zones List<string>
A list of availability zones.
Location This property is required. string
The name of the Azure Region in which the API Management Service should be expanded to.
Capacity int
The number of compute units in this region. Defaults to the capacity of the main region.
GatewayDisabled bool
Only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
GatewayRegionalUrl string
The URL of the Regional Gateway for the API Management Service in the specified region.
PrivateIpAddresses []string
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
PublicIpAddressId string

ID of a standard SKU IPv4 Public IP.

NOTE: Availability zones and custom public IPs are only supported in the Premium tier.

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.
VirtualNetworkConfiguration ServiceAdditionalLocationVirtualNetworkConfiguration
A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.
Zones []string
A list of availability zones.
location This property is required. String
The name of the Azure Region in which the API Management Service should be expanded to.
capacity Integer
The number of compute units in this region. Defaults to the capacity of the main region.
gatewayDisabled Boolean
Only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
gatewayRegionalUrl String
The URL of the Regional Gateway for the API Management Service in the specified region.
privateIpAddresses List<String>
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
publicIpAddressId String

ID of a standard SKU IPv4 Public IP.

NOTE: Availability zones and custom public IPs are only supported in the Premium tier.

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.
virtualNetworkConfiguration ServiceAdditionalLocationVirtualNetworkConfiguration
A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.
zones List<String>
A list of availability zones.
location This property is required. string
The name of the Azure Region in which the API Management Service should be expanded to.
capacity number
The number of compute units in this region. Defaults to the capacity of the main region.
gatewayDisabled boolean
Only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
gatewayRegionalUrl string
The URL of the Regional Gateway for the API Management Service in the specified region.
privateIpAddresses string[]
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
publicIpAddressId string

ID of a standard SKU IPv4 Public IP.

NOTE: Availability zones and custom public IPs are only supported in the Premium tier.

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.
virtualNetworkConfiguration ServiceAdditionalLocationVirtualNetworkConfiguration
A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.
zones string[]
A list of availability zones.
location This property is required. str
The name of the Azure Region in which the API Management Service should be expanded to.
capacity int
The number of compute units in this region. Defaults to the capacity of the main region.
gateway_disabled bool
Only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
gateway_regional_url str
The URL of the Regional Gateway for the API Management Service in the specified region.
private_ip_addresses Sequence[str]
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
public_ip_address_id str

ID of a standard SKU IPv4 Public IP.

NOTE: Availability zones and custom public IPs are only supported in the Premium tier.

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 and Premium SKU.
virtual_network_configuration ServiceAdditionalLocationVirtualNetworkConfiguration
A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.
zones Sequence[str]
A list of availability zones.
location This property is required. String
The name of the Azure Region in which the API Management Service should be expanded to.
capacity Number
The number of compute units in this region. Defaults to the capacity of the main region.
gatewayDisabled Boolean
Only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
gatewayRegionalUrl String
The URL of the Regional Gateway for the API Management Service in the specified region.
privateIpAddresses List<String>
The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.
publicIpAddressId String

ID of a standard SKU IPv4 Public IP.

NOTE: Availability zones and custom public IPs are only supported in the Premium tier.

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.
virtualNetworkConfiguration Property Map
A virtual_network_configuration block as defined below. Required when virtual_network_type is External or Internal.
zones List<String>
A list of availability zones.

ServiceAdditionalLocationVirtualNetworkConfiguration
, ServiceAdditionalLocationVirtualNetworkConfigurationArgs

SubnetId This property is required. string
The id of the subnet that will be used for the API Management.
SubnetId This property is required. string
The id of the subnet that will be used for the API Management.
subnetId This property is required. String
The id of the subnet that will be used for the API Management.
subnetId This property is required. string
The id of the subnet that will be used for the API Management.
subnet_id This property is required. str
The id of the subnet that will be used for the API Management.
subnetId This property is required. String
The id of the subnet that will be used for the API Management.

ServiceCertificate
, ServiceCertificateArgs

EncodedCertificate This property is required. string
The Base64 Encoded PFX or Base64 Encoded X.509 Certificate.
StoreName This property is required. 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.
Expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
Subject string
The subject of the certificate.
Thumbprint string
The thumbprint of the certificate.
EncodedCertificate This property is required. string
The Base64 Encoded PFX or Base64 Encoded X.509 Certificate.
StoreName This property is required. 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.
Expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
Subject string
The subject of the certificate.
Thumbprint string
The thumbprint of the certificate.
encodedCertificate This property is required. String
The Base64 Encoded PFX or Base64 Encoded X.509 Certificate.
storeName This property is required. 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.
expiry String
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
subject String
The subject of the certificate.
thumbprint String
The thumbprint of the certificate.
encodedCertificate This property is required. string
The Base64 Encoded PFX or Base64 Encoded X.509 Certificate.
storeName This property is required. 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.
expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
subject string
The subject of the certificate.
thumbprint string
The thumbprint of the certificate.
encoded_certificate This property is required. str
The Base64 Encoded PFX or Base64 Encoded X.509 Certificate.
store_name This property is required. str
The name of the Certificate Store where this certificate should be stored. Possible values are CertificateAuthority and Root.
certificate_password str
The password for the certificate.
expiry str
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
subject str
The subject of the certificate.
thumbprint str
The thumbprint of the certificate.
encodedCertificate This property is required. String
The Base64 Encoded PFX or Base64 Encoded X.509 Certificate.
storeName This property is required. 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.
expiry String
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
subject String
The subject of the certificate.
thumbprint String
The thumbprint of the certificate.

ServiceDelegation
, ServiceDelegationArgs

SubscriptionsEnabled bool
Should subscription requests be delegated to an external url? Defaults to false.
Url string
The delegation URL.
UserRegistrationEnabled bool
Should user registration requests be delegated to an external url? Defaults to false.
ValidationKey string
A base64-encoded validation key to validate, that a request is coming from Azure API Management.
SubscriptionsEnabled bool
Should subscription requests be delegated to an external url? Defaults to false.
Url string
The delegation URL.
UserRegistrationEnabled bool
Should user registration requests be delegated to an external url? Defaults to false.
ValidationKey string
A base64-encoded validation key to validate, that a request is coming from Azure API Management.
subscriptionsEnabled Boolean
Should subscription requests be delegated to an external url? Defaults to false.
url String
The delegation URL.
userRegistrationEnabled Boolean
Should user registration requests be delegated to an external url? Defaults to false.
validationKey String
A base64-encoded validation key to validate, that a request is coming from Azure API Management.
subscriptionsEnabled boolean
Should subscription requests be delegated to an external url? Defaults to false.
url string
The delegation URL.
userRegistrationEnabled boolean
Should user registration requests be delegated to an external url? Defaults to false.
validationKey string
A base64-encoded validation key to validate, that a request is coming from Azure API Management.
subscriptions_enabled bool
Should subscription requests be delegated to an external url? Defaults to false.
url str
The delegation URL.
user_registration_enabled bool
Should user registration requests be delegated to an external url? Defaults to false.
validation_key str
A base64-encoded validation key to validate, that a request is coming from Azure API Management.
subscriptionsEnabled Boolean
Should subscription requests be delegated to an external url? Defaults to false.
url String
The delegation URL.
userRegistrationEnabled Boolean
Should user registration requests be delegated to an external url? Defaults to false.
validationKey String
A base64-encoded validation key to validate, that a request is coming from Azure API Management.

ServiceHostnameConfiguration
, ServiceHostnameConfigurationArgs

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.
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.
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.
developer_portals Sequence[ServiceHostnameConfigurationDeveloperPortal]
One or more developer_portal blocks as documented below.
managements Sequence[ServiceHostnameConfigurationManagement]
One or more management blocks as documented below.
portals Sequence[ServiceHostnameConfigurationPortal]
One or more portal blocks as documented below.
proxies Sequence[ServiceHostnameConfigurationProxy]
One or more proxy blocks as documented below.
scms Sequence[ServiceHostnameConfigurationScm]
One or more scm blocks as documented below.
developerPortals List<Property Map>
One or more developer_portal blocks as documented below.
managements List<Property Map>
One or more management blocks as documented below.
portals List<Property Map>
One or more portal blocks as documented below.
proxies List<Property Map>
One or more proxy blocks as documented below.
scms List<Property Map>
One or more scm blocks as documented below.

ServiceHostnameConfigurationDeveloperPortal
, ServiceHostnameConfigurationDeveloperPortalArgs

HostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

CertificateSource string
The source of the certificate.
CertificateStatus string
The status of the certificate.
Expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
KeyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

NegotiateClientCertificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
SslKeyvaultIdentityClientId string

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

Subject string
The subject of the certificate.
Thumbprint string
The thumbprint of the certificate.
HostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

CertificateSource string
The source of the certificate.
CertificateStatus string
The status of the certificate.
Expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
KeyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

NegotiateClientCertificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
SslKeyvaultIdentityClientId string

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

Subject string
The subject of the certificate.
Thumbprint string
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource String
The source of the certificate.
certificateStatus String
The status of the certificate.
expiry String
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId String

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate Boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId String

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject String
The subject of the certificate.
thumbprint String
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource string
The source of the certificate.
certificateStatus string
The status of the certificate.
expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId string

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject string
The subject of the certificate.
thumbprint string
The thumbprint of the certificate.
host_name This property is required. str
The Hostname to use for the Management API.
certificate str
The Base64 Encoded Certificate.
certificate_password str

The password associated with the certificate provided above.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificate_source str
The source of the certificate.
certificate_status str
The status of the certificate.
expiry str
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
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.

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiate_client_certificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
ssl_keyvault_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.

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject str
The subject of the certificate.
thumbprint str
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource String
The source of the certificate.
certificateStatus String
The status of the certificate.
expiry String
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId String

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate Boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId String

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject String
The subject of the certificate.
thumbprint String
The thumbprint of the certificate.

ServiceHostnameConfigurationManagement
, ServiceHostnameConfigurationManagementArgs

HostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

CertificateSource string
The source of the certificate.
CertificateStatus string
The status of the certificate.
Expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
KeyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

NegotiateClientCertificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
SslKeyvaultIdentityClientId string

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

Subject string
The subject of the certificate.
Thumbprint string
The thumbprint of the certificate.
HostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

CertificateSource string
The source of the certificate.
CertificateStatus string
The status of the certificate.
Expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
KeyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

NegotiateClientCertificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
SslKeyvaultIdentityClientId string

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

Subject string
The subject of the certificate.
Thumbprint string
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource String
The source of the certificate.
certificateStatus String
The status of the certificate.
expiry String
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId String

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate Boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId String

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject String
The subject of the certificate.
thumbprint String
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource string
The source of the certificate.
certificateStatus string
The status of the certificate.
expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId string

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject string
The subject of the certificate.
thumbprint string
The thumbprint of the certificate.
host_name This property is required. str
The Hostname to use for the Management API.
certificate str
The Base64 Encoded Certificate.
certificate_password str

The password associated with the certificate provided above.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificate_source str
The source of the certificate.
certificate_status str
The status of the certificate.
expiry str
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
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.

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiate_client_certificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
ssl_keyvault_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.

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject str
The subject of the certificate.
thumbprint str
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource String
The source of the certificate.
certificateStatus String
The status of the certificate.
expiry String
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId String

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate Boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId String

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject String
The subject of the certificate.
thumbprint String
The thumbprint of the certificate.

ServiceHostnameConfigurationPortal
, ServiceHostnameConfigurationPortalArgs

HostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

CertificateSource string
The source of the certificate.
CertificateStatus string
The status of the certificate.
Expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
KeyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

NegotiateClientCertificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
SslKeyvaultIdentityClientId string

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

Subject string
The subject of the certificate.
Thumbprint string
The thumbprint of the certificate.
HostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

CertificateSource string
The source of the certificate.
CertificateStatus string
The status of the certificate.
Expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
KeyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

NegotiateClientCertificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
SslKeyvaultIdentityClientId string

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

Subject string
The subject of the certificate.
Thumbprint string
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource String
The source of the certificate.
certificateStatus String
The status of the certificate.
expiry String
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId String

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate Boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId String

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject String
The subject of the certificate.
thumbprint String
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource string
The source of the certificate.
certificateStatus string
The status of the certificate.
expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId string

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject string
The subject of the certificate.
thumbprint string
The thumbprint of the certificate.
host_name This property is required. str
The Hostname to use for the Management API.
certificate str
The Base64 Encoded Certificate.
certificate_password str

The password associated with the certificate provided above.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificate_source str
The source of the certificate.
certificate_status str
The status of the certificate.
expiry str
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
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.

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiate_client_certificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
ssl_keyvault_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.

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject str
The subject of the certificate.
thumbprint str
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource String
The source of the certificate.
certificateStatus String
The status of the certificate.
expiry String
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId String

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate Boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId String

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject String
The subject of the certificate.
thumbprint String
The thumbprint of the certificate.

ServiceHostnameConfigurationProxy
, ServiceHostnameConfigurationProxyArgs

HostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

CertificateSource string
The source of the certificate.
CertificateStatus string
The status of the certificate.
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.
Expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
KeyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

NegotiateClientCertificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
SslKeyvaultIdentityClientId string
The Managed Identity Client ID to use to access the Key Vault. This Identity must be specified in the identity block to be used.
Subject string
The subject of the certificate.
Thumbprint string
The thumbprint of the certificate.
HostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

CertificateSource string
The source of the certificate.
CertificateStatus string
The status of the certificate.
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.
Expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
KeyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

NegotiateClientCertificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
SslKeyvaultIdentityClientId string
The Managed Identity Client ID to use to access the Key Vault. This Identity must be specified in the identity block to be used.
Subject string
The subject of the certificate.
Thumbprint string
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource String
The source of the certificate.
certificateStatus String
The status of the certificate.
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.
expiry String
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId String

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate Boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId String
The Managed Identity Client ID to use to access the Key Vault. This Identity must be specified in the identity block to be used.
subject String
The subject of the certificate.
thumbprint String
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource string
The source of the certificate.
certificateStatus string
The status of the certificate.
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.
expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId string
The Managed Identity Client ID to use to access the Key Vault. This Identity must be specified in the identity block to be used.
subject string
The subject of the certificate.
thumbprint string
The thumbprint of the certificate.
host_name This property is required. str
The Hostname to use for the Management API.
certificate str
The Base64 Encoded Certificate.
certificate_password str

The password associated with the certificate provided above.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificate_source str
The source of the certificate.
certificate_status str
The status of the certificate.
default_ssl_binding 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.
expiry str
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
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.

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiate_client_certificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
ssl_keyvault_identity_client_id str
The Managed Identity Client ID to use to access the Key Vault. This Identity must be specified in the identity block to be used.
subject str
The subject of the certificate.
thumbprint str
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource String
The source of the certificate.
certificateStatus String
The status of the certificate.
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.
expiry String
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId String

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate Boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId String
The Managed Identity Client ID to use to access the Key Vault. This Identity must be specified in the identity block to be used.
subject String
The subject of the certificate.
thumbprint String
The thumbprint of the certificate.

ServiceHostnameConfigurationScm
, ServiceHostnameConfigurationScmArgs

HostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

CertificateSource string
The source of the certificate.
CertificateStatus string
The status of the certificate.
Expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
KeyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

NegotiateClientCertificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
SslKeyvaultIdentityClientId string

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

Subject string
The subject of the certificate.
Thumbprint string
The thumbprint of the certificate.
HostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

CertificateSource string
The source of the certificate.
CertificateStatus string
The status of the certificate.
Expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
KeyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

NegotiateClientCertificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
SslKeyvaultIdentityClientId string

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

Subject string
The subject of the certificate.
Thumbprint string
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource String
The source of the certificate.
certificateStatus String
The status of the certificate.
expiry String
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId String

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate Boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId String

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject String
The subject of the certificate.
thumbprint String
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource string
The source of the certificate.
certificateStatus string
The status of the certificate.
expiry string
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId string

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId string

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject string
The subject of the certificate.
thumbprint string
The thumbprint of the certificate.
host_name This property is required. str
The Hostname to use for the Management API.
certificate str
The Base64 Encoded Certificate.
certificate_password str

The password associated with the certificate provided above.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificate_source str
The source of the certificate.
certificate_status str
The status of the certificate.
expiry str
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
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.

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiate_client_certificate bool
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
ssl_keyvault_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.

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject str
The subject of the certificate.
thumbprint str
The thumbprint of the certificate.
hostName This property is required. 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.

NOTE: Either key_vault_id or certificate and certificate_password must be specified.

certificateSource String
The source of the certificate.
certificateStatus String
The status of the certificate.
expiry String
The expiration date of the certificate in RFC3339 format: 2000-01-02T03:04:05Z.
keyVaultId String

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

NOTE: Setting this field requires the identity block to be specified, since this identity is used for to retrieve the Key Vault Certificate. Possible values are versioned or versionless secret ID. Auto-updating the Certificate from the Key Vault requires the Secret version isn't specified.

negotiateClientCertificate Boolean
Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.
sslKeyvaultIdentityClientId String

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

NOTE: If a User Assigned Managed identity is specified for ssl_keyvault_identity_client_id then this identity must be associated to the azure.apimanagement.Service within an identity block.

subject String
The subject of the certificate.
thumbprint String
The thumbprint of the certificate.

ServiceIdentity
, ServiceIdentityArgs

Type This property is required. string
Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
IdentityIds List<string>

A list of User Assigned Managed Identity IDs to be assigned to this API Management Service.

NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

PrincipalId string
The Principal ID associated with this Managed Service Identity.
TenantId string
The identifier for the tenant access information contract.
Type This property is required. string
Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
IdentityIds []string

A list of User Assigned Managed Identity IDs to be assigned to this API Management Service.

NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

PrincipalId string
The Principal ID associated with this Managed Service Identity.
TenantId string
The identifier for the tenant access information contract.
type This property is required. String
Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
identityIds List<String>

A list of User Assigned Managed Identity IDs to be assigned to this API Management Service.

NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

principalId String
The Principal ID associated with this Managed Service Identity.
tenantId String
The identifier for the tenant access information contract.
type This property is required. string
Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
identityIds string[]

A list of User Assigned Managed Identity IDs to be assigned to this API Management Service.

NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

principalId string
The Principal ID associated with this Managed Service Identity.
tenantId string
The identifier for the tenant access information contract.
type This property is required. str
Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
identity_ids Sequence[str]

A list of User Assigned Managed Identity IDs to be assigned to this API Management Service.

NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

principal_id str
The Principal ID associated with this Managed Service Identity.
tenant_id str
The identifier for the tenant access information contract.
type This property is required. String
Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned, SystemAssigned, UserAssigned (to enable both).
identityIds List<String>

A list of User Assigned Managed Identity IDs to be assigned to this API Management Service.

NOTE: This is required when type is set to UserAssigned or SystemAssigned, UserAssigned.

principalId String
The Principal ID associated with this Managed Service Identity.
tenantId String
The identifier for the tenant access information contract.

ServiceProtocols
, ServiceProtocolsArgs

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.
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.
enableHttp2 Boolean
Should HTTP/2 be supported by the API Management Service? Defaults to false.

ServiceSecurity
, ServiceSecurityArgs

EnableBackendSsl30 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30 field

EnableBackendTls10 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 field

EnableBackendTls11 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 field

EnableFrontendSsl30 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30 field

EnableFrontendTls10 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 field

EnableFrontendTls11 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 field

TlsEcdheEcdsaWithAes128CbcShaCiphersEnabled bool

Should the TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA field

TlsEcdheEcdsaWithAes256CbcShaCiphersEnabled bool

Should the TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA field

TlsEcdheRsaWithAes128CbcShaCiphersEnabled bool

Should the TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA field

TlsEcdheRsaWithAes256CbcShaCiphersEnabled bool

Should the TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA field

TlsRsaWithAes128CbcSha256CiphersEnabled bool

Should the TLS_RSA_WITH_AES_128_CBC_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256 field

TlsRsaWithAes128CbcShaCiphersEnabled bool

Should the TLS_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA field

TlsRsaWithAes128GcmSha256CiphersEnabled bool

Should the TLS_RSA_WITH_AES_128_GCM_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256 field

TlsRsaWithAes256CbcSha256CiphersEnabled bool

Should the TLS_RSA_WITH_AES_256_CBC_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256 field

TlsRsaWithAes256CbcShaCiphersEnabled bool

Should the TLS_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA field

TlsRsaWithAes256GcmSha384CiphersEnabled bool

Should the TLS_RSA_WITH_AES_256_GCM_SHA384 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_GCM_SHA384 field

TripleDesCiphersEnabled bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 field

EnableBackendSsl30 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30 field

EnableBackendTls10 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 field

EnableBackendTls11 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 field

EnableFrontendSsl30 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30 field

EnableFrontendTls10 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 field

EnableFrontendTls11 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 field

TlsEcdheEcdsaWithAes128CbcShaCiphersEnabled bool

Should the TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA field

TlsEcdheEcdsaWithAes256CbcShaCiphersEnabled bool

Should the TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA field

TlsEcdheRsaWithAes128CbcShaCiphersEnabled bool

Should the TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA field

TlsEcdheRsaWithAes256CbcShaCiphersEnabled bool

Should the TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA field

TlsRsaWithAes128CbcSha256CiphersEnabled bool

Should the TLS_RSA_WITH_AES_128_CBC_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256 field

TlsRsaWithAes128CbcShaCiphersEnabled bool

Should the TLS_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA field

TlsRsaWithAes128GcmSha256CiphersEnabled bool

Should the TLS_RSA_WITH_AES_128_GCM_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256 field

TlsRsaWithAes256CbcSha256CiphersEnabled bool

Should the TLS_RSA_WITH_AES_256_CBC_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256 field

TlsRsaWithAes256CbcShaCiphersEnabled bool

Should the TLS_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA field

TlsRsaWithAes256GcmSha384CiphersEnabled bool

Should the TLS_RSA_WITH_AES_256_GCM_SHA384 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_GCM_SHA384 field

TripleDesCiphersEnabled bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 field

enableBackendSsl30 Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30 field

enableBackendTls10 Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 field

enableBackendTls11 Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 field

enableFrontendSsl30 Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30 field

enableFrontendTls10 Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 field

enableFrontendTls11 Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 field

tlsEcdheEcdsaWithAes128CbcShaCiphersEnabled Boolean

Should the TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA field

tlsEcdheEcdsaWithAes256CbcShaCiphersEnabled Boolean

Should the TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA field

tlsEcdheRsaWithAes128CbcShaCiphersEnabled Boolean

Should the TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA field

tlsEcdheRsaWithAes256CbcShaCiphersEnabled Boolean

Should the TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA field

tlsRsaWithAes128CbcSha256CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_128_CBC_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256 field

tlsRsaWithAes128CbcShaCiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA field

tlsRsaWithAes128GcmSha256CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_128_GCM_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256 field

tlsRsaWithAes256CbcSha256CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_256_CBC_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256 field

tlsRsaWithAes256CbcShaCiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA field

tlsRsaWithAes256GcmSha384CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_256_GCM_SHA384 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_GCM_SHA384 field

tripleDesCiphersEnabled Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 field

enableBackendSsl30 boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30 field

enableBackendTls10 boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 field

enableBackendTls11 boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 field

enableFrontendSsl30 boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30 field

enableFrontendTls10 boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 field

enableFrontendTls11 boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 field

tlsEcdheEcdsaWithAes128CbcShaCiphersEnabled boolean

Should the TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA field

tlsEcdheEcdsaWithAes256CbcShaCiphersEnabled boolean

Should the TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA field

tlsEcdheRsaWithAes128CbcShaCiphersEnabled boolean

Should the TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA field

tlsEcdheRsaWithAes256CbcShaCiphersEnabled boolean

Should the TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA field

tlsRsaWithAes128CbcSha256CiphersEnabled boolean

Should the TLS_RSA_WITH_AES_128_CBC_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256 field

tlsRsaWithAes128CbcShaCiphersEnabled boolean

Should the TLS_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA field

tlsRsaWithAes128GcmSha256CiphersEnabled boolean

Should the TLS_RSA_WITH_AES_128_GCM_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256 field

tlsRsaWithAes256CbcSha256CiphersEnabled boolean

Should the TLS_RSA_WITH_AES_256_CBC_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256 field

tlsRsaWithAes256CbcShaCiphersEnabled boolean

Should the TLS_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA field

tlsRsaWithAes256GcmSha384CiphersEnabled boolean

Should the TLS_RSA_WITH_AES_256_GCM_SHA384 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_GCM_SHA384 field

tripleDesCiphersEnabled boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 field

enable_backend_ssl30 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30 field

enable_backend_tls10 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 field

enable_backend_tls11 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 field

enable_frontend_ssl30 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30 field

enable_frontend_tls10 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 field

enable_frontend_tls11 bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 field

tls_ecdhe_ecdsa_with_aes128_cbc_sha_ciphers_enabled bool

Should the TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA field

tls_ecdhe_ecdsa_with_aes256_cbc_sha_ciphers_enabled bool

Should the TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA field

tls_ecdhe_rsa_with_aes128_cbc_sha_ciphers_enabled bool

Should the TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA field

tls_ecdhe_rsa_with_aes256_cbc_sha_ciphers_enabled bool

Should the TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA field

tls_rsa_with_aes128_cbc_sha256_ciphers_enabled bool

Should the TLS_RSA_WITH_AES_128_CBC_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256 field

tls_rsa_with_aes128_cbc_sha_ciphers_enabled bool

Should the TLS_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA field

tls_rsa_with_aes128_gcm_sha256_ciphers_enabled bool

Should the TLS_RSA_WITH_AES_128_GCM_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256 field

tls_rsa_with_aes256_cbc_sha256_ciphers_enabled bool

Should the TLS_RSA_WITH_AES_256_CBC_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256 field

tls_rsa_with_aes256_cbc_sha_ciphers_enabled bool

Should the TLS_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA field

tls_rsa_with_aes256_gcm_sha384_ciphers_enabled bool

Should the TLS_RSA_WITH_AES_256_GCM_SHA384 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_GCM_SHA384 field

triple_des_ciphers_enabled bool

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 field

enableBackendSsl30 Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30 field

enableBackendTls10 Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 field

enableBackendTls11 Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 field

enableFrontendSsl30 Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30 field

enableFrontendTls10 Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 field

enableFrontendTls11 Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 field

tlsEcdheEcdsaWithAes128CbcShaCiphersEnabled Boolean

Should the TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA field

tlsEcdheEcdsaWithAes256CbcShaCiphersEnabled Boolean

Should the TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA field

tlsEcdheRsaWithAes128CbcShaCiphersEnabled Boolean

Should the TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA field

tlsEcdheRsaWithAes256CbcShaCiphersEnabled Boolean

Should the TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA field

tlsRsaWithAes128CbcSha256CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_128_CBC_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256 field

tlsRsaWithAes128CbcShaCiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA field

tlsRsaWithAes128GcmSha256CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_128_GCM_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_GCM_SHA256 field

tlsRsaWithAes256CbcSha256CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_256_CBC_SHA256 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA256 field

tlsRsaWithAes256CbcShaCiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_CBC_SHA field

tlsRsaWithAes256GcmSha384CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_256_GCM_SHA384 cipher be enabled? Defaults to false.

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_256_GCM_SHA384 field

tripleDesCiphersEnabled Boolean

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

info: This maps to the Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 field

ServiceSignIn
, ServiceSignInArgs

Enabled This property is required. bool
Should anonymous users be redirected to the sign in page?
Enabled This property is required. bool
Should anonymous users be redirected to the sign in page?
enabled This property is required. Boolean
Should anonymous users be redirected to the sign in page?
enabled This property is required. boolean
Should anonymous users be redirected to the sign in page?
enabled This property is required. bool
Should anonymous users be redirected to the sign in page?
enabled This property is required. Boolean
Should anonymous users be redirected to the sign in page?

ServiceSignUp
, ServiceSignUpArgs

Enabled This property is required. bool
Can users sign up on the development portal?
TermsOfService This property is required. ServiceSignUpTermsOfService
A terms_of_service block as defined below.
Enabled This property is required. bool
Can users sign up on the development portal?
TermsOfService This property is required. ServiceSignUpTermsOfService
A terms_of_service block as defined below.
enabled This property is required. Boolean
Can users sign up on the development portal?
termsOfService This property is required. ServiceSignUpTermsOfService
A terms_of_service block as defined below.
enabled This property is required. boolean
Can users sign up on the development portal?
termsOfService This property is required. ServiceSignUpTermsOfService
A terms_of_service block as defined below.
enabled This property is required. bool
Can users sign up on the development portal?
terms_of_service This property is required. ServiceSignUpTermsOfService
A terms_of_service block as defined below.
enabled This property is required. Boolean
Can users sign up on the development portal?
termsOfService This property is required. Property Map
A terms_of_service block as defined below.

ServiceSignUpTermsOfService
, ServiceSignUpTermsOfServiceArgs

ConsentRequired This property is required. bool
Should the user be asked for consent during sign up?
Enabled This property is required. 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 This property is required. bool
Should the user be asked for consent during sign up?
Enabled This property is required. 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 This property is required. Boolean
Should the user be asked for consent during sign up?
enabled This property is required. 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 This property is required. boolean
Should the user be asked for consent during sign up?
enabled This property is required. 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.
consent_required This property is required. bool
Should the user be asked for consent during sign up?
enabled This property is required. 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.
consentRequired This property is required. Boolean
Should the user be asked for consent during sign up?
enabled This property is required. 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.

ServiceTenantAccess
, ServiceTenantAccessArgs

Enabled This property is required. bool
Should the access to the management API be enabled?
PrimaryKey string
Primary access key for the tenant access information contract.
SecondaryKey string
Secondary access key for the tenant access information contract.
TenantId string
The identifier for the tenant access information contract.
Enabled This property is required. bool
Should the access to the management API be enabled?
PrimaryKey string
Primary access key for the tenant access information contract.
SecondaryKey string
Secondary access key for the tenant access information contract.
TenantId string
The identifier for the tenant access information contract.
enabled This property is required. Boolean
Should the access to the management API be enabled?
primaryKey String
Primary access key for the tenant access information contract.
secondaryKey String
Secondary access key for the tenant access information contract.
tenantId String
The identifier for the tenant access information contract.
enabled This property is required. boolean
Should the access to the management API be enabled?
primaryKey string
Primary access key for the tenant access information contract.
secondaryKey string
Secondary access key for the tenant access information contract.
tenantId string
The identifier for the tenant access information contract.
enabled This property is required. bool
Should the access to the management API be enabled?
primary_key str
Primary access key for the tenant access information contract.
secondary_key str
Secondary access key for the tenant access information contract.
tenant_id str
The identifier for the tenant access information contract.
enabled This property is required. Boolean
Should the access to the management API be enabled?
primaryKey String
Primary access key for the tenant access information contract.
secondaryKey String
Secondary access key for the tenant access information contract.
tenantId String
The identifier for the tenant access information contract.

ServiceVirtualNetworkConfiguration
, ServiceVirtualNetworkConfigurationArgs

SubnetId This property is required. string
The id of the subnet that will be used for the API Management.
SubnetId This property is required. string
The id of the subnet that will be used for the API Management.
subnetId This property is required. String
The id of the subnet that will be used for the API Management.
subnetId This property is required. string
The id of the subnet that will be used for the API Management.
subnet_id This property is required. str
The id of the subnet that will be used for the API Management.
subnetId This property is required. String
The id of the subnet that will be used for the API Management.

Import

API Management Services can be imported using the resource id, e.g.

$ pulumi import azure:apimanagement/service:Service example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure