1. Packages
  2. Azure Native
  3. API Docs
  4. deviceregistry
  5. getAssetEndpointProfile
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.38.0 published on Monday, Apr 22, 2024 by Pulumi

azure-native.deviceregistry.getAssetEndpointProfile

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.38.0 published on Monday, Apr 22, 2024 by Pulumi

    Get a AssetEndpointProfile Azure REST API version: 2023-11-01-preview.

    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)
    // Output-based functions aren't available in Java yet
    
    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:

    ExtendedLocation Pulumi.AzureNative.DeviceRegistry.Outputs.ExtendedLocationResponse
    The extended location.
    Id string
    Fully qualified resource ID for the resource. Ex - /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.
    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
    Contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
    Tags Dictionary<string, string>
    Resource tags.
    TransportAuthentication Pulumi.AzureNative.DeviceRegistry.Outputs.TransportAuthenticationResponse
    Defines the authentication mechanism for the southbound connector connecting to the shop floor/OT device.
    UserAuthentication Pulumi.AzureNative.DeviceRegistry.Outputs.UserAuthenticationResponse
    Defines the client authentication mechanism to the server.
    ExtendedLocation ExtendedLocationResponse
    The extended location.
    Id string
    Fully qualified resource ID for the resource. Ex - /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.
    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
    Contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
    Tags map[string]string
    Resource tags.
    TransportAuthentication TransportAuthenticationResponse
    Defines the authentication mechanism for the southbound connector connecting to the shop floor/OT device.
    UserAuthentication UserAuthenticationResponse
    Defines the client authentication mechanism to the server.
    extendedLocation ExtendedLocationResponse
    The extended location.
    id String
    Fully qualified resource ID for the resource. Ex - /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.
    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
    Contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
    tags Map<String,String>
    Resource tags.
    transportAuthentication TransportAuthenticationResponse
    Defines the authentication mechanism for the southbound connector connecting to the shop floor/OT device.
    userAuthentication UserAuthenticationResponse
    Defines the client authentication mechanism to the server.
    extendedLocation ExtendedLocationResponse
    The extended location.
    id string
    Fully qualified resource ID for the resource. Ex - /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.
    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
    Contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
    tags {[key: string]: string}
    Resource tags.
    transportAuthentication TransportAuthenticationResponse
    Defines the authentication mechanism for the southbound connector connecting to the shop floor/OT device.
    userAuthentication UserAuthenticationResponse
    Defines the client authentication mechanism to the server.
    extended_location ExtendedLocationResponse
    The extended location.
    id str
    Fully qualified resource ID for the resource. Ex - /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.
    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
    Contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
    tags Mapping[str, str]
    Resource tags.
    transport_authentication TransportAuthenticationResponse
    Defines the authentication mechanism for the southbound connector connecting to the shop floor/OT device.
    user_authentication UserAuthenticationResponse
    Defines the client authentication mechanism to the server.
    extendedLocation Property Map
    The extended location.
    id String
    Fully qualified resource ID for the resource. Ex - /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.
    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
    Contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
    tags Map<String>
    Resource tags.
    transportAuthentication Property Map
    Defines the authentication mechanism for the southbound connector connecting to the shop floor/OT device.
    userAuthentication Property Map
    Defines the client authentication mechanism to the server.

    Supporting Types

    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.

    OwnCertificateResponse

    CertPasswordReference string
    Secret Reference Name (Pfx or Pem password).
    CertSecretReference string
    Secret Reference name (cert and private key).
    CertThumbprint string
    Certificate thumbprint.
    CertPasswordReference string
    Secret Reference Name (Pfx or Pem password).
    CertSecretReference string
    Secret Reference name (cert and private key).
    CertThumbprint string
    Certificate thumbprint.
    certPasswordReference String
    Secret Reference Name (Pfx or Pem password).
    certSecretReference String
    Secret Reference name (cert and private key).
    certThumbprint String
    Certificate thumbprint.
    certPasswordReference string
    Secret Reference Name (Pfx or Pem password).
    certSecretReference string
    Secret Reference name (cert and private key).
    certThumbprint string
    Certificate thumbprint.
    cert_password_reference str
    Secret Reference Name (Pfx or Pem password).
    cert_secret_reference str
    Secret Reference name (cert and private key).
    cert_thumbprint str
    Certificate thumbprint.
    certPasswordReference String
    Secret Reference Name (Pfx or Pem password).
    certSecretReference String
    Secret Reference name (cert and private key).
    certThumbprint String
    Certificate thumbprint.

    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.

    TransportAuthenticationResponse

    OwnCertificates List<Pulumi.AzureNative.DeviceRegistry.Inputs.OwnCertificateResponse>
    Defines a reference to a secret which contains all certificates and private keys that can be used by the southbound connector connecting to the shop floor/OT device. The accepted extensions are .der for certificates and .pfx/.pem for private keys.
    OwnCertificates []OwnCertificateResponse
    Defines a reference to a secret which contains all certificates and private keys that can be used by the southbound connector connecting to the shop floor/OT device. The accepted extensions are .der for certificates and .pfx/.pem for private keys.
    ownCertificates List<OwnCertificateResponse>
    Defines a reference to a secret which contains all certificates and private keys that can be used by the southbound connector connecting to the shop floor/OT device. The accepted extensions are .der for certificates and .pfx/.pem for private keys.
    ownCertificates OwnCertificateResponse[]
    Defines a reference to a secret which contains all certificates and private keys that can be used by the southbound connector connecting to the shop floor/OT device. The accepted extensions are .der for certificates and .pfx/.pem for private keys.
    own_certificates Sequence[OwnCertificateResponse]
    Defines a reference to a secret which contains all certificates and private keys that can be used by the southbound connector connecting to the shop floor/OT device. The accepted extensions are .der for certificates and .pfx/.pem for private keys.
    ownCertificates List<Property Map>
    Defines a reference to a secret which contains all certificates and private keys that can be used by the southbound connector connecting to the shop floor/OT device. The accepted extensions are .der for certificates and .pfx/.pem for private keys.

    UserAuthenticationResponse

    Mode string
    Defines the mode 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.
    Mode string
    Defines the mode 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.
    mode String
    Defines the mode 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.
    mode string
    Defines the mode 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.
    mode str
    Defines the mode 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.
    mode String
    Defines the mode 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.

    UsernamePasswordCredentialsResponse

    PasswordReference string
    A reference to secret containing the password.
    UsernameReference string
    A reference to secret containing the username.
    PasswordReference string
    A reference to secret containing the password.
    UsernameReference string
    A reference to secret containing the username.
    passwordReference String
    A reference to secret containing the password.
    usernameReference String
    A reference to secret containing the username.
    passwordReference string
    A reference to secret containing the password.
    usernameReference string
    A reference to secret containing the username.
    password_reference str
    A reference to secret containing the password.
    username_reference str
    A reference to secret containing the username.
    passwordReference String
    A reference to secret containing the password.
    usernameReference String
    A reference to secret containing the username.

    X509CredentialsResponse

    CertificateReference string
    A reference to secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
    CertificateReference string
    A reference to secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
    certificateReference String
    A reference to secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
    certificateReference string
    A reference to secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
    certificate_reference str
    A reference to secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
    certificateReference String
    A reference to 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 v1 docs if using the v1 version of this package.
    Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi