1. Packages
  2. Azure Native
  3. API Docs
  4. cdn
  5. getOriginGroup
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.20.1 published on Friday, Dec 1, 2023 by Pulumi

azure-native.cdn.getOriginGroup

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.20.1 published on Friday, Dec 1, 2023 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.

    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:

    EndpointName string

    Name of the endpoint under the profile which is unique globally.

    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.

    EndpointName string

    Name of the endpoint under the profile which is unique globally.

    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.

    endpointName String

    Name of the endpoint under the profile which is unique globally.

    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.

    endpointName string

    Name of the endpoint under the profile which is unique globally.

    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.

    endpoint_name str

    Name of the endpoint under the profile which is unique globally.

    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.

    endpointName String

    Name of the endpoint under the profile which is unique globally.

    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.

    getOriginGroup Result

    The following output properties are available:

    Id string

    Resource ID.

    Name string

    Resource name.

    Origins List<Pulumi.AzureNative.Cdn.Outputs.ResourceReferenceResponse>

    The source of the content being delivered via CDN within given origin group.

    ProvisioningState string

    Provisioning status of the origin group.

    ResourceState string

    Resource status of the origin group.

    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.

    ResponseBasedOriginErrorDetectionSettings 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.

    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.

    Id string

    Resource ID.

    Name string

    Resource name.

    Origins []ResourceReferenceResponse

    The source of the content being delivered via CDN within given origin group.

    ProvisioningState string

    Provisioning status of the origin group.

    ResourceState string

    Resource status of the origin group.

    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.

    ResponseBasedOriginErrorDetectionSettings ResponseBasedOriginErrorDetectionParametersResponse

    The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.

    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.

    id String

    Resource ID.

    name String

    Resource name.

    origins List<ResourceReferenceResponse>

    The source of the content being delivered via CDN within given origin group.

    provisioningState String

    Provisioning status of the origin group.

    resourceState String

    Resource status of the origin group.

    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.

    responseBasedOriginErrorDetectionSettings ResponseBasedOriginErrorDetectionParametersResponse

    The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.

    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.

    id string

    Resource ID.

    name string

    Resource name.

    origins ResourceReferenceResponse[]

    The source of the content being delivered via CDN within given origin group.

    provisioningState string

    Provisioning status of the origin group.

    resourceState string

    Resource status of the origin group.

    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.

    responseBasedOriginErrorDetectionSettings ResponseBasedOriginErrorDetectionParametersResponse

    The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.

    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.

    id str

    Resource ID.

    name str

    Resource name.

    origins Sequence[ResourceReferenceResponse]

    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 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.

    response_based_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.

    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.

    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.

    provisioningState String

    Provisioning status of the origin group.

    resourceState String

    Resource status of the origin group.

    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.

    responseBasedOriginErrorDetectionSettings Property Map

    The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.

    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.

    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

    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
    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.20.1 published on Friday, Dec 1, 2023 by Pulumi