1. Packages
  2. Azure Native
  3. API Docs
  4. cdn
  5. getAFDOrigin
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.46.0 published on Friday, Jun 21, 2024 by Pulumi

azure-native.cdn.getAFDOrigin

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.46.0 published on Friday, Jun 21, 2024 by Pulumi

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

    Other available API versions: 2023-07-01-preview, 2024-02-01.

    Using getAFDOrigin

    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 getAFDOrigin(args: GetAFDOriginArgs, opts?: InvokeOptions): Promise<GetAFDOriginResult>
    function getAFDOriginOutput(args: GetAFDOriginOutputArgs, opts?: InvokeOptions): Output<GetAFDOriginResult>
    def get_afd_origin(origin_group_name: Optional[str] = None,
                       origin_name: Optional[str] = None,
                       profile_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetAFDOriginResult
    def get_afd_origin_output(origin_group_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[GetAFDOriginResult]
    func LookupAFDOrigin(ctx *Context, args *LookupAFDOriginArgs, opts ...InvokeOption) (*LookupAFDOriginResult, error)
    func LookupAFDOriginOutput(ctx *Context, args *LookupAFDOriginOutputArgs, opts ...InvokeOption) LookupAFDOriginResultOutput

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

    public static class GetAFDOrigin 
    {
        public static Task<GetAFDOriginResult> InvokeAsync(GetAFDOriginArgs args, InvokeOptions? opts = null)
        public static Output<GetAFDOriginResult> Invoke(GetAFDOriginInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAFDOriginResult> getAFDOrigin(GetAFDOriginArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:cdn:getAFDOrigin
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OriginGroupName string
    Name of the origin group which is unique within the profile.
    OriginName string
    Name of the origin which is unique within the profile.
    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 profile.
    OriginName string
    Name of the origin which is unique within the profile.
    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 profile.
    originName String
    Name of the origin which is unique within the profile.
    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 profile.
    originName string
    Name of the origin which is unique within the profile.
    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 profile.
    origin_name str
    Name of the origin which is unique within the profile.
    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 profile.
    originName String
    Name of the origin which is unique within the profile.
    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.

    getAFDOrigin Result

    The following output properties are available:

    DeploymentStatus string
    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.
    OriginGroupName string
    The name of the origin group which contains this origin.
    ProvisioningState string
    Provisioning status
    SystemData Pulumi.AzureNative.Cdn.Outputs.SystemDataResponse
    Read only system data
    Type string
    Resource type.
    AzureOrigin Pulumi.AzureNative.Cdn.Outputs.ResourceReferenceResponse
    Resource reference to the Azure origin resource.
    EnabledState string
    Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
    EnforceCertificateNameCheck bool
    Whether to enable certificate name check at origin level
    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 Front Door 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
    SharedPrivateLinkResource Pulumi.AzureNative.Cdn.Outputs.SharedPrivateLinkResourcePropertiesResponse
    The properties of the private link resource for private origin.
    Weight int
    Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
    DeploymentStatus string
    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.
    OriginGroupName string
    The name of the origin group which contains this origin.
    ProvisioningState string
    Provisioning status
    SystemData SystemDataResponse
    Read only system data
    Type string
    Resource type.
    AzureOrigin ResourceReferenceResponse
    Resource reference to the Azure origin resource.
    EnabledState string
    Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
    EnforceCertificateNameCheck bool
    Whether to enable certificate name check at origin level
    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 Front Door 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
    SharedPrivateLinkResource SharedPrivateLinkResourcePropertiesResponse
    The properties of the private link resource for private origin.
    Weight int
    Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
    deploymentStatus String
    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.
    originGroupName String
    The name of the origin group which contains this origin.
    provisioningState String
    Provisioning status
    systemData SystemDataResponse
    Read only system data
    type String
    Resource type.
    azureOrigin ResourceReferenceResponse
    Resource reference to the Azure origin resource.
    enabledState String
    Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
    enforceCertificateNameCheck Boolean
    Whether to enable certificate name check at origin level
    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 Front Door 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
    sharedPrivateLinkResource SharedPrivateLinkResourcePropertiesResponse
    The properties of the private link resource for private origin.
    weight Integer
    Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
    deploymentStatus string
    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.
    originGroupName string
    The name of the origin group which contains this origin.
    provisioningState string
    Provisioning status
    systemData SystemDataResponse
    Read only system data
    type string
    Resource type.
    azureOrigin ResourceReferenceResponse
    Resource reference to the Azure origin resource.
    enabledState string
    Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
    enforceCertificateNameCheck boolean
    Whether to enable certificate name check at origin level
    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 Front Door 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
    sharedPrivateLinkResource SharedPrivateLinkResourcePropertiesResponse
    The properties of the private link resource for private origin.
    weight number
    Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
    deployment_status str
    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.
    origin_group_name str
    The name of the origin group which contains this origin.
    provisioning_state str
    Provisioning status
    system_data SystemDataResponse
    Read only system data
    type str
    Resource type.
    azure_origin ResourceReferenceResponse
    Resource reference to the Azure origin resource.
    enabled_state str
    Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
    enforce_certificate_name_check bool
    Whether to enable certificate name check at origin level
    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 Front Door 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
    shared_private_link_resource SharedPrivateLinkResourcePropertiesResponse
    The properties of the private link resource for private origin.
    weight int
    Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
    deploymentStatus String
    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.
    originGroupName String
    The name of the origin group which contains this origin.
    provisioningState String
    Provisioning status
    systemData Property Map
    Read only system data
    type String
    Resource type.
    azureOrigin Property Map
    Resource reference to the Azure origin resource.
    enabledState String
    Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
    enforceCertificateNameCheck Boolean
    Whether to enable certificate name check at origin level
    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 Front Door 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
    sharedPrivateLinkResource Property Map
    The properties of the private link resource for private origin.
    weight Number
    Weight of the origin in given origin group for load balancing. Must be between 1 and 1000

    Supporting Types

    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.

    SharedPrivateLinkResourcePropertiesResponse

    GroupId string
    The group id from the provider of resource the shared private link resource is for.
    PrivateLink Pulumi.AzureNative.Cdn.Inputs.ResourceReferenceResponse
    The resource id of the resource the shared private link resource is for.
    PrivateLinkLocation string
    The location of the shared private link resource
    RequestMessage string
    The request message for requesting approval of the shared private link resource.
    Status string
    Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.
    GroupId string
    The group id from the provider of resource the shared private link resource is for.
    PrivateLink ResourceReferenceResponse
    The resource id of the resource the shared private link resource is for.
    PrivateLinkLocation string
    The location of the shared private link resource
    RequestMessage string
    The request message for requesting approval of the shared private link resource.
    Status string
    Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.
    groupId String
    The group id from the provider of resource the shared private link resource is for.
    privateLink ResourceReferenceResponse
    The resource id of the resource the shared private link resource is for.
    privateLinkLocation String
    The location of the shared private link resource
    requestMessage String
    The request message for requesting approval of the shared private link resource.
    status String
    Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.
    groupId string
    The group id from the provider of resource the shared private link resource is for.
    privateLink ResourceReferenceResponse
    The resource id of the resource the shared private link resource is for.
    privateLinkLocation string
    The location of the shared private link resource
    requestMessage string
    The request message for requesting approval of the shared private link resource.
    status string
    Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.
    group_id str
    The group id from the provider of resource the shared private link resource is for.
    private_link ResourceReferenceResponse
    The resource id of the resource the shared private link resource is for.
    private_link_location str
    The location of the shared private link resource
    request_message str
    The request message for requesting approval of the shared private link resource.
    status str
    Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.
    groupId String
    The group id from the provider of resource the shared private link resource is for.
    privateLink Property Map
    The resource id of the resource the shared private link resource is for.
    privateLinkLocation String
    The location of the shared private link resource
    requestMessage String
    The request message for requesting approval of the shared private link resource.
    status String
    Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.

    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.46.0 published on Friday, Jun 21, 2024 by Pulumi