Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cdn
  5. KeyGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cdn.KeyGroup

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Contains a list of references of UrlSigningKey type secret objects.

Uses Azure REST API version 2024-06-01-preview. In version 2.x of the Azure Native provider, it used API version 2023-07-01-preview.

Other available API versions: 2023-07-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cdn [ApiVersion]. See the version guide for details.

Example Usage

KeyGroups_Create

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var keyGroup = new AzureNative.Cdn.KeyGroup("keyGroup", new()
    {
        KeyGroupName = "kg1",
        KeyReferences = new[]
        {
            new AzureNative.Cdn.Inputs.ResourceReferenceArgs
            {
                Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1",
            },
            new AzureNative.Cdn.Inputs.ResourceReferenceArgs
            {
                Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret2",
            },
            new AzureNative.Cdn.Inputs.ResourceReferenceArgs
            {
                Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret3",
            },
        },
        ProfileName = "profile1",
        ResourceGroupName = "RG",
    });

});
Copy
package main

import (
	cdn "github.com/pulumi/pulumi-azure-native-sdk/cdn/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cdn.NewKeyGroup(ctx, "keyGroup", &cdn.KeyGroupArgs{
			KeyGroupName: pulumi.String("kg1"),
			KeyReferences: cdn.ResourceReferenceArray{
				&cdn.ResourceReferenceArgs{
					Id: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1"),
				},
				&cdn.ResourceReferenceArgs{
					Id: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret2"),
				},
				&cdn.ResourceReferenceArgs{
					Id: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret3"),
				},
			},
			ProfileName:       pulumi.String("profile1"),
			ResourceGroupName: pulumi.String("RG"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cdn.KeyGroup;
import com.pulumi.azurenative.cdn.KeyGroupArgs;
import com.pulumi.azurenative.cdn.inputs.ResourceReferenceArgs;
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 keyGroup = new KeyGroup("keyGroup", KeyGroupArgs.builder()
            .keyGroupName("kg1")
            .keyReferences(            
                ResourceReferenceArgs.builder()
                    .id("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1")
                    .build(),
                ResourceReferenceArgs.builder()
                    .id("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret2")
                    .build(),
                ResourceReferenceArgs.builder()
                    .id("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret3")
                    .build())
            .profileName("profile1")
            .resourceGroupName("RG")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const keyGroup = new azure_native.cdn.KeyGroup("keyGroup", {
    keyGroupName: "kg1",
    keyReferences: [
        {
            id: "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1",
        },
        {
            id: "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret2",
        },
        {
            id: "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret3",
        },
    ],
    profileName: "profile1",
    resourceGroupName: "RG",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

key_group = azure_native.cdn.KeyGroup("keyGroup",
    key_group_name="kg1",
    key_references=[
        {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1",
        },
        {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret2",
        },
        {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret3",
        },
    ],
    profile_name="profile1",
    resource_group_name="RG")
Copy
resources:
  keyGroup:
    type: azure-native:cdn:KeyGroup
    properties:
      keyGroupName: kg1
      keyReferences:
        - id: /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1
        - id: /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret2
        - id: /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret3
      profileName: profile1
      resourceGroupName: RG
Copy

Create KeyGroup Resource

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

Constructor syntax

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

@overload
def KeyGroup(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             profile_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             key_group_name: Optional[str] = None,
             key_references: Optional[Sequence[ResourceReferenceArgs]] = None)
func NewKeyGroup(ctx *Context, name string, args KeyGroupArgs, opts ...ResourceOption) (*KeyGroup, error)
public KeyGroup(string name, KeyGroupArgs args, CustomResourceOptions? opts = null)
public KeyGroup(String name, KeyGroupArgs args)
public KeyGroup(String name, KeyGroupArgs args, CustomResourceOptions options)

type: azure-native:cdn:KeyGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. KeyGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. KeyGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. KeyGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. KeyGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. KeyGroupArgs
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 keyGroupResource = new AzureNative.Cdn.KeyGroup("keyGroupResource", new()
{
    ProfileName = "string",
    ResourceGroupName = "string",
    KeyGroupName = "string",
    KeyReferences = new[]
    {
        new AzureNative.Cdn.Inputs.ResourceReferenceArgs
        {
            Id = "string",
        },
    },
});
Copy
example, err := cdn.NewKeyGroup(ctx, "keyGroupResource", &cdn.KeyGroupArgs{
	ProfileName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	KeyGroupName:      pulumi.String("string"),
	KeyReferences: cdn.ResourceReferenceArray{
		&cdn.ResourceReferenceArgs{
			Id: pulumi.String("string"),
		},
	},
})
Copy
var keyGroupResource = new KeyGroup("keyGroupResource", KeyGroupArgs.builder()
    .profileName("string")
    .resourceGroupName("string")
    .keyGroupName("string")
    .keyReferences(ResourceReferenceArgs.builder()
        .id("string")
        .build())
    .build());
Copy
key_group_resource = azure_native.cdn.KeyGroup("keyGroupResource",
    profile_name="string",
    resource_group_name="string",
    key_group_name="string",
    key_references=[{
        "id": "string",
    }])
Copy
const keyGroupResource = new azure_native.cdn.KeyGroup("keyGroupResource", {
    profileName: "string",
    resourceGroupName: "string",
    keyGroupName: "string",
    keyReferences: [{
        id: "string",
    }],
});
Copy
type: azure-native:cdn:KeyGroup
properties:
    keyGroupName: string
    keyReferences:
        - id: string
    profileName: string
    resourceGroupName: string
Copy

KeyGroup 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 KeyGroup resource accepts the following input properties:

ProfileName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
KeyGroupName Changes to this property will trigger replacement. string
Name of the KeyGroup under the profile.
KeyReferences List<Pulumi.AzureNative.Cdn.Inputs.ResourceReference>
Names of UrlSigningKey type secret objects
ProfileName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
KeyGroupName Changes to this property will trigger replacement. string
Name of the KeyGroup under the profile.
KeyReferences []ResourceReferenceArgs
Names of UrlSigningKey type secret objects
profileName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
keyGroupName Changes to this property will trigger replacement. String
Name of the KeyGroup under the profile.
keyReferences List<ResourceReference>
Names of UrlSigningKey type secret objects
profileName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
keyGroupName Changes to this property will trigger replacement. string
Name of the KeyGroup under the profile.
keyReferences ResourceReference[]
Names of UrlSigningKey type secret objects
profile_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
key_group_name Changes to this property will trigger replacement. str
Name of the KeyGroup under the profile.
key_references Sequence[ResourceReferenceArgs]
Names of UrlSigningKey type secret objects
profileName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
keyGroupName Changes to this property will trigger replacement. String
Name of the KeyGroup under the profile.
keyReferences List<Property Map>
Names of UrlSigningKey type secret objects

Outputs

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

AzureApiVersion string
The Azure API version of the resource.
DeploymentStatus string
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
ProvisioningState string
Provisioning status
SystemData Pulumi.AzureNative.Cdn.Outputs.SystemDataResponse
Read only system data
Type string
Resource type.
AzureApiVersion string
The Azure API version of the resource.
DeploymentStatus string
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
ProvisioningState string
Provisioning status
SystemData SystemDataResponse
Read only system data
Type string
Resource type.
azureApiVersion String
The Azure API version of the resource.
deploymentStatus String
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
provisioningState String
Provisioning status
systemData SystemDataResponse
Read only system data
type String
Resource type.
azureApiVersion string
The Azure API version of the resource.
deploymentStatus string
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name.
provisioningState string
Provisioning status
systemData SystemDataResponse
Read only system data
type string
Resource type.
azure_api_version str
The Azure API version of the resource.
deployment_status str
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name.
provisioning_state str
Provisioning status
system_data SystemDataResponse
Read only system data
type str
Resource type.
azureApiVersion String
The Azure API version of the resource.
deploymentStatus String
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
provisioningState String
Provisioning status
systemData Property Map
Read only system data
type String
Resource type.

Supporting Types

ResourceReference
, ResourceReferenceArgs

Id string
Resource ID.
Id string
Resource ID.
id String
Resource ID.
id string
Resource ID.
id str
Resource ID.
id String
Resource ID.

ResourceReferenceResponse
, ResourceReferenceResponseArgs

Id string
Resource ID.
Id string
Resource ID.
id String
Resource ID.
id string
Resource ID.
id str
Resource ID.
id String
Resource ID.

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC)
CreatedBy string
An identifier for the identity that created the resource
CreatedByType string
The type of identity that created the resource
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
An identifier for the identity that last modified the resource
LastModifiedByType string
The type of identity that last modified the resource
CreatedAt string
The timestamp of resource creation (UTC)
CreatedBy string
An identifier for the identity that created the resource
CreatedByType string
The type of identity that created the resource
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
An identifier for the identity that last modified the resource
LastModifiedByType string
The type of identity that last modified the resource
createdAt String
The timestamp of resource creation (UTC)
createdBy String
An identifier for the identity that created the resource
createdByType String
The type of identity that created the resource
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
An identifier for the identity that last modified the resource
lastModifiedByType String
The type of identity that last modified the resource
createdAt string
The timestamp of resource creation (UTC)
createdBy string
An identifier for the identity that created the resource
createdByType string
The type of identity that created the resource
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
An identifier for the identity that last modified the resource
lastModifiedByType string
The type of identity that last modified the resource
created_at str
The timestamp of resource creation (UTC)
created_by str
An identifier for the identity that created the resource
created_by_type str
The type of identity that created the resource
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
An identifier for the identity that last modified the resource
last_modified_by_type str
The type of identity that last modified the resource
createdAt String
The timestamp of resource creation (UTC)
createdBy String
An identifier for the identity that created the resource
createdByType String
The type of identity that created the resource
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
An identifier for the identity that last modified the resource
lastModifiedByType String
The type of identity that last modified the resource

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:cdn:KeyGroup kg1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/keyGroups/{keyGroupName}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native