Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.5.0 published on Wednesday, May 4, 2022 by Pulumi

Service

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

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleService = new Azure.ApiManagement.Service("exampleService", new Azure.ApiManagement.ServiceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            PublisherName = "My Company",
            PublisherEmail = "company@exmaple.com",
            SkuName = "Developer_1",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			PublisherName:     pulumi.String("My Company"),
			PublisherEmail:    pulumi.String("company@exmaple.com"),
			SkuName:           pulumi.String("Developer_1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

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

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

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

        var exampleService = new Service("exampleService", ServiceArgs.builder()        
            .location(exampleResourceGroup.getLocation())
            .resourceGroupName(exampleResourceGroup.getName())
            .publisherName("My Company")
            .publisherEmail("company@exmaple.com")
            .skuName("Developer_1")
            .build());

        }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@exmaple.com",
    sku_name="Developer_1")
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@exmaple.com",
    skuName: "Developer_1",
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleService:
    type: azure:apimanagement:Service
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      publisherName: My Company
      publisherEmail: company@exmaple.com
      skuName: Developer_1

Create a Service Resource

new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            additional_locations: Optional[Sequence[ServiceAdditionalLocationArgs]] = None,
            certificates: Optional[Sequence[ServiceCertificateArgs]] = None,
            client_certificate_enabled: Optional[bool] = None,
            gateway_disabled: Optional[bool] = None,
            hostname_configuration: Optional[ServiceHostnameConfigurationArgs] = 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,
            policy: Optional[ServicePolicyArgs] = None,
            protocols: Optional[ServiceProtocolsArgs] = None,
            public_ip_address_id: Optional[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,
            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)
@overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args ServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args ServiceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ServiceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Service Resource Properties

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

Inputs

The Service resource accepts the following input properties:

PublisherEmail string

The email of publisher/company.

PublisherName string

The name of publisher/company.

ResourceGroupName string

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

SkuName string

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

AdditionalLocations List<ServiceAdditionalLocationArgs>

One or more additional_location blocks as defined below.

Certificates List<ServiceCertificateArgs>

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

ClientCertificateEnabled bool

Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.

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

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

NotificationSenderEmail string

Email address from which the notification will be sent.

Policy ServicePolicyArgs

A policy block as defined below.

Protocols ServiceProtocolsArgs

A protocols block as defined below.

PublicIpAddressId string

ID of a standard SKU IPv4 Public IP.

PublicNetworkAccessEnabled bool

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

Security ServiceSecurityArgs

A security block as defined below.

SignIn ServiceSignInArgs

A sign_in block as defined below.

SignUp ServiceSignUpArgs

A sign_up block as defined below.

Tags Dictionary<string, string>

A mapping of tags assigned to the resource.

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.

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. Changing this forces a new API Management service to be created.

PublisherEmail string

The email of publisher/company.

PublisherName string

The name of publisher/company.

ResourceGroupName string

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

SkuName string

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

AdditionalLocations []ServiceAdditionalLocationArgs

One or more additional_location blocks as defined below.

Certificates []ServiceCertificateArgs

One or more (up to 10) certificate blocks 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.

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

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

NotificationSenderEmail string

Email address from which the notification will be sent.

Policy ServicePolicyArgs

A policy block as defined below.

Protocols ServiceProtocolsArgs

A protocols block as defined below.

PublicIpAddressId string

ID of a standard SKU IPv4 Public IP.

PublicNetworkAccessEnabled bool

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

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.

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. Changing this forces a new API Management service to be created.

publisherEmail String

The email of publisher/company.

publisherName String

The name of publisher/company.

resourceGroupName String

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

skuName String

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

additionalLocations ListAdditionalLocationArgs>

One or more additional_location blocks as defined below.

certificates ListCertificateArgs>

One or more (up to 10) certificate blocks 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.

gatewayDisabled Boolean

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

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

notificationSenderEmail String

Email address from which the notification will be sent.

policy ServicePolicyArgs

A policy block as defined below.

protocols ServiceProtocolsArgs

A protocols block as defined below.

publicIpAddressId String

ID of a standard SKU IPv4 Public IP.

publicNetworkAccessEnabled Boolean

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

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

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.

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

Specifies a list of Availability Zones in which this API Management service should be located. Changing this forces a new API Management service to be created.

publisherEmail string

The email of publisher/company.

publisherName string

The name of publisher/company.

resourceGroupName string

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

skuName string

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

additionalLocations ServiceAdditionalLocationArgs[]

One or more additional_location blocks as defined below.

certificates ServiceCertificateArgs[]

One or more (up to 10) certificate blocks 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.

gatewayDisabled boolean

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

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

notificationSenderEmail string

Email address from which the notification will be sent.

policy ServicePolicyArgs

A policy block as defined below.

protocols ServiceProtocolsArgs

A protocols block as defined below.

publicIpAddressId string

ID of a standard SKU IPv4 Public IP.

publicNetworkAccessEnabled boolean

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

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 {[key: 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.

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. Changing this forces a new API Management service to be created.

publisher_email str

The email of publisher/company.

publisher_name str

The name of publisher/company.

resource_group_name str

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

sku_name str

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

additional_locations Sequence[ServiceAdditionalLocationArgs]

One or more additional_location blocks as defined below.

certificates Sequence[ServiceCertificateArgs]

One or more (up to 10) certificate blocks 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.

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

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

notification_sender_email str

Email address from which the notification will be sent.

policy ServicePolicyArgs

A policy block as defined below.

protocols ServiceProtocolsArgs

A protocols block as defined below.

public_ip_address_id str

ID of a standard SKU IPv4 Public IP.

public_network_access_enabled bool

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

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.

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. Changing this forces a new API Management service to be created.

publisherEmail String

The email of publisher/company.

publisherName String

The name of publisher/company.

resourceGroupName String

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

skuName String

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

additionalLocations List

One or more additional_location blocks as defined below.

certificates List

One or more (up to 10) certificate blocks 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.

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

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

notificationSenderEmail String

Email address from which the notification will be sent.

policy Property Map

A policy block as defined below.

protocols Property Map

A protocols block as defined below.

publicIpAddressId String

ID of a standard SKU IPv4 Public IP.

publicNetworkAccessEnabled Boolean

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

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

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.

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

Specifies a list of Availability Zones in which this API Management service should be located. Changing this forces a new API Management service to be created.

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

The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.

publicIpAddresses List

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

The Private IP addresses of the API Management Service. Available only when the API Manager instance is using Virtual Network mode.

publicIpAddresses List

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 an Existing Service Resource

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

public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): Service
@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,
        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,
        policy: Optional[ServicePolicyArgs] = 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)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AdditionalLocations List<ServiceAdditionalLocationArgs>

One or more additional_location blocks as defined below.

Certificates List<ServiceCertificateArgs>

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

ClientCertificateEnabled bool

Enforce a client certificate to be presented on each request to the gateway? This is only supported when SKU type is Consumption.

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

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

NotificationSenderEmail string

Email address from which the notification will be sent.

Policy ServicePolicyArgs

A policy block as defined below.

PortalUrl string

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

PrivateIpAddresses List<string>

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.

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

PublisherEmail string

The email of publisher/company.

PublisherName string

The name of publisher/company.

ResourceGroupName string

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

ScmUrl string

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

Security ServiceSecurityArgs

A security block as defined below.

SignIn ServiceSignInArgs

A sign_in block as defined below.

SignUp ServiceSignUpArgs

A sign_up block as defined below.

SkuName string

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

Tags Dictionary<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.

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. Changing this forces a new API Management service to be created.

AdditionalLocations []ServiceAdditionalLocationArgs

One or more additional_location blocks as defined below.

Certificates []ServiceCertificateArgs

One or more (up to 10) certificate blocks 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.

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

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

NotificationSenderEmail string

Email address from which the notification will be sent.

Policy ServicePolicyArgs

A policy block as defined below.

PortalUrl string

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

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

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

PublisherEmail string

The email of publisher/company.

PublisherName string

The name of publisher/company.

ResourceGroupName string

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

ScmUrl string

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

Security ServiceSecurityArgs

A security block as defined below.

SignIn ServiceSignInArgs

A sign_in block as defined below.

SignUp ServiceSignUpArgs

A sign_up block as defined below.

SkuName string

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

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.

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. Changing this forces a new API Management service to be created.

additionalLocations ListAdditionalLocationArgs>

One or more additional_location blocks as defined below.

certificates ListCertificateArgs>

One or more (up to 10) certificate blocks 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.

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 ServiceHostnameConfigurationArgs

A hostname_configuration block as defined below.

identity ServiceIdentityArgs

An identity block as defined below.

location String

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

managementApiUrl String

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

minApiVersion String

The version which the control plane API calls to API Management service are limited with version equal to or newer than.

name String

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

notificationSenderEmail String

Email address from which the notification will be sent.

policy ServicePolicyArgs

A policy block as defined below.

portalUrl String

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

privateIpAddresses List

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.

publicIpAddresses List

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

publisherEmail String

The email of publisher/company.

publisherName String

The name of publisher/company.

resourceGroupName String

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

scmUrl String

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

security ServiceSecurityArgs

A security block as defined below.

signIn ServiceSignInArgs

A sign_in block as defined below.

signUp ServiceSignUpArgs

A sign_up block as defined below.

skuName String

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

tags Map

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.

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

Specifies a list of Availability Zones in which this API Management service should be located. Changing this forces a new API Management service to be created.

additionalLocations ServiceAdditionalLocationArgs[]

One or more additional_location blocks as defined below.

certificates ServiceCertificateArgs[]

One or more (up to 10) certificate blocks 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.

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 ServiceHostnameConfigurationArgs

A hostname_configuration block as defined below.

identity ServiceIdentityArgs

An identity block as defined below.

location string

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

managementApiUrl string

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

minApiVersion string

The version which the control plane API calls to API Management service are limited with version equal to or newer than.

name string

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

notificationSenderEmail string

Email address from which the notification will be sent.

policy ServicePolicyArgs

A policy block as defined below.

portalUrl string

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

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

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

publisherEmail string

The email of publisher/company.

publisherName string

The name of publisher/company.

resourceGroupName string

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

scmUrl string

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

security ServiceSecurityArgs

A security block as defined below.

signIn ServiceSignInArgs

A sign_in block as defined below.

signUp ServiceSignUpArgs

A sign_up block as defined below.

skuName string

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

tags {[key: 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.

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. Changing this forces a new API Management service to be created.

additional_locations Sequence[ServiceAdditionalLocationArgs]

One or more additional_location blocks as defined below.

certificates Sequence[ServiceCertificateArgs]

One or more (up to 10) certificate blocks 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.

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

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

notification_sender_email str

Email address from which the notification will be sent.

policy ServicePolicyArgs

A policy block as defined below.

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.

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

publisher_email str

The email of publisher/company.

publisher_name str

The name of publisher/company.

resource_group_name str

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

scm_url str

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

security 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).

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.

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. Changing this forces a new API Management service to be created.

additionalLocations List

One or more additional_location blocks as defined below.

certificates List

One or more (up to 10) certificate blocks 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.

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

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

notificationSenderEmail String

Email address from which the notification will be sent.

policy Property Map

A policy block as defined below.

portalUrl String

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

privateIpAddresses List

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.

publicIpAddresses List

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

publisherEmail String

The email of publisher/company.

publisherName String

The name of publisher/company.

resourceGroupName String

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

scmUrl String

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

security 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).

tags Map

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.

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

Specifies a list of Availability Zones in which this API Management service should be located. Changing this forces a new API Management service to be created.

Supporting Types

ServiceAdditionalLocation

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

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.

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

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.

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

gatewayRegionalUrl String

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

privateIpAddresses List

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.

publicIpAddresses List

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

A list of availability zones.

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

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.

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

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

gatewayRegionalUrl String

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

privateIpAddresses List

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.

publicIpAddresses List

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

A list of availability zones.

ServiceAdditionalLocationVirtualNetworkConfiguration

SubnetId string

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

SubnetId string

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

subnetId String

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

subnetId string

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

subnet_id str

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

subnetId String

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

ServiceCertificate

EncodedCertificate string

The Base64 Encoded PFX or Base64 Encoded X.509 Certificate.

StoreName string

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

CertificatePassword string

The password for the certificate.

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 string

The Base64 Encoded PFX or Base64 Encoded X.509 Certificate.

StoreName string

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

CertificatePassword string

The password for the certificate.

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 String

The Base64 Encoded PFX or Base64 Encoded X.509 Certificate.

storeName String

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

certificatePassword String

The password for the certificate.

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 string

The Base64 Encoded PFX or Base64 Encoded X.509 Certificate.

storeName string

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

certificatePassword string

The password for the certificate.

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 str

The Base64 Encoded PFX or Base64 Encoded X.509 Certificate.

store_name 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 String

The Base64 Encoded PFX or Base64 Encoded X.509 Certificate.

storeName String

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

certificatePassword String

The password for the certificate.

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.

ServiceHostnameConfiguration

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

One or more developer_portal blocks as documented below.

managements ListHostnameConfigurationManagement>

One or more management blocks as documented below.

portals ListHostnameConfigurationPortal>

One or more portal blocks as documented below.

proxies ListHostnameConfigurationProxy>

One or more proxy blocks as documented below.

scms ListHostnameConfigurationScm>

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

One or more developer_portal blocks as documented below.

managements List

One or more management blocks as documented below.

portals List

One or more portal blocks as documented below.

proxies List

One or more proxy blocks as documented below.

scms List

One or more scm blocks as documented below.

ServiceHostnameConfigurationDeveloperPortal

HostName string

The Hostname to use for the Management API.

Certificate string

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

CertificatePassword string

The password for the certificate.

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.

NegotiateClientCertificate bool

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

SslKeyvaultIdentityClientId string

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

Subject string

The subject of the certificate.

Thumbprint string

The thumbprint of the certificate.

HostName string

The Hostname to use for the Management API.

Certificate string

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

CertificatePassword string

The password for the certificate.

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.

NegotiateClientCertificate bool

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

SslKeyvaultIdentityClientId string

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

Subject string

The subject of the certificate.

Thumbprint string

The thumbprint of the certificate.

hostName String

The Hostname to use for the Management API.

certificate String

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

certificatePassword String

The password for the certificate.

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.

negotiateClientCertificate Boolean

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

sslKeyvaultIdentityClientId String

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject String

The subject of the certificate.

thumbprint String

The thumbprint of the certificate.

hostName string

The Hostname to use for the Management API.

certificate string

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

certificatePassword string

The password for the certificate.

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.

negotiateClientCertificate boolean

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

sslKeyvaultIdentityClientId string

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject string

The subject of the certificate.

thumbprint string

The thumbprint of the certificate.

host_name str

The Hostname to use for the Management API.

certificate str

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

certificate_password str

The password for 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.

negotiate_client_certificate bool

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

ssl_keyvault_identity_client_id str

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject str

The subject of the certificate.

thumbprint str

The thumbprint of the certificate.

hostName String

The Hostname to use for the Management API.

certificate String

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

certificatePassword String

The password for the certificate.

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.

negotiateClientCertificate Boolean

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

sslKeyvaultIdentityClientId String

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject String

The subject of the certificate.

thumbprint String

The thumbprint of the certificate.

ServiceHostnameConfigurationManagement

HostName string

The Hostname to use for the Management API.

Certificate string

The Base64 Encoded Certificate.

CertificatePassword string

The password associated with the certificate provided above.

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.

NegotiateClientCertificate bool

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

SslKeyvaultIdentityClientId string

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

Subject string

The subject of the certificate.

Thumbprint string

The thumbprint of the certificate.

HostName string

The Hostname to use for the Management API.

Certificate string

The Base64 Encoded Certificate.

CertificatePassword string

The password associated with the certificate provided above.

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.

NegotiateClientCertificate bool

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

SslKeyvaultIdentityClientId string

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

Subject string

The subject of the certificate.

Thumbprint string

The thumbprint of the certificate.

hostName String

The Hostname to use for the Management API.

certificate String

The Base64 Encoded Certificate.

certificatePassword String

The password associated with the certificate provided above.

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.

negotiateClientCertificate Boolean

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

sslKeyvaultIdentityClientId String

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject String

The subject of the certificate.

thumbprint String

The thumbprint of the certificate.

hostName string

The Hostname to use for the Management API.

certificate string

The Base64 Encoded Certificate.

certificatePassword string

The password associated with the certificate provided above.

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.

negotiateClientCertificate boolean

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

sslKeyvaultIdentityClientId string

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject string

The subject of the certificate.

thumbprint string

The thumbprint of the certificate.

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

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.

negotiate_client_certificate bool

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

ssl_keyvault_identity_client_id str

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject str

The subject of the certificate.

thumbprint str

The thumbprint of the certificate.

hostName String

The Hostname to use for the Management API.

certificate String

The Base64 Encoded Certificate.

certificatePassword String

The password associated with the certificate provided above.

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.

negotiateClientCertificate Boolean

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

sslKeyvaultIdentityClientId String

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject String

The subject of the certificate.

thumbprint String

The thumbprint of the certificate.

ServiceHostnameConfigurationPortal

HostName string

The Hostname to use for the Management API.

Certificate string

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

CertificatePassword string

The password for the certificate.

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.

NegotiateClientCertificate bool

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

SslKeyvaultIdentityClientId string

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

Subject string

The subject of the certificate.

Thumbprint string

The thumbprint of the certificate.

HostName string

The Hostname to use for the Management API.

Certificate string

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

CertificatePassword string

The password for the certificate.

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.

NegotiateClientCertificate bool

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

SslKeyvaultIdentityClientId string

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

Subject string

The subject of the certificate.

Thumbprint string

The thumbprint of the certificate.

hostName String

The Hostname to use for the Management API.

certificate String

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

certificatePassword String

The password for the certificate.

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.

negotiateClientCertificate Boolean

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

sslKeyvaultIdentityClientId String

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject String

The subject of the certificate.

thumbprint String

The thumbprint of the certificate.

hostName string

The Hostname to use for the Management API.

certificate string

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

certificatePassword string

The password for the certificate.

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.

negotiateClientCertificate boolean

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

sslKeyvaultIdentityClientId string

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject string

The subject of the certificate.

thumbprint string

The thumbprint of the certificate.

host_name str

The Hostname to use for the Management API.

certificate str

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

certificate_password str

The password for 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.

negotiate_client_certificate bool

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

ssl_keyvault_identity_client_id str

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject str

The subject of the certificate.

thumbprint str

The thumbprint of the certificate.

hostName String

The Hostname to use for the Management API.

certificate String

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

certificatePassword String

The password for the certificate.

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.

negotiateClientCertificate Boolean

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

sslKeyvaultIdentityClientId String

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject String

The subject of the certificate.

thumbprint String

The thumbprint of the certificate.

ServiceHostnameConfigurationProxy

HostName string

The Hostname to use for the Management API.

Certificate string

The Base64 Encoded Certificate.

CertificatePassword string

The password associated with the certificate provided above.

DefaultSslBinding bool

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

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.

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 string

The Hostname to use for the Management API.

Certificate string

The Base64 Encoded Certificate.

CertificatePassword string

The password associated with the certificate provided above.

DefaultSslBinding bool

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

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.

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 String

The Hostname to use for the Management API.

certificate String

The Base64 Encoded Certificate.

certificatePassword String

The password associated with the certificate provided above.

defaultSslBinding Boolean

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

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.

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 string

The Hostname to use for the Management API.

certificate string

The Base64 Encoded Certificate.

certificatePassword string

The password associated with the certificate provided above.

defaultSslBinding boolean

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

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.

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

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.

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 String

The Hostname to use for the Management API.

certificate String

The Base64 Encoded Certificate.

certificatePassword String

The password associated with the certificate provided above.

defaultSslBinding Boolean

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

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.

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

HostName string

The Hostname to use for the Management API.

Certificate string

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

CertificatePassword string

The password for the certificate.

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.

NegotiateClientCertificate bool

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

SslKeyvaultIdentityClientId string

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

Subject string

The subject of the certificate.

Thumbprint string

The thumbprint of the certificate.

HostName string

The Hostname to use for the Management API.

Certificate string

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

CertificatePassword string

The password for the certificate.

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.

NegotiateClientCertificate bool

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

SslKeyvaultIdentityClientId string

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

Subject string

The subject of the certificate.

Thumbprint string

The thumbprint of the certificate.

hostName String

The Hostname to use for the Management API.

certificate String

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

certificatePassword String

The password for the certificate.

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.

negotiateClientCertificate Boolean

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

sslKeyvaultIdentityClientId String

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject String

The subject of the certificate.

thumbprint String

The thumbprint of the certificate.

hostName string

The Hostname to use for the Management API.

certificate string

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

certificatePassword string

The password for the certificate.

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.

negotiateClientCertificate boolean

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

sslKeyvaultIdentityClientId string

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject string

The subject of the certificate.

thumbprint string

The thumbprint of the certificate.

host_name str

The Hostname to use for the Management API.

certificate str

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

certificate_password str

The password for 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.

negotiate_client_certificate bool

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

ssl_keyvault_identity_client_id str

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject str

The subject of the certificate.

thumbprint str

The thumbprint of the certificate.

hostName String

The Hostname to use for the Management API.

certificate String

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

certificatePassword String

The password for the certificate.

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.

negotiateClientCertificate Boolean

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

sslKeyvaultIdentityClientId String

The client id of the System or User Assigned Managed identity generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.

subject String

The subject of the certificate.

thumbprint String

The thumbprint of the certificate.

ServiceIdentity

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

PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The identifier for the tenant access information contract.

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

PrincipalId string

The Principal ID associated with this Managed Service Identity.

TenantId string

The identifier for the tenant access information contract.

type 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

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

principalId String

The Principal ID associated with this Managed Service Identity.

tenantId String

The identifier for the tenant access information contract.

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

principalId string

The Principal ID associated with this Managed Service Identity.

tenantId string

The identifier for the tenant access information contract.

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

principal_id str

The Principal ID associated with this Managed Service Identity.

tenant_id str

The identifier for the tenant access information contract.

type 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

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

principalId String

The Principal ID associated with this Managed Service Identity.

tenantId String

The identifier for the tenant access information contract.

ServicePolicy

XmlContent string

The XML Content for this Policy.

XmlLink string

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

XmlContent string

The XML Content for this Policy.

XmlLink string

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

xmlContent String

The XML Content for this Policy.

xmlLink String

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

xmlContent string

The XML Content for this Policy.

xmlLink string

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

xml_content str

The XML Content for this Policy.

xml_link str

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

xmlContent String

The XML Content for this Policy.

xmlLink String

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

ServiceProtocols

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

EnableBackendSsl30 bool

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

EnableBackendTls10 bool

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

EnableBackendTls11 bool

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

EnableFrontendSsl30 bool

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

EnableFrontendTls10 bool

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

EnableFrontendTls11 bool

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

TlsEcdheEcdsaWithAes128CbcShaCiphersEnabled bool

Should the TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

TlsEcdheEcdsaWithAes256CbcShaCiphersEnabled bool

Should the TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

TlsEcdheRsaWithAes128CbcShaCiphersEnabled bool
TlsEcdheRsaWithAes256CbcShaCiphersEnabled bool
TlsRsaWithAes128CbcSha256CiphersEnabled bool

Should the TLS_RSA_WITH_AES_128_CBC_SHA256 cipher be enabled? Defaults to false.

TlsRsaWithAes128CbcShaCiphersEnabled bool

Should the TLS_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

TlsRsaWithAes128GcmSha256CiphersEnabled bool

Should the TLS_RSA_WITH_AES_128_GCM_SHA256 cipher be enabled? Defaults to false.

TlsRsaWithAes256CbcSha256CiphersEnabled bool

Should the TLS_RSA_WITH_AES_256_CBC_SHA256 cipher be enabled? Defaults to false.

TlsRsaWithAes256CbcShaCiphersEnabled bool

Should the TLS_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

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)? Defaults to false.

EnableBackendSsl30 bool

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

EnableBackendTls10 bool

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

EnableBackendTls11 bool

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

EnableFrontendSsl30 bool

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

EnableFrontendTls10 bool

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

EnableFrontendTls11 bool

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

TlsEcdheEcdsaWithAes128CbcShaCiphersEnabled bool

Should the TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

TlsEcdheEcdsaWithAes256CbcShaCiphersEnabled bool

Should the TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

TlsEcdheRsaWithAes128CbcShaCiphersEnabled bool
TlsEcdheRsaWithAes256CbcShaCiphersEnabled bool
TlsRsaWithAes128CbcSha256CiphersEnabled bool

Should the TLS_RSA_WITH_AES_128_CBC_SHA256 cipher be enabled? Defaults to false.

TlsRsaWithAes128CbcShaCiphersEnabled bool

Should the TLS_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

TlsRsaWithAes128GcmSha256CiphersEnabled bool

Should the TLS_RSA_WITH_AES_128_GCM_SHA256 cipher be enabled? Defaults to false.

TlsRsaWithAes256CbcSha256CiphersEnabled bool

Should the TLS_RSA_WITH_AES_256_CBC_SHA256 cipher be enabled? Defaults to false.

TlsRsaWithAes256CbcShaCiphersEnabled bool

Should the TLS_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

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)? Defaults to false.

enableBackendSsl30 Boolean

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

enableBackendTls10 Boolean

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

enableBackendTls11 Boolean

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

enableFrontendSsl30 Boolean

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

enableFrontendTls10 Boolean

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

enableFrontendTls11 Boolean

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

tlsEcdheEcdsaWithAes128CbcShaCiphersEnabled Boolean

Should the TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

tlsEcdheEcdsaWithAes256CbcShaCiphersEnabled Boolean

Should the TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

tlsEcdheRsaWithAes128CbcShaCiphersEnabled Boolean
tlsEcdheRsaWithAes256CbcShaCiphersEnabled Boolean
tlsRsaWithAes128CbcSha256CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_128_CBC_SHA256 cipher be enabled? Defaults to false.

tlsRsaWithAes128CbcShaCiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

tlsRsaWithAes128GcmSha256CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_128_GCM_SHA256 cipher be enabled? Defaults to false.

tlsRsaWithAes256CbcSha256CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_256_CBC_SHA256 cipher be enabled? Defaults to false.

tlsRsaWithAes256CbcShaCiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

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)? Defaults to false.

enableBackendSsl30 boolean

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

enableBackendTls10 boolean

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

enableBackendTls11 boolean

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

enableFrontendSsl30 boolean

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

enableFrontendTls10 boolean

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

enableFrontendTls11 boolean

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

tlsEcdheEcdsaWithAes128CbcShaCiphersEnabled boolean

Should the TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

tlsEcdheEcdsaWithAes256CbcShaCiphersEnabled boolean

Should the TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

tlsEcdheRsaWithAes128CbcShaCiphersEnabled boolean
tlsEcdheRsaWithAes256CbcShaCiphersEnabled boolean
tlsRsaWithAes128CbcSha256CiphersEnabled boolean

Should the TLS_RSA_WITH_AES_128_CBC_SHA256 cipher be enabled? Defaults to false.

tlsRsaWithAes128CbcShaCiphersEnabled boolean

Should the TLS_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

tlsRsaWithAes128GcmSha256CiphersEnabled boolean

Should the TLS_RSA_WITH_AES_128_GCM_SHA256 cipher be enabled? Defaults to false.

tlsRsaWithAes256CbcSha256CiphersEnabled boolean

Should the TLS_RSA_WITH_AES_256_CBC_SHA256 cipher be enabled? Defaults to false.

tlsRsaWithAes256CbcShaCiphersEnabled boolean

Should the TLS_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

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)? Defaults to false.

enable_backend_ssl30 bool

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

enable_backend_tls10 bool

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

enable_backend_tls11 bool

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

enable_frontend_ssl30 bool

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

enable_frontend_tls10 bool

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

enable_frontend_tls11 bool

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

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.

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.

tls_ecdhe_rsa_with_aes128_cbc_sha_ciphers_enabled bool
tls_ecdhe_rsa_with_aes256_cbc_sha_ciphers_enabled bool
tls_rsa_with_aes128_cbc_sha256_ciphers_enabled bool

Should the TLS_RSA_WITH_AES_128_CBC_SHA256 cipher be enabled? Defaults to false.

tls_rsa_with_aes128_cbc_sha_ciphers_enabled bool

Should the TLS_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

tls_rsa_with_aes128_gcm_sha256_ciphers_enabled bool

Should the TLS_RSA_WITH_AES_128_GCM_SHA256 cipher be enabled? Defaults to false.

tls_rsa_with_aes256_cbc_sha256_ciphers_enabled bool

Should the TLS_RSA_WITH_AES_256_CBC_SHA256 cipher be enabled? Defaults to false.

tls_rsa_with_aes256_cbc_sha_ciphers_enabled bool

Should the TLS_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

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)? Defaults to false.

enableBackendSsl30 Boolean

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

enableBackendTls10 Boolean

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

enableBackendTls11 Boolean

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

enableFrontendSsl30 Boolean

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

enableFrontendTls10 Boolean

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

enableFrontendTls11 Boolean

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

tlsEcdheEcdsaWithAes128CbcShaCiphersEnabled Boolean

Should the TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

tlsEcdheEcdsaWithAes256CbcShaCiphersEnabled Boolean

Should the TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

tlsEcdheRsaWithAes128CbcShaCiphersEnabled Boolean
tlsEcdheRsaWithAes256CbcShaCiphersEnabled Boolean
tlsRsaWithAes128CbcSha256CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_128_CBC_SHA256 cipher be enabled? Defaults to false.

tlsRsaWithAes128CbcShaCiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_128_CBC_SHA cipher be enabled? Defaults to false.

tlsRsaWithAes128GcmSha256CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_128_GCM_SHA256 cipher be enabled? Defaults to false.

tlsRsaWithAes256CbcSha256CiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_256_CBC_SHA256 cipher be enabled? Defaults to false.

tlsRsaWithAes256CbcShaCiphersEnabled Boolean

Should the TLS_RSA_WITH_AES_256_CBC_SHA cipher be enabled? Defaults to false.

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)? Defaults to false.

ServiceSignIn

Enabled bool

Should anonymous users be redirected to the sign in page?

Enabled bool

Should anonymous users be redirected to the sign in page?

enabled Boolean

Should anonymous users be redirected to the sign in page?

enabled boolean

Should anonymous users be redirected to the sign in page?

enabled bool

Should anonymous users be redirected to the sign in page?

enabled Boolean

Should anonymous users be redirected to the sign in page?

ServiceSignUp

Enabled bool

Can users sign up on the development portal?

TermsOfService ServiceSignUpTermsOfService

A terms_of_service block as defined below.

Enabled bool

Can users sign up on the development portal?

TermsOfService ServiceSignUpTermsOfService

A terms_of_service block as defined below.

enabled Boolean

Can users sign up on the development portal?

termsOfService ServiceSignUpTermsOfService

A terms_of_service block as defined below.

enabled boolean

Can users sign up on the development portal?

termsOfService ServiceSignUpTermsOfService

A terms_of_service block as defined below.

enabled bool

Can users sign up on the development portal?

terms_of_service ServiceSignUpTermsOfService

A terms_of_service block as defined below.

enabled Boolean

Can users sign up on the development portal?

termsOfService Property Map

A terms_of_service block as defined below.

ServiceSignUpTermsOfService

ConsentRequired bool

Should the user be asked for consent during sign up?

Enabled bool

Should Terms of Service be displayed during sign up?.

Text string

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

ConsentRequired bool

Should the user be asked for consent during sign up?

Enabled bool

Should Terms of Service be displayed during sign up?.

Text string

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

consentRequired Boolean

Should the user be asked for consent during sign up?

enabled Boolean

Should Terms of Service be displayed during sign up?.

text String

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

consentRequired boolean

Should the user be asked for consent during sign up?

enabled boolean

Should Terms of Service be displayed during sign up?.

text string

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

consent_required bool

Should the user be asked for consent during sign up?

enabled bool

Should Terms of Service be displayed during sign up?.

text str

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

consentRequired Boolean

Should the user be asked for consent during sign up?

enabled Boolean

Should Terms of Service be displayed during sign up?.

text String

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

ServiceTenantAccess

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

SubnetId string

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

SubnetId string

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

subnetId String

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

subnetId string

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

subnet_id str

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

subnetId String

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

Package Details

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

This Pulumi package is based on the azurerm Terraform Provider.