Azure Native v1.102.0, May 2 23

azure-native.cdn.getAFDOriginGroup

Explore with Pulumi AI

Gets an existing origin group within a profile. API Version: 2020-09-01.

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)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:cdn:getAFDOriginGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

OriginGroupName string: Name of the origin group which is unique within the endpoint.
ProfileName string: Name of the CDN profile which is unique within the resource group.
ResourceGroupName string: Name of the Resource group within the Azure subscription.

OriginGroupName string: Name of the origin group which is unique within the endpoint.
ProfileName string: Name of the CDN profile which is unique within the resource group.
ResourceGroupName string: Name of the Resource group within the Azure subscription.

originGroupName String: Name of the origin group which is unique within the endpoint.
profileName String: Name of the CDN profile which is unique within the resource group.
resourceGroupName String: Name of the Resource group within the Azure subscription.

originGroupName string: Name of the origin group which is unique within the endpoint.
profileName string: Name of the CDN profile which is unique within the resource group.
resourceGroupName string: Name of the Resource group within the Azure subscription.

origin_group_name str: Name of the origin group which is unique within the endpoint.
profile_name str: Name of the CDN profile which is unique within the resource group.
resource_group_name str: Name of the Resource group within the Azure subscription.

originGroupName String: Name of the origin group which is unique within the endpoint.
profileName String: Name of the CDN profile which is unique within the resource group.
resourceGroupName String: Name of the Resource group within the Azure subscription.

getAFDOriginGroup Result

The following output properties are available:

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.
HealthProbeSettings Pulumi.AzureNative.Cdn.Outputs.HealthProbeParametersResponse: Health probe settings to the origin that is used to determine the health of the origin.
LoadBalancingSettings Pulumi.AzureNative.Cdn.Outputs.LoadBalancingSettingsParametersResponse: Load balancing settings for a backend pool
ResponseBasedAfdOriginErrorDetectionSettings Pulumi.AzureNative.Cdn.Outputs.ResponseBasedOriginErrorDetectionParametersResponse: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
SessionAffinityState string: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
TrafficRestorationTimeToHealedOrNewEndpointsInMinutes int: 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.

DeploymentStatus string
Id string: Resource ID.
Name string: Resource name.
ProvisioningState string: Provisioning status
SystemData SystemDataResponse: Read only system data
Type string: Resource type.
HealthProbeSettings HealthProbeParametersResponse: Health probe settings to the origin that is used to determine the health of the origin.
LoadBalancingSettings LoadBalancingSettingsParametersResponse: Load balancing settings for a backend pool
ResponseBasedAfdOriginErrorDetectionSettings ResponseBasedOriginErrorDetectionParametersResponse: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
SessionAffinityState string: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
TrafficRestorationTimeToHealedOrNewEndpointsInMinutes int: 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.

deploymentStatus String
id String: Resource ID.
name String: Resource name.
provisioningState String: Provisioning status
systemData SystemDataResponse: Read only system data
type String: Resource type.
healthProbeSettings HealthProbeParametersResponse: Health probe settings to the origin that is used to determine the health of the origin.
loadBalancingSettings LoadBalancingSettingsParametersResponse: Load balancing settings for a backend pool
responseBasedAfdOriginErrorDetectionSettings ResponseBasedOriginErrorDetectionParametersResponse: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
sessionAffinityState String: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
trafficRestorationTimeToHealedOrNewEndpointsInMinutes Integer: 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.

deploymentStatus string
id string: Resource ID.
name string: Resource name.
provisioningState string: Provisioning status
systemData SystemDataResponse: Read only system data
type string: Resource type.
healthProbeSettings HealthProbeParametersResponse: Health probe settings to the origin that is used to determine the health of the origin.
loadBalancingSettings LoadBalancingSettingsParametersResponse: Load balancing settings for a backend pool
responseBasedAfdOriginErrorDetectionSettings ResponseBasedOriginErrorDetectionParametersResponse: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
sessionAffinityState string: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
trafficRestorationTimeToHealedOrNewEndpointsInMinutes number: 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.

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.
health_probe_settings HealthProbeParametersResponse: Health probe settings to the origin that is used to determine the health of the origin.
load_balancing_settings LoadBalancingSettingsParametersResponse: Load balancing settings for a backend pool
response_based_afd_origin_error_detection_settings ResponseBasedOriginErrorDetectionParametersResponse: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
session_affinity_state str: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
traffic_restoration_time_to_healed_or_new_endpoints_in_minutes int: 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.

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.
healthProbeSettings Property Map: Health probe settings to the origin that is used to determine the health of the origin.
loadBalancingSettings Property Map: Load balancing settings for a backend pool
responseBasedAfdOriginErrorDetectionSettings Property Map: The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
sessionAffinityState String: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
trafficRestorationTimeToHealedOrNewEndpointsInMinutes Number: 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

ProbeIntervalInSeconds int: The number of seconds between health probes.Default is 240sec.
ProbePath string: The path relative to the origin that is used to determine the health of the origin.
ProbeProtocol string: Protocol to use for health probe.
ProbeRequestType string: The type of health probe request that is made.

ProbeIntervalInSeconds int: The number of seconds between health probes.Default is 240sec.
ProbePath string: The path relative to the origin that is used to determine the health of the origin.
ProbeProtocol string: Protocol to use for health probe.
ProbeRequestType string: The type of health probe request that is made.

probeIntervalInSeconds Integer: The number of seconds between health probes.Default is 240sec.
probePath String: The path relative to the origin that is used to determine the health of the origin.
probeProtocol String: Protocol to use for health probe.
probeRequestType String: The type of health probe request that is made.

probeIntervalInSeconds number: The number of seconds between health probes.Default is 240sec.
probePath string: The path relative to the origin that is used to determine the health of the origin.
probeProtocol string: Protocol to use for health probe.
probeRequestType string: The type of health probe request that is made.

probe_interval_in_seconds int: 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_type str: The type of health probe request that is made.

probeIntervalInSeconds Number: The number of seconds between health probes.Default is 240sec.
probePath String: The path relative to the origin that is used to determine the health of the origin.
probeProtocol String: Protocol to use for health probe.
probeRequestType String: The type of health probe request that is made.

HttpErrorRangeParametersResponse

Begin int: The inclusive start of the http status code range.
End int: The inclusive end of the http status code range.

Begin int: The inclusive start of the http status code range.
End int: The inclusive end of the http status code range.

begin Integer: The inclusive start of the http status code range.
end Integer: The inclusive end of the http status code range.

begin number: The inclusive start of the http status code range.
end number: The inclusive end of the http status code range.

begin int: The inclusive start of the http status code range.
end int: The inclusive end of the http status code range.

begin Number: The inclusive start of the http status code range.
end Number: The inclusive end of the http status code range.

LoadBalancingSettingsParametersResponse

AdditionalLatencyInMilliseconds int: The additional latency in milliseconds for probes to fall into the lowest latency bucket
SampleSize int: The number of samples to consider for load balancing decisions
SuccessfulSamplesRequired int: The number of samples within the sample period that must succeed

AdditionalLatencyInMilliseconds int: The additional latency in milliseconds for probes to fall into the lowest latency bucket
SampleSize int: The number of samples to consider for load balancing decisions
SuccessfulSamplesRequired int: The number of samples within the sample period that must succeed

additionalLatencyInMilliseconds Integer: The additional latency in milliseconds for probes to fall into the lowest latency bucket
sampleSize Integer: The number of samples to consider for load balancing decisions
successfulSamplesRequired Integer: The number of samples within the sample period that must succeed

additionalLatencyInMilliseconds number: The additional latency in milliseconds for probes to fall into the lowest latency bucket
sampleSize number: The number of samples to consider for load balancing decisions
successfulSamplesRequired number: The number of samples within the sample period that must succeed

additional_latency_in_milliseconds int: 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_required int: The number of samples within the sample period that must succeed

additionalLatencyInMilliseconds Number: The additional latency in milliseconds for probes to fall into the lowest latency bucket
sampleSize Number: The number of samples to consider for load balancing decisions
successfulSamplesRequired Number: The number of samples within the sample period that must succeed

ResponseBasedOriginErrorDetectionParametersResponse

HttpErrorRanges List<Pulumi.AzureNative.Cdn.Inputs.HttpErrorRangeParametersResponse>: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
ResponseBasedDetectedErrorTypes string: Type of response errors for real user requests for which origin will be deemed unhealthy
ResponseBasedFailoverThresholdPercentage int: The percentage of failed requests in the sample where failover should trigger.

HttpErrorRanges []HttpErrorRangeParametersResponse: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
ResponseBasedDetectedErrorTypes string: Type of response errors for real user requests for which origin will be deemed unhealthy
ResponseBasedFailoverThresholdPercentage int: The percentage of failed requests in the sample where failover should trigger.

httpErrorRanges List<HttpErrorRangeParametersResponse>: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
responseBasedDetectedErrorTypes String: Type of response errors for real user requests for which origin will be deemed unhealthy
responseBasedFailoverThresholdPercentage Integer: The percentage of failed requests in the sample where failover should trigger.

httpErrorRanges HttpErrorRangeParametersResponse[]: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
responseBasedDetectedErrorTypes string: Type of response errors for real user requests for which origin will be deemed unhealthy
responseBasedFailoverThresholdPercentage number: The percentage of failed requests in the sample where failover should trigger.

http_error_ranges Sequence[HttpErrorRangeParametersResponse]: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
response_based_detected_error_types str: Type of response errors for real user requests for which origin will be deemed unhealthy
response_based_failover_threshold_percentage int: The percentage of failed requests in the sample where failover should trigger.

httpErrorRanges List<Property Map>: The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
responseBasedDetectedErrorTypes String: Type of response errors for real user requests for which origin will be deemed unhealthy
responseBasedFailoverThresholdPercentage Number: The percentage of failed requests in the sample where failover should trigger.

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