Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. cdn
  5. getOrigin
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.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.cdn.getOrigin

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.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    Gets an existing origin 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.

    Using getOrigin

    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 getOrigin(args: GetOriginArgs, opts?: InvokeOptions): Promise<GetOriginResult>
function getOriginOutput(args: GetOriginOutputArgs, opts?: InvokeOptions): Output<GetOriginResult>
    def get_origin(endpoint_name: Optional[str] = None,
               origin_name: Optional[str] = None,
               profile_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetOriginResult
def get_origin_output(endpoint_name: Optional[pulumi.Input[str]] = None,
               origin_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[GetOriginResult]
    func LookupOrigin(ctx *Context, args *LookupOriginArgs, opts ...InvokeOption) (*LookupOriginResult, error)
func LookupOriginOutput(ctx *Context, args *LookupOriginOutputArgs, opts ...InvokeOption) LookupOriginResultOutput

    > Note: This function is named LookupOrigin in the Go SDK.

    public static class GetOrigin 
{
    public static Task<GetOriginResult> InvokeAsync(GetOriginArgs args, InvokeOptions? opts = null)
    public static Output<GetOriginResult> Invoke(GetOriginInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOriginResult> getOrigin(GetOriginArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    EndpointName string
    Name of the endpoint under the profile which is unique globally.
    OriginName string
    Name of the origin 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.
    OriginName string
    Name of the origin 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.
    originName String
    Name of the origin 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.
    originName string
    Name of the origin 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_name str
    Name of the origin 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.
    originName String
    Name of the origin 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.

    getOrigin Result

    The following output properties are available:

    HostName string
    The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
    Id string
    Resource ID.
    Name string
    Resource name.
    PrivateEndpointStatus string
    The approval status for the connection to the Private Link
    ProvisioningState string
    Provisioning status of the origin.
    ResourceState string
    Resource status of the origin.
    SystemData Pulumi.AzureNative.Cdn.Outputs.SystemDataResponse
    Read only system data
    Type string
    Resource type.
    Enabled bool
    Origin is enabled for load balancing or not
    HttpPort int
    The value of the HTTP port. Must be between 1 and 65535.
    HttpsPort int
    The value of the HTTPS port. Must be between 1 and 65535.
    OriginHostHeader string
    The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
    Priority int
    Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
    PrivateLinkAlias string
    The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
    PrivateLinkApprovalMessage string
    A custom message to be included in the approval request to connect to the Private Link.
    PrivateLinkLocation string
    The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
    PrivateLinkResourceId string
    The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
    Weight int
    Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
    HostName string
    The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
    Id string
    Resource ID.
    Name string
    Resource name.
    PrivateEndpointStatus string
    The approval status for the connection to the Private Link
    ProvisioningState string
    Provisioning status of the origin.
    ResourceState string
    Resource status of the origin.
    SystemData SystemDataResponse
    Read only system data
    Type string
    Resource type.
    Enabled bool
    Origin is enabled for load balancing or not
    HttpPort int
    The value of the HTTP port. Must be between 1 and 65535.
    HttpsPort int
    The value of the HTTPS port. Must be between 1 and 65535.
    OriginHostHeader string
    The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
    Priority int
    Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
    PrivateLinkAlias string
    The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
    PrivateLinkApprovalMessage string
    A custom message to be included in the approval request to connect to the Private Link.
    PrivateLinkLocation string
    The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
    PrivateLinkResourceId string
    The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
    Weight int
    Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
    hostName String
    The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
    id String
    Resource ID.
    name String
    Resource name.
    privateEndpointStatus String
    The approval status for the connection to the Private Link
    provisioningState String
    Provisioning status of the origin.
    resourceState String
    Resource status of the origin.
    systemData SystemDataResponse
    Read only system data
    type String
    Resource type.
    enabled Boolean
    Origin is enabled for load balancing or not
    httpPort Integer
    The value of the HTTP port. Must be between 1 and 65535.
    httpsPort Integer
    The value of the HTTPS port. Must be between 1 and 65535.
    originHostHeader String
    The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
    priority Integer
    Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
    privateLinkAlias String
    The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
    privateLinkApprovalMessage String
    A custom message to be included in the approval request to connect to the Private Link.
    privateLinkLocation String
    The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
    privateLinkResourceId String
    The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
    weight Integer
    Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
    hostName string
    The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
    id string
    Resource ID.
    name string
    Resource name.
    privateEndpointStatus string
    The approval status for the connection to the Private Link
    provisioningState string
    Provisioning status of the origin.
    resourceState string
    Resource status of the origin.
    systemData SystemDataResponse
    Read only system data
    type string
    Resource type.
    enabled boolean
    Origin is enabled for load balancing or not
    httpPort number
    The value of the HTTP port. Must be between 1 and 65535.
    httpsPort number
    The value of the HTTPS port. Must be between 1 and 65535.
    originHostHeader string
    The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
    priority number
    Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
    privateLinkAlias string
    The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
    privateLinkApprovalMessage string
    A custom message to be included in the approval request to connect to the Private Link.
    privateLinkLocation string
    The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
    privateLinkResourceId string
    The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
    weight number
    Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
    host_name str
    The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
    id str
    Resource ID.
    name str
    Resource name.
    private_endpoint_status str
    The approval status for the connection to the Private Link
    provisioning_state str
    Provisioning status of the origin.
    resource_state str
    Resource status of the origin.
    system_data SystemDataResponse
    Read only system data
    type str
    Resource type.
    enabled bool
    Origin is enabled for load balancing or not
    http_port int
    The value of the HTTP port. Must be between 1 and 65535.
    https_port int
    The value of the HTTPS port. Must be between 1 and 65535.
    origin_host_header str
    The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
    priority int
    Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
    private_link_alias str
    The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
    private_link_approval_message str
    A custom message to be included in the approval request to connect to the Private Link.
    private_link_location str
    The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
    private_link_resource_id str
    The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
    weight int
    Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
    hostName String
    The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
    id String
    Resource ID.
    name String
    Resource name.
    privateEndpointStatus String
    The approval status for the connection to the Private Link
    provisioningState String
    Provisioning status of the origin.
    resourceState String
    Resource status of the origin.
    systemData Property Map
    Read only system data
    type String
    Resource type.
    enabled Boolean
    Origin is enabled for load balancing or not
    httpPort Number
    The value of the HTTP port. Must be between 1 and 65535.
    httpsPort Number
    The value of the HTTPS port. Must be between 1 and 65535.
    originHostHeader String
    The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
    priority Number
    Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
    privateLinkAlias String
    The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
    privateLinkApprovalMessage String
    A custom message to be included in the approval request to connect to the Private Link.
    privateLinkLocation String
    The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
    privateLinkResourceId String
    The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
    weight Number
    Weight of the origin in given origin group for load balancing. Must be between 1 and 1000

    Supporting Types

    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.47.1 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure-native