Gets an existing origin group within a profile.
Uses Azure REST API version 2025-06-01.
Other available API versions: 2023-05-01, 2023-07-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2024-09-01, 2025-01-01-preview, 2025-04-15, 2025-07-01-preview, 2025-09-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 getAFDOriginGroup
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 getAFDOriginGroup(args: GetAFDOriginGroupArgs, opts?: InvokeOptions): Promise<GetAFDOriginGroupResult>
function getAFDOriginGroupOutput(args: GetAFDOriginGroupOutputArgs, opts?: InvokeOptions): Output<GetAFDOriginGroupResult>def get_afd_origin_group(origin_group_name: Optional[str] = None,
profile_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAFDOriginGroupResult
def get_afd_origin_group_output(origin_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[GetAFDOriginGroupResult]func LookupAFDOriginGroup(ctx *Context, args *LookupAFDOriginGroupArgs, opts ...InvokeOption) (*LookupAFDOriginGroupResult, error)
func LookupAFDOriginGroupOutput(ctx *Context, args *LookupAFDOriginGroupOutputArgs, opts ...InvokeOption) LookupAFDOriginGroupResultOutput> Note: This function is named LookupAFDOriginGroup in the Go SDK.
public static class GetAFDOriginGroup
{
public static Task<GetAFDOriginGroupResult> InvokeAsync(GetAFDOriginGroupArgs args, InvokeOptions? opts = null)
public static Output<GetAFDOriginGroupResult> Invoke(GetAFDOriginGroupInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetAFDOriginGroupResult> getAFDOriginGroup(GetAFDOriginGroupArgs args, InvokeOptions options)
public static Output<GetAFDOriginGroupResult> getAFDOriginGroup(GetAFDOriginGroupArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:cdn:getAFDOriginGroup
arguments:
# arguments dictionaryThe following arguments are supported:
- Origin
Group stringName - Name of the origin group which is unique within the endpoint.
- 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.
- Origin
Group stringName - Name of the origin group which is unique within the endpoint.
- 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.
- origin
Group StringName - Name of the origin group which is unique within the endpoint.
- 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.
- origin
Group stringName - Name of the origin group which is unique within the endpoint.
- 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.
- origin_
group_ strname - Name of the origin group which is unique within the endpoint.
- 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.
- origin
Group StringName - Name of the origin group which is unique within the endpoint.
- 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.
getAFDOriginGroup Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Deployment
Status string - Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Name string
- The name of the resource
- Profile
Name string - The name of the profile which holds the origin group.
- Provisioning
State string - Provisioning status
- 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"
- Authentication
Pulumi.
Azure Native. Cdn. Outputs. Origin Authentication Properties Response - Authentication settings for origin in origin group.
- Health
Probe Pulumi.Settings Azure Native. Cdn. Outputs. Health Probe Parameters Response - Health probe settings to the origin that is used to determine the health of the origin.
- Load
Balancing Pulumi.Settings Azure Native. Cdn. Outputs. Load Balancing Settings Parameters Response - Load balancing settings for a backend pool
- Session
Affinity stringState - Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
- Traffic
Restoration intTime To Healed Or New Endpoints In Minutes - Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
- Azure
Api stringVersion - The Azure API version of the resource.
- Deployment
Status string - Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Name string
- The name of the resource
- Profile
Name string - The name of the profile which holds the origin group.
- Provisioning
State string - Provisioning status
- 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"
- Authentication
Origin
Authentication Properties Response - Authentication settings for origin in origin group.
- Health
Probe HealthSettings Probe Parameters Response - Health probe settings to the origin that is used to determine the health of the origin.
- Load
Balancing LoadSettings Balancing Settings Parameters Response - Load balancing settings for a backend pool
- Session
Affinity stringState - Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
- Traffic
Restoration intTime To Healed Or New Endpoints In Minutes - Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
- azure
Api StringVersion - The Azure API version of the resource.
- deployment
Status String - id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name String
- The name of the resource
- profile
Name String - The name of the profile which holds the origin group.
- provisioning
State String - Provisioning status
- 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"
- authentication
Origin
Authentication Properties Response - Authentication settings for origin in origin group.
- health
Probe HealthSettings Probe Parameters Response - Health probe settings to the origin that is used to determine the health of the origin.
- load
Balancing LoadSettings Balancing Settings Parameters Response - Load balancing settings for a backend pool
- session
Affinity StringState - Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
- traffic
Restoration IntegerTime To Healed Or New Endpoints In Minutes - Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
- azure
Api stringVersion - The Azure API version of the resource.
- deployment
Status string - id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name string
- The name of the resource
- profile
Name string - The name of the profile which holds the origin group.
- provisioning
State string - Provisioning status
- 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"
- authentication
Origin
Authentication Properties Response - Authentication settings for origin in origin group.
- health
Probe HealthSettings Probe Parameters Response - Health probe settings to the origin that is used to determine the health of the origin.
- load
Balancing LoadSettings Balancing Settings Parameters Response - Load balancing settings for a backend pool
- session
Affinity stringState - Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
- traffic
Restoration numberTime To Healed Or New Endpoints In Minutes - Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
- azure_
api_ strversion - The Azure API version of the resource.
- deployment_
status str - id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name str
- The name of the resource
- profile_
name str - The name of the profile which holds the origin group.
- provisioning_
state str - Provisioning status
- 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"
- authentication
Origin
Authentication Properties Response - Authentication settings for origin in origin group.
- health_
probe_ Healthsettings Probe Parameters Response - Health probe settings to the origin that is used to determine the health of the origin.
- load_
balancing_ Loadsettings Balancing Settings Parameters Response - Load balancing settings for a backend pool
- session_
affinity_ strstate - Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
- traffic_
restoration_ inttime_ to_ healed_ or_ new_ endpoints_ in_ minutes - Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
- azure
Api StringVersion - The Azure API version of the resource.
- deployment
Status String - id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name String
- The name of the resource
- profile
Name String - The name of the profile which holds the origin group.
- provisioning
State String - Provisioning status
- 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"
- authentication Property Map
- Authentication settings for origin in origin group.
- health
Probe Property MapSettings - Health probe settings to the origin that is used to determine the health of the origin.
- load
Balancing Property MapSettings - Load balancing settings for a backend pool
- session
Affinity StringState - Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
- traffic
Restoration NumberTime To Healed Or New Endpoints In Minutes - Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
Supporting Types
HealthProbeParametersResponse
- Probe
Interval intIn Seconds - The number of seconds between health probes.Default is 240sec.
- Probe
Path string - The path relative to the origin that is used to determine the health of the origin.
- Probe
Protocol string - Protocol to use for health probe.
- Probe
Request stringType - The type of health probe request that is made.
- Probe
Interval intIn Seconds - The number of seconds between health probes.Default is 240sec.
- Probe
Path string - The path relative to the origin that is used to determine the health of the origin.
- Probe
Protocol string - Protocol to use for health probe.
- Probe
Request stringType - The type of health probe request that is made.
- probe
Interval IntegerIn Seconds - The number of seconds between health probes.Default is 240sec.
- probe
Path String - The path relative to the origin that is used to determine the health of the origin.
- probe
Protocol String - Protocol to use for health probe.
- probe
Request StringType - The type of health probe request that is made.
- probe
Interval numberIn Seconds - The number of seconds between health probes.Default is 240sec.
- probe
Path string - The path relative to the origin that is used to determine the health of the origin.
- probe
Protocol string - Protocol to use for health probe.
- probe
Request stringType - The type of health probe request that is made.
- probe_
interval_ intin_ seconds - The number of seconds between health probes.Default is 240sec.
- probe_
path str - The path relative to the origin that is used to determine the health of the origin.
- probe_
protocol str - Protocol to use for health probe.
- probe_
request_ strtype - The type of health probe request that is made.
- probe
Interval NumberIn Seconds - The number of seconds between health probes.Default is 240sec.
- probe
Path String - The path relative to the origin that is used to determine the health of the origin.
- probe
Protocol String - Protocol to use for health probe.
- probe
Request StringType - The type of health probe request that is made.
LoadBalancingSettingsParametersResponse
- Additional
Latency intIn Milliseconds - The additional latency in milliseconds for probes to fall into the lowest latency bucket
- Sample
Size int - The number of samples to consider for load balancing decisions
- Successful
Samples intRequired - The number of samples within the sample period that must succeed
- Additional
Latency intIn Milliseconds - The additional latency in milliseconds for probes to fall into the lowest latency bucket
- Sample
Size int - The number of samples to consider for load balancing decisions
- Successful
Samples intRequired - The number of samples within the sample period that must succeed
- additional
Latency IntegerIn Milliseconds - The additional latency in milliseconds for probes to fall into the lowest latency bucket
- sample
Size Integer - The number of samples to consider for load balancing decisions
- successful
Samples IntegerRequired - The number of samples within the sample period that must succeed
- additional
Latency numberIn Milliseconds - The additional latency in milliseconds for probes to fall into the lowest latency bucket
- sample
Size number - The number of samples to consider for load balancing decisions
- successful
Samples numberRequired - The number of samples within the sample period that must succeed
- additional_
latency_ intin_ milliseconds - The additional latency in milliseconds for probes to fall into the lowest latency bucket
- sample_
size int - The number of samples to consider for load balancing decisions
- successful_
samples_ intrequired - The number of samples within the sample period that must succeed
- additional
Latency NumberIn Milliseconds - The additional latency in milliseconds for probes to fall into the lowest latency bucket
- sample
Size Number - The number of samples to consider for load balancing decisions
- successful
Samples NumberRequired - The number of samples within the sample period that must succeed
OriginAuthenticationPropertiesResponse
- Scope string
- The scope used when requesting token from Microsoft Entra. For example, for Azure Blob Storage, scope could be "https://storage.azure.com/.default".
- Type string
- The type of the authentication for the origin.
- User
Assigned Pulumi.Identity Azure Native. Cdn. Inputs. Resource Reference Response - The user assigned managed identity to use for the origin authentication if type is UserAssignedIdentity.
- Scope string
- The scope used when requesting token from Microsoft Entra. For example, for Azure Blob Storage, scope could be "https://storage.azure.com/.default".
- Type string
- The type of the authentication for the origin.
- User
Assigned ResourceIdentity Reference Response - The user assigned managed identity to use for the origin authentication if type is UserAssignedIdentity.
- scope String
- The scope used when requesting token from Microsoft Entra. For example, for Azure Blob Storage, scope could be "https://storage.azure.com/.default".
- type String
- The type of the authentication for the origin.
- user
Assigned ResourceIdentity Reference Response - The user assigned managed identity to use for the origin authentication if type is UserAssignedIdentity.
- scope string
- The scope used when requesting token from Microsoft Entra. For example, for Azure Blob Storage, scope could be "https://storage.azure.com/.default".
- type string
- The type of the authentication for the origin.
- user
Assigned ResourceIdentity Reference Response - The user assigned managed identity to use for the origin authentication if type is UserAssignedIdentity.
- scope str
- The scope used when requesting token from Microsoft Entra. For example, for Azure Blob Storage, scope could be "https://storage.azure.com/.default".
- type str
- The type of the authentication for the origin.
- user_
assigned_ Resourceidentity Reference Response - The user assigned managed identity to use for the origin authentication if type is UserAssignedIdentity.
- scope String
- The scope used when requesting token from Microsoft Entra. For example, for Azure Blob Storage, scope could be "https://storage.azure.com/.default".
- type String
- The type of the authentication for the origin.
- user
Assigned Property MapIdentity - The user assigned managed identity to use for the origin authentication if type is UserAssignedIdentity.
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
- 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.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
