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

ServiceArgs

data class ServiceArgs(val additionalLocations: Output<List<ServiceAdditionalLocationArgs>>? = null, val certificates: Output<List<ServiceCertificateArgs>>? = null, val clientCertificateEnabled: Output<Boolean>? = null, val delegation: Output<ServiceDelegationArgs>? = null, val gatewayDisabled: Output<Boolean>? = null, val hostnameConfiguration: Output<ServiceHostnameConfigurationArgs>? = null, val identity: Output<ServiceIdentityArgs>? = null, val location: Output<String>? = null, val minApiVersion: Output<String>? = null, val name: Output<String>? = null, val notificationSenderEmail: Output<String>? = null, val policy: Output<ServicePolicyArgs>? = null, val protocols: Output<ServiceProtocolsArgs>? = null, val publicIpAddressId: Output<String>? = null, val publicNetworkAccessEnabled: Output<Boolean>? = null, val publisherEmail: Output<String>? = null, val publisherName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val security: Output<ServiceSecurityArgs>? = null, val signIn: Output<ServiceSignInArgs>? = null, val signUp: Output<ServiceSignUpArgs>? = null, val skuName: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val tenantAccess: Output<ServiceTenantAccessArgs>? = null, val virtualNetworkConfiguration: Output<ServiceVirtualNetworkConfigurationArgs>? = null, val virtualNetworkType: Output<String>? = null, val zones: Output<List<String>>? = null) : ConvertibleToJava<ServiceArgs>

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());
    }
}
Content copied to clipboard

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
Content copied to clipboard

Constructors

Link copied to clipboard
fun ServiceArgs(additionalLocations: Output<List<ServiceAdditionalLocationArgs>>? = null, certificates: Output<List<ServiceCertificateArgs>>? = null, clientCertificateEnabled: Output<Boolean>? = null, delegation: Output<ServiceDelegationArgs>? = null, gatewayDisabled: Output<Boolean>? = null, hostnameConfiguration: Output<ServiceHostnameConfigurationArgs>? = null, identity: Output<ServiceIdentityArgs>? = null, location: Output<String>? = null, minApiVersion: Output<String>? = null, name: Output<String>? = null, notificationSenderEmail: Output<String>? = null, policy: Output<ServicePolicyArgs>? = null, protocols: Output<ServiceProtocolsArgs>? = null, publicIpAddressId: Output<String>? = null, publicNetworkAccessEnabled: Output<Boolean>? = null, publisherEmail: Output<String>? = null, publisherName: Output<String>? = null, resourceGroupName: Output<String>? = null, security: Output<ServiceSecurityArgs>? = null, signIn: Output<ServiceSignInArgs>? = null, signUp: Output<ServiceSignUpArgs>? = null, skuName: Output<String>? = null, tags: Output<Map<String, String>>? = null, tenantAccess: Output<ServiceTenantAccessArgs>? = null, virtualNetworkConfiguration: Output<ServiceVirtualNetworkConfigurationArgs>? = null, virtualNetworkType: Output<String>? = null, zones: Output<List<String>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): ServiceArgs

Properties

Link copied to clipboard
val additionalLocations: Output<List<ServiceAdditionalLocationArgs>>? = null

One or more additional_location blocks as defined below.

Link copied to clipboard
val certificates: Output<List<ServiceCertificateArgs>>? = null

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

Link copied to clipboard
val clientCertificateEnabled: Output<Boolean>? = null

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

Link copied to clipboard
val delegation: Output<ServiceDelegationArgs>? = null

A delegation block as defined below.

Link copied to clipboard
val gatewayDisabled: Output<Boolean>? = null

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

Link copied to clipboard
val hostnameConfiguration: Output<ServiceHostnameConfigurationArgs>? = null

A hostname_configuration block as defined below.

Link copied to clipboard
val identity: Output<ServiceIdentityArgs>? = null

An identity block as defined below.

Link copied to clipboard
val location: Output<String>? = null

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

Link copied to clipboard
val minApiVersion: Output<String>? = null

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

Link copied to clipboard
val name: Output<String>? = null

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

Link copied to clipboard
val notificationSenderEmail: Output<String>? = null

Email address from which the notification will be sent.

Link copied to clipboard
val policy: Output<ServicePolicyArgs>? = null

A policy block as defined below.

Link copied to clipboard
val protocols: Output<ServiceProtocolsArgs>? = null

A protocols block as defined below.

Link copied to clipboard
val publicIpAddressId: Output<String>? = null

ID of a standard SKU IPv4 Public IP.

Link copied to clipboard
val publicNetworkAccessEnabled: Output<Boolean>? = null

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

Link copied to clipboard
val publisherEmail: Output<String>? = null

The email of publisher/company.

Link copied to clipboard
val publisherName: Output<String>? = null

The name of publisher/company.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

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

Link copied to clipboard
val security: Output<ServiceSecurityArgs>? = null

A security block as defined below.

Link copied to clipboard
val signIn: Output<ServiceSignInArgs>? = null

A sign_in block as defined below.

Link copied to clipboard
val signUp: Output<ServiceSignUpArgs>? = null

A sign_up block as defined below.

Link copied to clipboard
val skuName: Output<String>? = null

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

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

A mapping of tags assigned to the resource.

Link copied to clipboard
val tenantAccess: Output<ServiceTenantAccessArgs>? = null

A tenant_access block as defined below.

Link copied to clipboard
val virtualNetworkConfiguration: Output<ServiceVirtualNetworkConfigurationArgs>? = null

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

Link copied to clipboard
val virtualNetworkType: Output<String>? = null

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

Link copied to clipboard
val zones: Output<List<String>>? = null

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.