1. Packages
  2. Azure Native
  3. API Docs
  4. cdn
  5. getAFDOriginGroup
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.21.0 published on Tuesday, Dec 5, 2023 by Pulumi

azure-native.cdn.getAFDOriginGroup

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.21.0 published on Tuesday, Dec 5, 2023 by Pulumi

    Gets an existing origin group within a profile. Azure REST API version: 2023-05-01.

    Other available API versions: 2020-09-01, 2023-07-01-preview.

    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 Azure Front Door Standard or Azure Front Door Premium 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 Azure Front Door Standard or Azure Front Door Premium 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 Azure Front Door Standard or Azure Front Door Premium 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 Azure Front Door Standard or Azure Front Door Premium 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 Azure Front Door Standard or Azure Front Door Premium 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 Azure Front Door Standard or Azure Front Door Premium 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.

    ProfileName string

    The name of the profile which holds the origin group.

    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

    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.

    ProfileName string

    The name of the profile which holds the origin group.

    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

    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.

    profileName String

    The name of the profile which holds the origin group.

    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

    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.

    profileName string

    The name of the profile which holds the origin group.

    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

    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.

    profile_name str

    The name of the profile which holds the origin group.

    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

    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.

    profileName String

    The name of the profile which holds the origin group.

    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

    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.

    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

    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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.21.0 published on Tuesday, Dec 5, 2023 by Pulumi