1. Packages
  2. Azure Native
  3. API Docs
  4. cdn
  5. getKeyGroup
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.cdn.getKeyGroup

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Gets an existing KeyGroup within a profile.

Uses Azure REST API version 2024-06-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.

Using getKeyGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKeyGroup(args: GetKeyGroupArgs, opts?: InvokeOptions): Promise<GetKeyGroupResult>
function getKeyGroupOutput(args: GetKeyGroupOutputArgs, opts?: InvokeOptions): Output<GetKeyGroupResult>
Copy
def get_key_group(key_group_name: Optional[str] = None,
                  profile_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetKeyGroupResult
def get_key_group_output(key_group_name: Optional[pulumi.Input[str]] = None,
                  profile_name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetKeyGroupResult]
Copy
func LookupKeyGroup(ctx *Context, args *LookupKeyGroupArgs, opts ...InvokeOption) (*LookupKeyGroupResult, error)
func LookupKeyGroupOutput(ctx *Context, args *LookupKeyGroupOutputArgs, opts ...InvokeOption) LookupKeyGroupResultOutput
Copy

> Note: This function is named LookupKeyGroup in the Go SDK.

public static class GetKeyGroup 
{
    public static Task<GetKeyGroupResult> InvokeAsync(GetKeyGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyGroupResult> Invoke(GetKeyGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetKeyGroupResult> getKeyGroup(GetKeyGroupArgs args, InvokeOptions options)
public static Output<GetKeyGroupResult> getKeyGroup(GetKeyGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cdn:getKeyGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

KeyGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the KeyGroup under the profile.
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
This property is required.
Changes to this property will trigger replacement.
string
Name of the KeyGroup under the profile.
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
This property is required.
Changes to this property will trigger replacement.
String
Name of the KeyGroup under the profile.
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
This property is required.
Changes to this property will trigger replacement.
string
Name of the KeyGroup under the profile.
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.
key_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the KeyGroup under the profile.
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.
keyGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the KeyGroup under the profile.
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.

getKeyGroup Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
DeploymentStatus string
Id string
Resource ID.
Name string
Resource name.
ProvisioningState string
Provisioning status
SystemData Pulumi.AzureNative.Cdn.Outputs.SystemDataResponse
Read only system data
Type string
Resource type.
KeyReferences List<Pulumi.AzureNative.Cdn.Outputs.ResourceReferenceResponse>
Names of UrlSigningKey type secret objects
AzureApiVersion string
The Azure API version of the resource.
DeploymentStatus string
Id string
Resource ID.
Name string
Resource name.
ProvisioningState string
Provisioning status
SystemData SystemDataResponse
Read only system data
Type string
Resource type.
KeyReferences []ResourceReferenceResponse
Names of UrlSigningKey type secret objects
azureApiVersion String
The Azure API version of the resource.
deploymentStatus String
id String
Resource ID.
name String
Resource name.
provisioningState String
Provisioning status
systemData SystemDataResponse
Read only system data
type String
Resource type.
keyReferences List<ResourceReferenceResponse>
Names of UrlSigningKey type secret objects
azureApiVersion string
The Azure API version of the resource.
deploymentStatus string
id string
Resource ID.
name string
Resource name.
provisioningState string
Provisioning status
systemData SystemDataResponse
Read only system data
type string
Resource type.
keyReferences ResourceReferenceResponse[]
Names of UrlSigningKey type secret objects
azure_api_version str
The Azure API version of the resource.
deployment_status str
id str
Resource ID.
name str
Resource name.
provisioning_state str
Provisioning status
system_data SystemDataResponse
Read only system data
type str
Resource type.
key_references Sequence[ResourceReferenceResponse]
Names of UrlSigningKey type secret objects
azureApiVersion String
The Azure API version of the resource.
deploymentStatus String
id String
Resource ID.
name String
Resource name.
provisioningState String
Provisioning status
systemData Property Map
Read only system data
type String
Resource type.
keyReferences List<Property Map>
Names of UrlSigningKey type secret objects

Supporting Types

ResourceReferenceResponse

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

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

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi