An agent link (web agent association) within a CDN profile.
Uses Azure REST API version 2025-09-01-preview.
Example Usage
ProfileAgents_CreateOrUpdate
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var profileAgent = new AzureNative.Cdn.ProfileAgent("profileAgent", new()
{
AgentName = "agent1",
CustomDomains = new[]
{
new AzureNative.Cdn.Inputs.ResourceReferenceArgs
{
Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/mydomain.com",
},
},
ProfileName = "profile1",
ResourceGroupName = "RG",
WebAgent = new AzureNative.Cdn.Inputs.ResourceReferenceArgs
{
Id = "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/webAgents/webagent1",
},
});
});
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.NewProfileAgent(ctx, "profileAgent", &cdn.ProfileAgentArgs{
AgentName: pulumi.String("agent1"),
CustomDomains: cdn.ResourceReferenceArray{
&cdn.ResourceReferenceArgs{
Id: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/mydomain.com"),
},
},
ProfileName: pulumi.String("profile1"),
ResourceGroupName: pulumi.String("RG"),
WebAgent: &cdn.ResourceReferenceArgs{
Id: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/webAgents/webagent1"),
},
})
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.cdn.ProfileAgent;
import com.pulumi.azurenative.cdn.ProfileAgentArgs;
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 profileAgent = new ProfileAgent("profileAgent", ProfileAgentArgs.builder()
.agentName("agent1")
.customDomains(ResourceReferenceArgs.builder()
.id("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/mydomain.com")
.build())
.profileName("profile1")
.resourceGroupName("RG")
.webAgent(ResourceReferenceArgs.builder()
.id("/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/webAgents/webagent1")
.build())
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const profileAgent = new azure_native.cdn.ProfileAgent("profileAgent", {
agentName: "agent1",
customDomains: [{
id: "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/mydomain.com",
}],
profileName: "profile1",
resourceGroupName: "RG",
webAgent: {
id: "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/webAgents/webagent1",
},
});
import pulumi
import pulumi_azure_native as azure_native
profile_agent = azure_native.cdn.ProfileAgent("profileAgent",
agent_name="agent1",
custom_domains=[{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/mydomain.com",
}],
profile_name="profile1",
resource_group_name="RG",
web_agent={
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/webAgents/webagent1",
})
resources:
profileAgent:
type: azure-native:cdn:ProfileAgent
properties:
agentName: agent1
customDomains:
- id: /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/mydomain.com
profileName: profile1
resourceGroupName: RG
webAgent:
id: /subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/webAgents/webagent1
Create ProfileAgent Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ProfileAgent(name: string, args: ProfileAgentArgs, opts?: CustomResourceOptions);@overload
def ProfileAgent(resource_name: str,
args: ProfileAgentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ProfileAgent(resource_name: str,
opts: Optional[ResourceOptions] = None,
custom_domains: Optional[Sequence[ResourceReferenceArgs]] = None,
profile_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
web_agent: Optional[ResourceReferenceArgs] = None,
agent_name: Optional[str] = None)func NewProfileAgent(ctx *Context, name string, args ProfileAgentArgs, opts ...ResourceOption) (*ProfileAgent, error)public ProfileAgent(string name, ProfileAgentArgs args, CustomResourceOptions? opts = null)
public ProfileAgent(String name, ProfileAgentArgs args)
public ProfileAgent(String name, ProfileAgentArgs args, CustomResourceOptions options)
type: azure-native:cdn:ProfileAgent
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 ProfileAgentArgs
- 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 ProfileAgentArgs
- 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 ProfileAgentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProfileAgentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProfileAgentArgs
- 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 profileAgentResource = new AzureNative.Cdn.ProfileAgent("profileAgentResource", new()
{
CustomDomains = new[]
{
new AzureNative.Cdn.Inputs.ResourceReferenceArgs
{
Id = "string",
},
},
ProfileName = "string",
ResourceGroupName = "string",
WebAgent = new AzureNative.Cdn.Inputs.ResourceReferenceArgs
{
Id = "string",
},
AgentName = "string",
});
example, err := cdn.NewProfileAgent(ctx, "profileAgentResource", &cdn.ProfileAgentArgs{
CustomDomains: cdn.ResourceReferenceArray{
&cdn.ResourceReferenceArgs{
Id: pulumi.String("string"),
},
},
ProfileName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
WebAgent: &cdn.ResourceReferenceArgs{
Id: pulumi.String("string"),
},
AgentName: pulumi.String("string"),
})
var profileAgentResource = new ProfileAgent("profileAgentResource", ProfileAgentArgs.builder()
.customDomains(ResourceReferenceArgs.builder()
.id("string")
.build())
.profileName("string")
.resourceGroupName("string")
.webAgent(ResourceReferenceArgs.builder()
.id("string")
.build())
.agentName("string")
.build());
profile_agent_resource = azure_native.cdn.ProfileAgent("profileAgentResource",
custom_domains=[{
"id": "string",
}],
profile_name="string",
resource_group_name="string",
web_agent={
"id": "string",
},
agent_name="string")
const profileAgentResource = new azure_native.cdn.ProfileAgent("profileAgentResource", {
customDomains: [{
id: "string",
}],
profileName: "string",
resourceGroupName: "string",
webAgent: {
id: "string",
},
agentName: "string",
});
type: azure-native:cdn:ProfileAgent
properties:
agentName: string
customDomains:
- id: string
profileName: string
resourceGroupName: string
webAgent:
id: string
ProfileAgent 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 ProfileAgent resource accepts the following input properties:
- Custom
Domains List<Pulumi.Azure Native. Cdn. Inputs. Resource Reference> - List of custom domains associated with this agent link.
- Profile
Name string - Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Web
Agent Pulumi.Azure Native. Cdn. Inputs. Resource Reference - Reference to the web agent resource.
- Agent
Name string - Name of the web agent association.
- Custom
Domains []ResourceReference Args - List of custom domains associated with this agent link.
- Profile
Name string - Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Web
Agent ResourceReference Args - Reference to the web agent resource.
- Agent
Name string - Name of the web agent association.
- custom
Domains List<ResourceReference> - List of custom domains associated with this agent link.
- profile
Name String - Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- web
Agent ResourceReference - Reference to the web agent resource.
- agent
Name String - Name of the web agent association.
- custom
Domains ResourceReference[] - List of custom domains associated with this agent link.
- profile
Name string - Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- web
Agent ResourceReference - Reference to the web agent resource.
- agent
Name string - Name of the web agent association.
- custom_
domains Sequence[ResourceReference Args] - List of custom domains associated with this agent link.
- profile_
name str - Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- web_
agent ResourceReference Args - Reference to the web agent resource.
- agent_
name str - Name of the web agent association.
- custom
Domains List<Property Map> - List of custom domains associated with this agent link.
- profile
Name String - Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- web
Agent Property Map - Reference to the web agent resource.
- agent
Name String - Name of the web agent association.
Outputs
All input properties are implicitly available as output properties. Additionally, the ProfileAgent resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - Provisioning status of the profile agent association.
- System
Data Pulumi.Azure Native. Cdn. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - Provisioning status of the profile agent association.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - Provisioning status of the profile agent association.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- provisioning
State string - Provisioning status of the profile agent association.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- provisioning_
state str - Provisioning status of the profile agent association.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - Provisioning status of the profile agent association.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
ResourceReference, ResourceReferenceArgs
Reference to another resource.- 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
Reference to another resource.- 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
Metadata pertaining to creation and last modification of the resource.- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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:ProfileAgent agent1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/agents/{agentName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
