azure-native.apimanagement.GatewayCertificateAuthority
Explore with Pulumi AI
Gateway certificate authority details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.
Example Usage
ApiManagementCreateGatewayCertificateAuthority
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var gatewayCertificateAuthority = new AzureNative.ApiManagement.GatewayCertificateAuthority("gatewayCertificateAuthority", new()
    {
        CertificateId = "cert1",
        GatewayId = "gw1",
        IsTrusted = false,
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
    });
});
package main
import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewGatewayCertificateAuthority(ctx, "gatewayCertificateAuthority", &apimanagement.GatewayCertificateAuthorityArgs{
			CertificateId:     pulumi.String("cert1"),
			GatewayId:         pulumi.String("gw1"),
			IsTrusted:         pulumi.Bool(false),
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
		})
		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.azurenative.apimanagement.GatewayCertificateAuthority;
import com.pulumi.azurenative.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 gatewayCertificateAuthority = new GatewayCertificateAuthority("gatewayCertificateAuthority", GatewayCertificateAuthorityArgs.builder()
            .certificateId("cert1")
            .gatewayId("gw1")
            .isTrusted(false)
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const gatewayCertificateAuthority = new azure_native.apimanagement.GatewayCertificateAuthority("gatewayCertificateAuthority", {
    certificateId: "cert1",
    gatewayId: "gw1",
    isTrusted: false,
    resourceGroupName: "rg1",
    serviceName: "apimService1",
});
import pulumi
import pulumi_azure_native as azure_native
gateway_certificate_authority = azure_native.apimanagement.GatewayCertificateAuthority("gatewayCertificateAuthority",
    certificate_id="cert1",
    gateway_id="gw1",
    is_trusted=False,
    resource_group_name="rg1",
    service_name="apimService1")
resources:
  gatewayCertificateAuthority:
    type: azure-native:apimanagement:GatewayCertificateAuthority
    properties:
      certificateId: cert1
      gatewayId: gw1
      isTrusted: false
      resourceGroupName: rg1
      serviceName: apimService1
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,
                                gateway_id: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                service_name: Optional[str] = None,
                                certificate_id: 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-native: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 AzureNative.ApiManagement.GatewayCertificateAuthority("gatewayCertificateAuthorityResource", new()
{
    GatewayId = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    CertificateId = "string",
    IsTrusted = false,
});
example, err := apimanagement.NewGatewayCertificateAuthority(ctx, "gatewayCertificateAuthorityResource", &apimanagement.GatewayCertificateAuthorityArgs{
	GatewayId:         pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	CertificateId:     pulumi.String("string"),
	IsTrusted:         pulumi.Bool(false),
})
var gatewayCertificateAuthorityResource = new GatewayCertificateAuthority("gatewayCertificateAuthorityResource", GatewayCertificateAuthorityArgs.builder()
    .gatewayId("string")
    .resourceGroupName("string")
    .serviceName("string")
    .certificateId("string")
    .isTrusted(false)
    .build());
gateway_certificate_authority_resource = azure_native.apimanagement.GatewayCertificateAuthority("gatewayCertificateAuthorityResource",
    gateway_id="string",
    resource_group_name="string",
    service_name="string",
    certificate_id="string",
    is_trusted=False)
const gatewayCertificateAuthorityResource = new azure_native.apimanagement.GatewayCertificateAuthority("gatewayCertificateAuthorityResource", {
    gatewayId: "string",
    resourceGroupName: "string",
    serviceName: "string",
    certificateId: "string",
    isTrusted: false,
});
type: azure-native:apimanagement:GatewayCertificateAuthority
properties:
    certificateId: string
    gatewayId: string
    isTrusted: false
    resourceGroupName: string
    serviceName: string
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:
- GatewayId string
- Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- ServiceName string
- The name of the API Management service.
- CertificateId string
- Identifier of the certificate entity. Must be unique in the current API Management service instance.
- IsTrusted bool
- Determines whether certificate authority is trusted.
- GatewayId string
- Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- ServiceName string
- The name of the API Management service.
- CertificateId string
- Identifier of the certificate entity. Must be unique in the current API Management service instance.
- IsTrusted bool
- Determines whether certificate authority is trusted.
- gatewayId String
- Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- serviceName String
- The name of the API Management service.
- certificateId String
- Identifier of the certificate entity. Must be unique in the current API Management service instance.
- isTrusted Boolean
- Determines whether certificate authority is trusted.
- gatewayId string
- Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- serviceName string
- The name of the API Management service.
- certificateId string
- Identifier of the certificate entity. Must be unique in the current API Management service instance.
- isTrusted boolean
- Determines whether certificate authority is trusted.
- gateway_id str
- Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- service_name str
- The name of the API Management service.
- certificate_id str
- Identifier of the certificate entity. Must be unique in the current API Management service instance.
- is_trusted bool
- Determines whether certificate authority is trusted.
- gatewayId String
- Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- serviceName String
- The name of the API Management service.
- certificateId String
- Identifier of the certificate entity. Must be unique in the current API Management service instance.
- isTrusted Boolean
- Determines whether certificate authority is trusted.
Outputs
All input properties are implicitly available as output properties. Additionally, the GatewayCertificateAuthority resource produces the following output properties:
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:GatewayCertificateAuthority cert1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/certificateAuthorities/{certificateId} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0