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

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.GatewayCertificateAuthority

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-azure

    Manages an API Management Gateway Certificate Authority.

    Example Usage

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

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: "pub1",
    publisherEmail: "pub1@email.com",
    skuName: "Consumption_0",
});
const exampleGateway = new azure.apimanagement.Gateway("example", {
    name: "example-gateway",
    apiManagementId: exampleService.id,
    description: "Example API Management gateway",
    locationData: {
        name: "example name",
        city: "example city",
        district: "example district",
        region: "example region",
    },
});
const exampleCertificate = new azure.apimanagement.Certificate("example", {
    name: "example-cert",
    apiManagementName: exampleService.name,
    resourceGroupName: example.name,
    data: std.filebase64({
        input: "example.pfx",
    }).then(invoke => invoke.result),
});
const exampleGatewayCertificateAuthority = new azure.apimanagement.GatewayCertificateAuthority("example", {
    apiManagementId: exampleService.id,
    certificateName: exampleCertificate.name,
    gatewayName: exampleGateway.name,
    isTrusted: true,
});

    import pulumi
import pulumi_azure as azure
import pulumi_std as std

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="pub1",
    publisher_email="pub1@email.com",
    sku_name="Consumption_0")
example_gateway = azure.apimanagement.Gateway("example",
    name="example-gateway",
    api_management_id=example_service.id,
    description="Example API Management gateway",
    location_data={
        "name": "example name",
        "city": "example city",
        "district": "example district",
        "region": "example region",
    })
example_certificate = azure.apimanagement.Certificate("example",
    name="example-cert",
    api_management_name=example_service.name,
    resource_group_name=example.name,
    data=std.filebase64(input="example.pfx").result)
example_gateway_certificate_authority = azure.apimanagement.GatewayCertificateAuthority("example",
    api_management_id=example_service.id,
    certificate_name=example_certificate.name,
    gateway_name=example_gateway.name,
    is_trusted=True)

    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-std/sdk/go/std"
	"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
		}
		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
			Name:              pulumi.String("example-apim"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			PublisherName:     pulumi.String("pub1"),
			PublisherEmail:    pulumi.String("pub1@email.com"),
			SkuName:           pulumi.String("Consumption_0"),
		})
		if err != nil {
			return err
		}
		exampleGateway, err := apimanagement.NewGateway(ctx, "example", &apimanagement.GatewayArgs{
			Name:            pulumi.String("example-gateway"),
			ApiManagementId: exampleService.ID(),
			Description:     pulumi.String("Example API Management gateway"),
			LocationData: &apimanagement.GatewayLocationDataArgs{
				Name:     pulumi.String("example name"),
				City:     pulumi.String("example city"),
				District: pulumi.String("example district"),
				Region:   pulumi.String("example region"),
			},
		})
		if err != nil {
			return err
		}
		invokeFilebase64, err := std.Filebase64(ctx, &std.Filebase64Args{
			Input: "example.pfx",
		}, nil)
		if err != nil {
			return err
		}
		exampleCertificate, err := apimanagement.NewCertificate(ctx, "example", &apimanagement.CertificateArgs{
			Name:              pulumi.String("example-cert"),
			ApiManagementName: exampleService.Name,
			ResourceGroupName: example.Name,
			Data:              pulumi.String(invokeFilebase64.Result),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewGatewayCertificateAuthority(ctx, "example", &apimanagement.GatewayCertificateAuthorityArgs{
			ApiManagementId: exampleService.ID(),
			CertificateName: exampleCertificate.Name,
			GatewayName:     exampleGateway.Name,
			IsTrusted:       pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
using Std = Pulumi.Std;

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 = "pub1",
        PublisherEmail = "pub1@email.com",
        SkuName = "Consumption_0",
    });

    var exampleGateway = new Azure.ApiManagement.Gateway("example", new()
    {
        Name = "example-gateway",
        ApiManagementId = exampleService.Id,
        Description = "Example API Management gateway",
        LocationData = new Azure.ApiManagement.Inputs.GatewayLocationDataArgs
        {
            Name = "example name",
            City = "example city",
            District = "example district",
            Region = "example region",
        },
    });

    var exampleCertificate = new Azure.ApiManagement.Certificate("example", new()
    {
        Name = "example-cert",
        ApiManagementName = exampleService.Name,
        ResourceGroupName = example.Name,
        Data = Std.Filebase64.Invoke(new()
        {
            Input = "example.pfx",
        }).Apply(invoke => invoke.Result),
    });

    var exampleGatewayCertificateAuthority = new Azure.ApiManagement.GatewayCertificateAuthority("example", new()
    {
        ApiManagementId = exampleService.Id,
        CertificateName = exampleCertificate.Name,
        GatewayName = exampleGateway.Name,
        IsTrusted = true,
    });

});

    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 com.pulumi.azure.apimanagement.Gateway;
import com.pulumi.azure.apimanagement.GatewayArgs;
import com.pulumi.azure.apimanagement.inputs.GatewayLocationDataArgs;
import com.pulumi.azure.apimanagement.Certificate;
import com.pulumi.azure.apimanagement.CertificateArgs;
import com.pulumi.azure.apimanagement.GatewayCertificateAuthority;
import com.pulumi.azure.apimanagement.GatewayCertificateAuthorityArgs;
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("pub1")
            .publisherEmail("pub1@email.com")
            .skuName("Consumption_0")
            .build());

        var exampleGateway = new Gateway("exampleGateway", GatewayArgs.builder()
            .name("example-gateway")
            .apiManagementId(exampleService.id())
            .description("Example API Management gateway")
            .locationData(GatewayLocationDataArgs.builder()
                .name("example name")
                .city("example city")
                .district("example district")
                .region("example region")
                .build())
            .build());

        var exampleCertificate = new Certificate("exampleCertificate", CertificateArgs.builder()
            .name("example-cert")
            .apiManagementName(exampleService.name())
            .resourceGroupName(example.name())
            .data(StdFunctions.filebase64(Filebase64Args.builder()
                .input("example.pfx")
                .build()).result())
            .build());

        var exampleGatewayCertificateAuthority = new GatewayCertificateAuthority("exampleGatewayCertificateAuthority", GatewayCertificateAuthorityArgs.builder()
            .apiManagementId(exampleService.id())
            .certificateName(exampleCertificate.name())
            .gatewayName(exampleGateway.name())
            .isTrusted(true)
            .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: pub1
      publisherEmail: pub1@email.com
      skuName: Consumption_0
  exampleGateway:
    type: azure:apimanagement:Gateway
    name: example
    properties:
      name: example-gateway
      apiManagementId: ${exampleService.id}
      description: Example API Management gateway
      locationData:
        name: example name
        city: example city
        district: example district
        region: example region
  exampleCertificate:
    type: azure:apimanagement:Certificate
    name: example
    properties:
      name: example-cert
      apiManagementName: ${exampleService.name}
      resourceGroupName: ${example.name}
      data:
        fn::invoke:
          function: std:filebase64
          arguments:
            input: example.pfx
          return: result
  exampleGatewayCertificateAuthority:
    type: azure:apimanagement:GatewayCertificateAuthority
    name: example
    properties:
      apiManagementId: ${exampleService.id}
      certificateName: ${exampleCertificate.name}
      gatewayName: ${exampleGateway.name}
      isTrusted: true

    Create GatewayCertificateAuthority Resource

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

    Constructor syntax

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

@overload
def GatewayCertificateAuthority(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                api_management_id: Optional[str] = None,
                                certificate_name: Optional[str] = None,
                                gateway_name: Optional[str] = None,
                                is_trusted: Optional[bool] = None)
    func NewGatewayCertificateAuthority(ctx *Context, name string, args GatewayCertificateAuthorityArgs, opts ...ResourceOption) (*GatewayCertificateAuthority, error)
    public GatewayCertificateAuthority(string name, GatewayCertificateAuthorityArgs args, CustomResourceOptions? opts = null)
    public GatewayCertificateAuthority(String name, GatewayCertificateAuthorityArgs args)
public GatewayCertificateAuthority(String name, GatewayCertificateAuthorityArgs args, CustomResourceOptions options)

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

    Parameters

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

    Constructor example

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

    var gatewayCertificateAuthorityResource = new Azure.ApiManagement.GatewayCertificateAuthority("gatewayCertificateAuthorityResource", new()
{
    ApiManagementId = "string",
    CertificateName = "string",
    GatewayName = "string",
    IsTrusted = false,
});

    example, err := apimanagement.NewGatewayCertificateAuthority(ctx, "gatewayCertificateAuthorityResource", &apimanagement.GatewayCertificateAuthorityArgs{
	ApiManagementId: pulumi.String("string"),
	CertificateName: pulumi.String("string"),
	GatewayName:     pulumi.String("string"),
	IsTrusted:       pulumi.Bool(false),
})

    var gatewayCertificateAuthorityResource = new GatewayCertificateAuthority("gatewayCertificateAuthorityResource", GatewayCertificateAuthorityArgs.builder()
    .apiManagementId("string")
    .certificateName("string")
    .gatewayName("string")
    .isTrusted(false)
    .build());

    gateway_certificate_authority_resource = azure.apimanagement.GatewayCertificateAuthority("gatewayCertificateAuthorityResource",
    api_management_id="string",
    certificate_name="string",
    gateway_name="string",
    is_trusted=False)

    const gatewayCertificateAuthorityResource = new azure.apimanagement.GatewayCertificateAuthority("gatewayCertificateAuthorityResource", {
    apiManagementId: "string",
    certificateName: "string",
    gatewayName: "string",
    isTrusted: false,
});

    type: azure:apimanagement:GatewayCertificateAuthority
properties:
    apiManagementId: string
    certificateName: string
    gatewayName: string
    isTrusted: false

    GatewayCertificateAuthority Resource Properties

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

    Inputs

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

    The GatewayCertificateAuthority resource accepts the following input properties:

    ApiManagementId string
    The ID of the API Management Service. Changing this forces a new resource to be created.
    CertificateName string
    The name of the API Management Certificate. Changing this forces a new resource to be created.
    GatewayName string
    The name of the API Management Gateway. Changing this forces a new resource to be created.
    IsTrusted bool
    Whether the API Management Gateway Certificate Authority is trusted.
    ApiManagementId string
    The ID of the API Management Service. Changing this forces a new resource to be created.
    CertificateName string
    The name of the API Management Certificate. Changing this forces a new resource to be created.
    GatewayName string
    The name of the API Management Gateway. Changing this forces a new resource to be created.
    IsTrusted bool
    Whether the API Management Gateway Certificate Authority is trusted.
    apiManagementId String
    The ID of the API Management Service. Changing this forces a new resource to be created.
    certificateName String
    The name of the API Management Certificate. Changing this forces a new resource to be created.
    gatewayName String
    The name of the API Management Gateway. Changing this forces a new resource to be created.
    isTrusted Boolean
    Whether the API Management Gateway Certificate Authority is trusted.
    apiManagementId string
    The ID of the API Management Service. Changing this forces a new resource to be created.
    certificateName string
    The name of the API Management Certificate. Changing this forces a new resource to be created.
    gatewayName string
    The name of the API Management Gateway. Changing this forces a new resource to be created.
    isTrusted boolean
    Whether the API Management Gateway Certificate Authority is trusted.
    api_management_id str
    The ID of the API Management Service. Changing this forces a new resource to be created.
    certificate_name str
    The name of the API Management Certificate. Changing this forces a new resource to be created.
    gateway_name str
    The name of the API Management Gateway. Changing this forces a new resource to be created.
    is_trusted bool
    Whether the API Management Gateway Certificate Authority is trusted.
    apiManagementId String
    The ID of the API Management Service. Changing this forces a new resource to be created.
    certificateName String
    The name of the API Management Certificate. Changing this forces a new resource to be created.
    gatewayName String
    The name of the API Management Gateway. Changing this forces a new resource to be created.
    isTrusted Boolean
    Whether the API Management Gateway Certificate Authority is trusted.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GatewayCertificateAuthority resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GatewayCertificateAuthority Resource

    Get an existing GatewayCertificateAuthority 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?: GatewayCertificateAuthorityState, opts?: CustomResourceOptions): GatewayCertificateAuthority
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_id: Optional[str] = None,
        certificate_name: Optional[str] = None,
        gateway_name: Optional[str] = None,
        is_trusted: Optional[bool] = None) -> GatewayCertificateAuthority
    func GetGatewayCertificateAuthority(ctx *Context, name string, id IDInput, state *GatewayCertificateAuthorityState, opts ...ResourceOption) (*GatewayCertificateAuthority, error)
    public static GatewayCertificateAuthority Get(string name, Input<string> id, GatewayCertificateAuthorityState? state, CustomResourceOptions? opts = null)
    public static GatewayCertificateAuthority get(String name, Output<String> id, GatewayCertificateAuthorityState state, CustomResourceOptions options)
    resources:  _:    type: azure:apimanagement:GatewayCertificateAuthority    get:      id: ${id}
    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:
    ApiManagementId string
    The ID of the API Management Service. Changing this forces a new resource to be created.
    CertificateName string
    The name of the API Management Certificate. Changing this forces a new resource to be created.
    GatewayName string
    The name of the API Management Gateway. Changing this forces a new resource to be created.
    IsTrusted bool
    Whether the API Management Gateway Certificate Authority is trusted.
    ApiManagementId string
    The ID of the API Management Service. Changing this forces a new resource to be created.
    CertificateName string
    The name of the API Management Certificate. Changing this forces a new resource to be created.
    GatewayName string
    The name of the API Management Gateway. Changing this forces a new resource to be created.
    IsTrusted bool
    Whether the API Management Gateway Certificate Authority is trusted.
    apiManagementId String
    The ID of the API Management Service. Changing this forces a new resource to be created.
    certificateName String
    The name of the API Management Certificate. Changing this forces a new resource to be created.
    gatewayName String
    The name of the API Management Gateway. Changing this forces a new resource to be created.
    isTrusted Boolean
    Whether the API Management Gateway Certificate Authority is trusted.
    apiManagementId string
    The ID of the API Management Service. Changing this forces a new resource to be created.
    certificateName string
    The name of the API Management Certificate. Changing this forces a new resource to be created.
    gatewayName string
    The name of the API Management Gateway. Changing this forces a new resource to be created.
    isTrusted boolean
    Whether the API Management Gateway Certificate Authority is trusted.
    api_management_id str
    The ID of the API Management Service. Changing this forces a new resource to be created.
    certificate_name str
    The name of the API Management Certificate. Changing this forces a new resource to be created.
    gateway_name str
    The name of the API Management Gateway. Changing this forces a new resource to be created.
    is_trusted bool
    Whether the API Management Gateway Certificate Authority is trusted.
    apiManagementId String
    The ID of the API Management Service. Changing this forces a new resource to be created.
    certificateName String
    The name of the API Management Certificate. Changing this forces a new resource to be created.
    gatewayName String
    The name of the API Management Gateway. Changing this forces a new resource to be created.
    isTrusted Boolean
    Whether the API Management Gateway Certificate Authority is trusted.

    Import

    API Management Gateway Certificate Authority can be imported using the resource id, e.g.

    $ pulumi import azure:apimanagement/gatewayCertificateAuthority:GatewayCertificateAuthority example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/gateways/gateway1/certificateAuthorities/cert1

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

    Package Details

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

    We recommend using Azure Native.

    Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-azure