pulumi-azure-kotlin/com.pulumi.azure.apimanagement.kotlin/Service

Service

class Service : KotlinCustomResource

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .publisherName("My Company")
            .publisherEmail("company@exmaple.com")
            .skuName("Developer_1")
            .build());
    }
}

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

Properties

additionalLocations

val additionalLocations: Output<List<ServiceAdditionalLocation>>?

One or more additional_location blocks as defined below.

certificates

val certificates: Output<List<ServiceCertificate>>?

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

clientCertificateEnabled

val clientCertificateEnabled: Output<Boolean>?

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

delegation

val delegation: Output<ServiceDelegation>

A delegation block as defined below.

developerPortalUrl

val developerPortalUrl: Output<String>

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

gatewayDisabled

val gatewayDisabled: Output<Boolean>?

Disable the gateway in main region? This is only supported when additional_location is set.

gatewayRegionalUrl

val gatewayRegionalUrl: Output<String>

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

gatewayUrl

val gatewayUrl: Output<String>

The URL of the Gateway for the API Management Service.

hostnameConfiguration

val hostnameConfiguration: Output<ServiceHostnameConfiguration>

A hostname_configuration block as defined below.

val id: Output<String>

identity

val identity: Output<ServiceIdentity>?

An identity block as defined below.

location

val location: Output<String>

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

managementApiUrl

val managementApiUrl: Output<String>

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

minApiVersion

val minApiVersion: Output<String>?

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

name

val name: Output<String>

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

notificationSenderEmail

val notificationSenderEmail: Output<String>

Email address from which the notification will be sent.

policy

val policy: Output<ServicePolicy>

A policy block as defined below.

portalUrl

val portalUrl: Output<String>

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

privateIpAddresses

val privateIpAddresses: Output<List<String>>

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

protocols

val protocols: Output<ServiceProtocols>

A protocols block as defined below.

publicIpAddresses

val publicIpAddresses: Output<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.

publicIpAddressId

val publicIpAddressId: Output<String>?

ID of a standard SKU IPv4 Public IP.

publicNetworkAccessEnabled

val publicNetworkAccessEnabled: Output<Boolean>?

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

publisherEmail

val publisherEmail: Output<String>

The email of publisher/company.

publisherName

val publisherName: Output<String>

The name of publisher/company.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

resourceGroupName

val resourceGroupName: Output<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

val scmUrl: Output<String>

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

security

val security: Output<ServiceSecurity>

A security block as defined below.

signIn

val signIn: Output<ServiceSignIn>

A sign_in block as defined below.

signUp

val signUp: Output<ServiceSignUp>

A sign_up block as defined below.

skuName

val skuName: Output<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).