1. Packages
  2. Azure Native v2
  3. API Docs
  4. cdn
  5. getAFDEndpoint
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.cdn.getAFDEndpoint

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Azure REST API version: 2023-05-01.

Other available API versions: 2020-09-01, 2023-07-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2024-09-01.

Using getAFDEndpoint

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 getAFDEndpoint(args: GetAFDEndpointArgs, opts?: InvokeOptions): Promise<GetAFDEndpointResult>
function getAFDEndpointOutput(args: GetAFDEndpointOutputArgs, opts?: InvokeOptions): Output<GetAFDEndpointResult>
Copy
def get_afd_endpoint(endpoint_name: Optional[str] = None,
                     profile_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetAFDEndpointResult
def get_afd_endpoint_output(endpoint_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[GetAFDEndpointResult]
Copy
func LookupAFDEndpoint(ctx *Context, args *LookupAFDEndpointArgs, opts ...InvokeOption) (*LookupAFDEndpointResult, error)
func LookupAFDEndpointOutput(ctx *Context, args *LookupAFDEndpointOutputArgs, opts ...InvokeOption) LookupAFDEndpointResultOutput
Copy

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

public static class GetAFDEndpoint 
{
    public static Task<GetAFDEndpointResult> InvokeAsync(GetAFDEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetAFDEndpointResult> Invoke(GetAFDEndpointInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAFDEndpointResult> getAFDEndpoint(GetAFDEndpointArgs args, InvokeOptions options)
public static Output<GetAFDEndpointResult> getAFDEndpoint(GetAFDEndpointArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cdn:getAFDEndpoint
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EndpointName
This property is required.
Changes to this property will trigger replacement.
string
Name of the endpoint under the profile which is unique globally.
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 profile which is unique within the resource group.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
EndpointName
This property is required.
Changes to this property will trigger replacement.
string
Name of the endpoint under the profile which is unique globally.
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 profile which is unique within the resource group.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
endpointName
This property is required.
Changes to this property will trigger replacement.
String
Name of the endpoint under the profile which is unique globally.
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 profile which is unique within the resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.
endpointName
This property is required.
Changes to this property will trigger replacement.
string
Name of the endpoint under the profile which is unique globally.
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 profile which is unique within the resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
endpoint_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the endpoint under the profile which is unique globally.
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 profile which is unique within the resource group.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Resource group within the Azure subscription.
endpointName
This property is required.
Changes to this property will trigger replacement.
String
Name of the endpoint under the profile which is unique globally.
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 profile which is unique within the resource group.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.

getAFDEndpoint Result

The following output properties are available:

DeploymentStatus string
HostName string
The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
ProfileName string
The name of the profile which holds the endpoint.
ProvisioningState string
Provisioning status
SystemData Pulumi.AzureNative.Cdn.Outputs.SystemDataResponse
Read only system data
Type string
Resource type.
AutoGeneratedDomainNameLabelScope string
Indicates the endpoint name reuse scope. The default value is TenantReuse.
EnabledState string
Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
Tags Dictionary<string, string>
Resource tags.
DeploymentStatus string
HostName string
The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
Id string
Resource ID.
Location string
Resource location.
Name string
Resource name.
ProfileName string
The name of the profile which holds the endpoint.
ProvisioningState string
Provisioning status
SystemData SystemDataResponse
Read only system data
Type string
Resource type.
AutoGeneratedDomainNameLabelScope string
Indicates the endpoint name reuse scope. The default value is TenantReuse.
EnabledState string
Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
Tags map[string]string
Resource tags.
deploymentStatus String
hostName String
The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
id String
Resource ID.
location String
Resource location.
name String
Resource name.
profileName String
The name of the profile which holds the endpoint.
provisioningState String
Provisioning status
systemData SystemDataResponse
Read only system data
type String
Resource type.
autoGeneratedDomainNameLabelScope String
Indicates the endpoint name reuse scope. The default value is TenantReuse.
enabledState String
Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
tags Map<String,String>
Resource tags.
deploymentStatus string
hostName string
The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
id string
Resource ID.
location string
Resource location.
name string
Resource name.
profileName string
The name of the profile which holds the endpoint.
provisioningState string
Provisioning status
systemData SystemDataResponse
Read only system data
type string
Resource type.
autoGeneratedDomainNameLabelScope string
Indicates the endpoint name reuse scope. The default value is TenantReuse.
enabledState string
Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
tags {[key: string]: string}
Resource tags.
deployment_status str
host_name str
The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
id str
Resource ID.
location str
Resource location.
name str
Resource name.
profile_name str
The name of the profile which holds the endpoint.
provisioning_state str
Provisioning status
system_data SystemDataResponse
Read only system data
type str
Resource type.
auto_generated_domain_name_label_scope str
Indicates the endpoint name reuse scope. The default value is TenantReuse.
enabled_state str
Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
tags Mapping[str, str]
Resource tags.
deploymentStatus String
hostName String
The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
id String
Resource ID.
location String
Resource location.
name String
Resource name.
profileName String
The name of the profile which holds the endpoint.
provisioningState String
Provisioning status
systemData Property Map
Read only system data
type String
Resource type.
autoGeneratedDomainNameLabelScope String
Indicates the endpoint name reuse scope. The default value is TenantReuse.
enabledState String
Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
tags Map<String>
Resource tags.

Supporting Types

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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi