Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. deviceregistry
  5. getAssetEndpointProfile
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.deviceregistry.getAssetEndpointProfile

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get a AssetEndpointProfile

    Uses Azure REST API version 2024-11-01.

    Other available API versions: 2023-11-01-preview, 2024-09-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native deviceregistry [ApiVersion]. See the version guide for details.

    Using getAssetEndpointProfile

    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 getAssetEndpointProfile(args: GetAssetEndpointProfileArgs, opts?: InvokeOptions): Promise<GetAssetEndpointProfileResult>
function getAssetEndpointProfileOutput(args: GetAssetEndpointProfileOutputArgs, opts?: InvokeOptions): Output<GetAssetEndpointProfileResult>
    def get_asset_endpoint_profile(asset_endpoint_profile_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetAssetEndpointProfileResult
def get_asset_endpoint_profile_output(asset_endpoint_profile_name: Optional[pulumi.Input[str]] = None,
                               resource_group_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetAssetEndpointProfileResult]
    func LookupAssetEndpointProfile(ctx *Context, args *LookupAssetEndpointProfileArgs, opts ...InvokeOption) (*LookupAssetEndpointProfileResult, error)
func LookupAssetEndpointProfileOutput(ctx *Context, args *LookupAssetEndpointProfileOutputArgs, opts ...InvokeOption) LookupAssetEndpointProfileResultOutput

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

    public static class GetAssetEndpointProfile 
{
    public static Task<GetAssetEndpointProfileResult> InvokeAsync(GetAssetEndpointProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetAssetEndpointProfileResult> Invoke(GetAssetEndpointProfileInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAssetEndpointProfileResult> getAssetEndpointProfile(GetAssetEndpointProfileArgs args, InvokeOptions options)
public static Output<GetAssetEndpointProfileResult> getAssetEndpointProfile(GetAssetEndpointProfileArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:deviceregistry:getAssetEndpointProfile
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AssetEndpointProfileName string
    Asset Endpoint Profile name parameter.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AssetEndpointProfileName string
    Asset Endpoint Profile name parameter.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    assetEndpointProfileName String
    Asset Endpoint Profile name parameter.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    assetEndpointProfileName string
    Asset Endpoint Profile name parameter.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    asset_endpoint_profile_name str
    Asset Endpoint Profile name parameter.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    assetEndpointProfileName String
    Asset Endpoint Profile name parameter.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getAssetEndpointProfile Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    EndpointProfileType string
    Defines the configuration for the connector type that is being used with the endpoint profile.
    ExtendedLocation Pulumi.AzureNative.DeviceRegistry.Outputs.ExtendedLocationResponse
    The extended location.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the resource.
    Status Pulumi.AzureNative.DeviceRegistry.Outputs.AssetEndpointProfileStatusResponse
    Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
    SystemData Pulumi.AzureNative.DeviceRegistry.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    TargetAddress string
    The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Uuid string
    Globally unique, immutable, non-reusable id.
    AdditionalConfiguration string
    Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
    Authentication Pulumi.AzureNative.DeviceRegistry.Outputs.AuthenticationResponse
    Defines the client authentication mechanism to the server.
    DiscoveredAssetEndpointProfileRef string
    Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    EndpointProfileType string
    Defines the configuration for the connector type that is being used with the endpoint profile.
    ExtendedLocation ExtendedLocationResponse
    The extended location.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the resource.
    Status AssetEndpointProfileStatusResponse
    Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    TargetAddress string
    The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Uuid string
    Globally unique, immutable, non-reusable id.
    AdditionalConfiguration string
    Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
    Authentication AuthenticationResponse
    Defines the client authentication mechanism to the server.
    DiscoveredAssetEndpointProfileRef string
    Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    endpointProfileType String
    Defines the configuration for the connector type that is being used with the endpoint profile.
    extendedLocation ExtendedLocationResponse
    The extended location.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the resource.
    status AssetEndpointProfileStatusResponse
    Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    targetAddress String
    The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    uuid String
    Globally unique, immutable, non-reusable id.
    additionalConfiguration String
    Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
    authentication AuthenticationResponse
    Defines the client authentication mechanism to the server.
    discoveredAssetEndpointProfileRef String
    Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    endpointProfileType string
    Defines the configuration for the connector type that is being used with the endpoint profile.
    extendedLocation ExtendedLocationResponse
    The extended location.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    Provisioning state of the resource.
    status AssetEndpointProfileStatusResponse
    Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    targetAddress string
    The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    uuid string
    Globally unique, immutable, non-reusable id.
    additionalConfiguration string
    Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
    authentication AuthenticationResponse
    Defines the client authentication mechanism to the server.
    discoveredAssetEndpointProfileRef string
    Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    endpoint_profile_type str
    Defines the configuration for the connector type that is being used with the endpoint profile.
    extended_location ExtendedLocationResponse
    The extended location.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    Provisioning state of the resource.
    status AssetEndpointProfileStatusResponse
    Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    target_address str
    The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    uuid str
    Globally unique, immutable, non-reusable id.
    additional_configuration str
    Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
    authentication AuthenticationResponse
    Defines the client authentication mechanism to the server.
    discovered_asset_endpoint_profile_ref str
    Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    endpointProfileType String
    Defines the configuration for the connector type that is being used with the endpoint profile.
    extendedLocation Property Map
    The extended location.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the resource.
    status Property Map
    Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    targetAddress String
    The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    uuid String
    Globally unique, immutable, non-reusable id.
    additionalConfiguration String
    Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
    authentication Property Map
    Defines the client authentication mechanism to the server.
    discoveredAssetEndpointProfileRef String
    Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided.
    tags Map<String>
    Resource tags.

    Supporting Types

    AssetEndpointProfileStatusErrorResponse

    Code int
    Error code for classification of errors (ex: 400, 404, 500, etc.).
    Message string
    Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”).
    Code int
    Error code for classification of errors (ex: 400, 404, 500, etc.).
    Message string
    Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”).
    code Integer
    Error code for classification of errors (ex: 400, 404, 500, etc.).
    message String
    Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”).
    code number
    Error code for classification of errors (ex: 400, 404, 500, etc.).
    message string
    Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”).
    code int
    Error code for classification of errors (ex: 400, 404, 500, etc.).
    message str
    Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”).
    code Number
    Error code for classification of errors (ex: 400, 404, 500, etc.).
    message String
    Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”).

    AssetEndpointProfileStatusResponse

    Errors List<Pulumi.AzureNative.DeviceRegistry.Inputs.AssetEndpointProfileStatusErrorResponse>
    Array object to transfer and persist errors that originate from the Edge.
    Errors []AssetEndpointProfileStatusErrorResponse
    Array object to transfer and persist errors that originate from the Edge.
    errors List<AssetEndpointProfileStatusErrorResponse>
    Array object to transfer and persist errors that originate from the Edge.
    errors AssetEndpointProfileStatusErrorResponse[]
    Array object to transfer and persist errors that originate from the Edge.
    errors Sequence[AssetEndpointProfileStatusErrorResponse]
    Array object to transfer and persist errors that originate from the Edge.
    errors List<Property Map>
    Array object to transfer and persist errors that originate from the Edge.

    AuthenticationResponse

    Method string
    Defines the method to authenticate the user of the client at the server.
    UsernamePasswordCredentials Pulumi.AzureNative.DeviceRegistry.Inputs.UsernamePasswordCredentialsResponse
    Defines the username and password references when UsernamePassword user authentication mode is selected.
    X509Credentials Pulumi.AzureNative.DeviceRegistry.Inputs.X509CredentialsResponse
    Defines the certificate reference when Certificate user authentication mode is selected.
    Method string
    Defines the method to authenticate the user of the client at the server.
    UsernamePasswordCredentials UsernamePasswordCredentialsResponse
    Defines the username and password references when UsernamePassword user authentication mode is selected.
    X509Credentials X509CredentialsResponse
    Defines the certificate reference when Certificate user authentication mode is selected.
    method String
    Defines the method to authenticate the user of the client at the server.
    usernamePasswordCredentials UsernamePasswordCredentialsResponse
    Defines the username and password references when UsernamePassword user authentication mode is selected.
    x509Credentials X509CredentialsResponse
    Defines the certificate reference when Certificate user authentication mode is selected.
    method string
    Defines the method to authenticate the user of the client at the server.
    usernamePasswordCredentials UsernamePasswordCredentialsResponse
    Defines the username and password references when UsernamePassword user authentication mode is selected.
    x509Credentials X509CredentialsResponse
    Defines the certificate reference when Certificate user authentication mode is selected.
    method str
    Defines the method to authenticate the user of the client at the server.
    username_password_credentials UsernamePasswordCredentialsResponse
    Defines the username and password references when UsernamePassword user authentication mode is selected.
    x509_credentials X509CredentialsResponse
    Defines the certificate reference when Certificate user authentication mode is selected.
    method String
    Defines the method to authenticate the user of the client at the server.
    usernamePasswordCredentials Property Map
    Defines the username and password references when UsernamePassword user authentication mode is selected.
    x509Credentials Property Map
    Defines the certificate reference when Certificate user authentication mode is selected.

    ExtendedLocationResponse

    Name string
    The extended location name.
    Type string
    The extended location type.
    Name string
    The extended location name.
    Type string
    The extended location type.
    name String
    The extended location name.
    type String
    The extended location type.
    name string
    The extended location name.
    type string
    The extended location type.
    name str
    The extended location name.
    type str
    The extended location type.
    name String
    The extended location name.
    type String
    The extended location type.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    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
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    UsernamePasswordCredentialsResponse

    PasswordSecretName string
    The name of the secret containing the password.
    UsernameSecretName string
    The name of the secret containing the username.
    PasswordSecretName string
    The name of the secret containing the password.
    UsernameSecretName string
    The name of the secret containing the username.
    passwordSecretName String
    The name of the secret containing the password.
    usernameSecretName String
    The name of the secret containing the username.
    passwordSecretName string
    The name of the secret containing the password.
    usernameSecretName string
    The name of the secret containing the username.
    password_secret_name str
    The name of the secret containing the password.
    username_secret_name str
    The name of the secret containing the username.
    passwordSecretName String
    The name of the secret containing the password.
    usernameSecretName String
    The name of the secret containing the username.

    X509CredentialsResponse

    CertificateSecretName string
    The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
    CertificateSecretName string
    The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
    certificateSecretName String
    The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
    certificateSecretName string
    The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
    certificate_secret_name str
    The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
    certificateSecretName String
    The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native