Service

class Service : KotlinCustomResource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleService = new azure.apimanagement.Service("example", {
name: "example-apim",
location: example.location,
resourceGroupName: example.name,
publisherName: "My Company",
publisherEmail: "company@exmaple.com",
skuName: "Developer_1",
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_service = azure.apimanagement.Service("example",
name="example-apim",
location=example.location,
resource_group_name=example.name,
publisher_name="My Company",
publisher_email="company@exmaple.com",
sku_name="Developer_1")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleService = new Azure.ApiManagement.Service("example", new()
{
Name = "example-apim",
Location = example.Location,
ResourceGroupName = example.Name,
PublisherName = "My Company",
PublisherEmail = "company@exmaple.com",
SkuName = "Developer_1",
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
Name: pulumi.String("example-apim"),
Location: example.Location,
ResourceGroupName: example.Name,
PublisherName: pulumi.String("My Company"),
PublisherEmail: pulumi.String("company@exmaple.com"),
SkuName: pulumi.String("Developer_1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleService = new Service("exampleService", ServiceArgs.builder()
.name("example-apim")
.location(example.location())
.resourceGroupName(example.name())
.publisherName("My Company")
.publisherEmail("company@exmaple.com")
.skuName("Developer_1")
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleService:
type: azure:apimanagement:Service
name: example
properties:
name: example-apim
location: ${example.location}
resourceGroupName: ${example.name}
publisherName: My Company
publisherEmail: company@exmaple.com
skuName: Developer_1

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

Link copied to clipboard

One or more additional_location blocks as defined below.

Link copied to clipboard

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

Link copied to clipboard

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

A delegation block as defined below.

Link copied to clipboard

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

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

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

Link copied to clipboard

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

Link copied to clipboard
val gatewayUrl: Output<String>

The URL of the Gateway for the API Management Service.

Link copied to clipboard

A hostname_configuration block as defined below.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

An identity block as defined below.

Link copied to clipboard
val location: Output<String>

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

Link copied to clipboard

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

Link copied to clipboard
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.

Link copied to clipboard
val name: Output<String>

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

Link copied to clipboard

Email address from which the notification will be sent.

Link copied to clipboard
val portalUrl: Output<String>

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

Link copied to clipboard

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

Link copied to clipboard

A protocols block as defined below.

Link copied to clipboard

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

Link copied to clipboard

ID of a standard SKU IPv4 Public IP.

Link copied to clipboard

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

Link copied to clipboard
val publisherEmail: Output<String>

The email of publisher/company.

Link copied to clipboard
val publisherName: Output<String>

The name of publisher/company.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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 scmUrl: Output<String>

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

Link copied to clipboard

A security block as defined below.

Link copied to clipboard
val signIn: Output<ServiceSignIn>

A sign_in block as defined below.

Link copied to clipboard
val signUp: Output<ServiceSignUp>

A sign_up block as defined below.

Link copied to clipboard
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).

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

A mapping of tags assigned to the resource.

Link copied to clipboard

A tenant_access block as defined below.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard

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

Link copied to clipboard

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

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

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