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.77.0 published on Thursday, Dec 12, 2024 by Pulumi
azure-native.cdn.getAFDOriginGroup
Explore with Pulumi AI
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.77.0 published on Thursday, Dec 12, 2024 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, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2024-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:
- 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 profile which is unique within the resource group.
- Resource
Group stringName - Name of the Resource group within the Azure subscription.
- 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 profile which is unique within the resource group.
- Resource
Group stringName - Name of the Resource group within the Azure subscription.
- 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 profile which is unique within the resource group.
- resource
Group StringName - Name of the Resource group within the Azure subscription.
- 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 profile which is unique within the resource group.
- resource
Group stringName - Name of the Resource group within the Azure subscription.
- 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 profile which is unique within the resource group.
- resource_
group_ strname - Name of the Resource group within the Azure subscription.
- 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 profile which is unique within the resource group.
- resource
Group StringName - Name of the Resource group within the Azure subscription.
getAFDOriginGroup Result
The following output properties are available:
- Deployment
Status string - Id string
- Resource ID.
- Name string
- Resource name.
- 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 - Read only system data
- Type string
- Resource type.
- 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.
- Deployment
Status string - Id string
- Resource ID.
- Name string
- Resource name.
- Profile
Name string - The name of the profile which holds the origin group.
- Provisioning
State string - Provisioning status
- System
Data SystemData Response - Read only system data
- Type string
- Resource type.
- 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.
- deployment
Status String - id String
- Resource ID.
- name String
- Resource name.
- profile
Name String - The name of the profile which holds the origin group.
- provisioning
State String - Provisioning status
- system
Data SystemData Response - Read only system data
- type String
- Resource type.
- 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.
- deployment
Status string - id string
- Resource ID.
- name string
- Resource name.
- profile
Name string - The name of the profile which holds the origin group.
- provisioning
State string - Provisioning status
- system
Data SystemData Response - Read only system data
- type string
- Resource type.
- 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.
- 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 SystemData Response - Read only system data
- type str
- Resource type.
- 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.
- deployment
Status String - id String
- Resource ID.
- name String
- Resource name.
- profile
Name String - The name of the profile which holds the origin group.
- provisioning
State String - Provisioning status
- system
Data Property Map - Read only system data
- type String
- Resource type.
- 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
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC)
- Created
By string - An identifier for 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 - An identifier for 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 - An identifier for 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 - An identifier for 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 - An identifier for 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 - An identifier for 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 - An identifier for 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 - An identifier for 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 - An identifier for 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 - An identifier for 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 - An identifier for 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 - An identifier for 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
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.77.0 published on Thursday, Dec 12, 2024 by Pulumi