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.66.0 published on Wednesday, Oct 9, 2024 by Pulumi
azure-native.cdn.getOriginGroup
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.66.0 published on Wednesday, Oct 9, 2024 by Pulumi
Gets an existing origin group within an endpoint. Azure REST API version: 2023-05-01.
Other available API versions: 2023-07-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2024-09-01.
Using getOriginGroup
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 getOriginGroup(args: GetOriginGroupArgs, opts?: InvokeOptions): Promise<GetOriginGroupResult>
function getOriginGroupOutput(args: GetOriginGroupOutputArgs, opts?: InvokeOptions): Output<GetOriginGroupResult>
def get_origin_group(endpoint_name: Optional[str] = None,
origin_group_name: Optional[str] = None,
profile_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetOriginGroupResult
def get_origin_group_output(endpoint_name: Optional[pulumi.Input[str]] = None,
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[GetOriginGroupResult]
func LookupOriginGroup(ctx *Context, args *LookupOriginGroupArgs, opts ...InvokeOption) (*LookupOriginGroupResult, error)
func LookupOriginGroupOutput(ctx *Context, args *LookupOriginGroupOutputArgs, opts ...InvokeOption) LookupOriginGroupResultOutput
> Note: This function is named LookupOriginGroup
in the Go SDK.
public static class GetOriginGroup
{
public static Task<GetOriginGroupResult> InvokeAsync(GetOriginGroupArgs args, InvokeOptions? opts = null)
public static Output<GetOriginGroupResult> Invoke(GetOriginGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetOriginGroupResult> getOriginGroup(GetOriginGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:cdn:getOriginGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Endpoint
Name string - Name of the endpoint under the profile which is unique globally.
- Origin
Group stringName - Name of the origin group which is unique within the endpoint.
- Profile
Name string - Name of the CDN profile which is unique within the resource group.
- Resource
Group stringName - Name of the Resource group within the Azure subscription.
- Endpoint
Name string - Name of the endpoint under the profile which is unique globally.
- Origin
Group stringName - Name of the origin group which is unique within the endpoint.
- Profile
Name string - Name of the CDN profile which is unique within the resource group.
- Resource
Group stringName - Name of the Resource group within the Azure subscription.
- endpoint
Name String - Name of the endpoint under the profile which is unique globally.
- origin
Group StringName - Name of the origin group which is unique within the endpoint.
- profile
Name String - Name of the CDN profile which is unique within the resource group.
- resource
Group StringName - Name of the Resource group within the Azure subscription.
- endpoint
Name string - Name of the endpoint under the profile which is unique globally.
- origin
Group stringName - Name of the origin group which is unique within the endpoint.
- profile
Name string - Name of the CDN profile which is unique within the resource group.
- resource
Group stringName - Name of the Resource group within the Azure subscription.
- endpoint_
name str - Name of the endpoint under the profile which is unique globally.
- origin_
group_ strname - 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_ strname - Name of the Resource group within the Azure subscription.
- endpoint
Name String - Name of the endpoint under the profile which is unique globally.
- origin
Group StringName - Name of the origin group which is unique within the endpoint.
- profile
Name String - Name of the CDN profile which is unique within the resource group.
- resource
Group StringName - Name of the Resource group within the Azure subscription.
getOriginGroup Result
The following output properties are available:
- Id string
- Resource ID.
- Name string
- Resource name.
- Origins
List<Pulumi.
Azure Native. Cdn. Outputs. Resource Reference Response> - The source of the content being delivered via CDN within given origin group.
- Provisioning
State string - Provisioning status of the origin group.
- Resource
State string - Resource status of the origin group.
- 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.
- Response
Based Pulumi.Origin Error Detection Settings Azure Native. Cdn. Outputs. Response Based Origin Error Detection Parameters Response - The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
- 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.
- Id string
- Resource ID.
- Name string
- Resource name.
- Origins
[]Resource
Reference Response - The source of the content being delivered via CDN within given origin group.
- Provisioning
State string - Provisioning status of the origin group.
- Resource
State string - Resource status of the origin group.
- 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.
- Response
Based ResponseOrigin Error Detection Settings Based Origin Error Detection Parameters Response - The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
- 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.
- id String
- Resource ID.
- name String
- Resource name.
- origins
List<Resource
Reference Response> - The source of the content being delivered via CDN within given origin group.
- provisioning
State String - Provisioning status of the origin group.
- resource
State String - Resource status of the origin group.
- 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.
- response
Based ResponseOrigin Error Detection Settings Based Origin Error Detection Parameters Response - The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
- 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.
- id string
- Resource ID.
- name string
- Resource name.
- origins
Resource
Reference Response[] - The source of the content being delivered via CDN within given origin group.
- provisioning
State string - Provisioning status of the origin group.
- resource
State string - Resource status of the origin group.
- 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.
- response
Based ResponseOrigin Error Detection Settings Based Origin Error Detection Parameters Response - The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
- 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.
- id str
- Resource ID.
- name str
- Resource name.
- origins
Sequence[Resource
Reference Response] - The source of the content being delivered via CDN within given origin group.
- provisioning_
state str - Provisioning status of the origin group.
- resource_
state str - Resource status of the origin group.
- 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.
- response_
based_ Responseorigin_ error_ detection_ settings Based Origin Error Detection Parameters Response - The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
- 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.
- id String
- Resource ID.
- name String
- Resource name.
- origins List<Property Map>
- The source of the content being delivered via CDN within given origin group.
- provisioning
State String - Provisioning status of the origin group.
- resource
State String - Resource status of the origin group.
- 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.
- response
Based Property MapOrigin Error Detection Settings - The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
- 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.
HttpErrorRangeParametersResponse
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.
ResponseBasedOriginErrorDetectionParametersResponse
- Http
Error List<Pulumi.Ranges Azure Native. Cdn. Inputs. Http Error Range Parameters Response> - The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
- Response
Based stringDetected Error Types - Type of response errors for real user requests for which origin will be deemed unhealthy
- Response
Based intFailover Threshold Percentage - The percentage of failed requests in the sample where failover should trigger.
- Http
Error []HttpRanges Error Range Parameters Response - The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
- Response
Based stringDetected Error Types - Type of response errors for real user requests for which origin will be deemed unhealthy
- Response
Based intFailover Threshold Percentage - The percentage of failed requests in the sample where failover should trigger.
- http
Error List<HttpRanges Error Range Parameters Response> - The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
- response
Based StringDetected Error Types - Type of response errors for real user requests for which origin will be deemed unhealthy
- response
Based IntegerFailover Threshold Percentage - The percentage of failed requests in the sample where failover should trigger.
- http
Error HttpRanges Error Range Parameters Response[] - The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
- response
Based stringDetected Error Types - Type of response errors for real user requests for which origin will be deemed unhealthy
- response
Based numberFailover Threshold Percentage - The percentage of failed requests in the sample where failover should trigger.
- http_
error_ Sequence[Httpranges Error Range Parameters Response] - The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
- response_
based_ strdetected_ error_ types - Type of response errors for real user requests for which origin will be deemed unhealthy
- response_
based_ intfailover_ threshold_ percentage - The percentage of failed requests in the sample where failover should trigger.
- http
Error List<Property Map>Ranges - The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.
- response
Based StringDetected Error Types - Type of response errors for real user requests for which origin will be deemed unhealthy
- response
Based NumberFailover Threshold Percentage - The percentage of failed requests in the sample where failover should trigger.
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.66.0 published on Wednesday, Oct 9, 2024 by Pulumi