azure-native.deviceregistry.getAssetEndpointProfile
Explore with Pulumi AI
Get a AssetEndpointProfile
Uses Azure REST API version 2024-11-01.
Other available API versions: 2023-11-01-preview, 2024-09-01-preview, 2025-07-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:
- Asset
Endpoint stringProfile Name - Asset Endpoint Profile name parameter.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Asset
Endpoint stringProfile Name - Asset Endpoint Profile name parameter.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- asset
Endpoint StringProfile Name - Asset Endpoint Profile name parameter.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- asset
Endpoint stringProfile Name - Asset Endpoint Profile name parameter.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- asset_
endpoint_ strprofile_ name - Asset Endpoint Profile name parameter.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- asset
Endpoint StringProfile Name - Asset Endpoint Profile name parameter.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getAssetEndpointProfile Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Endpoint
Profile stringType - Defines the configuration for the connector type that is being used with the endpoint profile.
- Extended
Location Pulumi.Azure Native. Device Registry. Outputs. Extended Location Response - 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
- Provisioning
State string - Provisioning state of the resource.
- Status
Pulumi.
Azure Native. Device Registry. Outputs. Asset Endpoint Profile Status Response - Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
- System
Data Pulumi.Azure Native. Device Registry. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Target
Address 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.
- Additional
Configuration string - Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
- Authentication
Pulumi.
Azure Native. Device Registry. Outputs. Authentication Response - Defines the client authentication mechanism to the server.
- Discovered
Asset stringEndpoint Profile Ref - 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.
- Dictionary<string, string>
- Resource tags.
- Azure
Api stringVersion - The Azure API version of the resource.
- Endpoint
Profile stringType - Defines the configuration for the connector type that is being used with the endpoint profile.
- Extended
Location ExtendedLocation Response - 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
- Provisioning
State string - Provisioning state of the resource.
- Status
Asset
Endpoint Profile Status Response - Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Target
Address 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.
- Additional
Configuration string - Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
- Authentication
Authentication
Response - Defines the client authentication mechanism to the server.
- Discovered
Asset stringEndpoint Profile Ref - 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.
- map[string]string
- Resource tags.
- azure
Api StringVersion - The Azure API version of the resource.
- endpoint
Profile StringType - Defines the configuration for the connector type that is being used with the endpoint profile.
- extended
Location ExtendedLocation Response - 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
- provisioning
State String - Provisioning state of the resource.
- status
Asset
Endpoint Profile Status Response - Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- target
Address 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.
- additional
Configuration String - Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
- authentication
Authentication
Response - Defines the client authentication mechanism to the server.
- discovered
Asset StringEndpoint Profile Ref - 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.
- Map<String,String>
- Resource tags.
- azure
Api stringVersion - The Azure API version of the resource.
- endpoint
Profile stringType - Defines the configuration for the connector type that is being used with the endpoint profile.
- extended
Location ExtendedLocation Response - 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
- provisioning
State string - Provisioning state of the resource.
- status
Asset
Endpoint Profile Status Response - Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- target
Address 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.
- additional
Configuration string - Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
- authentication
Authentication
Response - Defines the client authentication mechanism to the server.
- discovered
Asset stringEndpoint Profile Ref - 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.
- {[key: string]: string}
- Resource tags.
- azure_
api_ strversion - The Azure API version of the resource.
- endpoint_
profile_ strtype - Defines the configuration for the connector type that is being used with the endpoint profile.
- extended_
location ExtendedLocation Response - 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
Asset
Endpoint Profile Status Response - Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
- system_
data SystemData Response - 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
Authentication
Response - Defines the client authentication mechanism to the server.
- discovered_
asset_ strendpoint_ profile_ ref - 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.
- Mapping[str, str]
- Resource tags.
- azure
Api StringVersion - The Azure API version of the resource.
- endpoint
Profile StringType - Defines the configuration for the connector type that is being used with the endpoint profile.
- extended
Location 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
- provisioning
State 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.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- target
Address 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.
- additional
Configuration 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.
- discovered
Asset StringEndpoint Profile Ref - 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.
- Map<String>
- Resource tags.
Supporting Types
AssetEndpointProfileStatusErrorResponse
AssetEndpointProfileStatusResponse
- Errors
List<Pulumi.
Azure Native. Device Registry. Inputs. Asset Endpoint Profile Status Error Response> - Array object to transfer and persist errors that originate from the Edge.
- Errors
[]Asset
Endpoint Profile Status Error Response - Array object to transfer and persist errors that originate from the Edge.
- errors
List<Asset
Endpoint Profile Status Error Response> - Array object to transfer and persist errors that originate from the Edge.
- errors
Asset
Endpoint Profile Status Error Response[] - Array object to transfer and persist errors that originate from the Edge.
- errors
Sequence[Asset
Endpoint Profile Status Error Response] - 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.
- Username
Password Pulumi.Credentials Azure Native. Device Registry. Inputs. Username Password Credentials Response - Defines the username and password references when UsernamePassword user authentication mode is selected.
- X509Credentials
Pulumi.
Azure Native. Device Registry. Inputs. X509Credentials Response - 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.
- Username
Password UsernameCredentials Password Credentials Response - Defines the username and password references when UsernamePassword user authentication mode is selected.
- X509Credentials
X509Credentials
Response - 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.
- username
Password UsernameCredentials Password Credentials Response - Defines the username and password references when UsernamePassword user authentication mode is selected.
- x509Credentials
X509Credentials
Response - 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.
- username
Password UsernameCredentials Password Credentials Response - Defines the username and password references when UsernamePassword user authentication mode is selected.
- x509Credentials
X509Credentials
Response - 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_ Usernamecredentials Password Credentials Response - 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.
- username
Password Property MapCredentials - 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
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
UsernamePasswordCredentialsResponse
- Password
Secret stringName - The name of the secret containing the password.
- Username
Secret stringName - The name of the secret containing the username.
- Password
Secret stringName - The name of the secret containing the password.
- Username
Secret stringName - The name of the secret containing the username.
- password
Secret StringName - The name of the secret containing the password.
- username
Secret StringName - The name of the secret containing the username.
- password
Secret stringName - The name of the secret containing the password.
- username
Secret stringName - The name of the secret containing the username.
- password_
secret_ strname - The name of the secret containing the password.
- username_
secret_ strname - The name of the secret containing the username.
- password
Secret StringName - The name of the secret containing the password.
- username
Secret StringName - The name of the secret containing the username.
X509CredentialsResponse
- Certificate
Secret stringName - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- Certificate
Secret stringName - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- certificate
Secret StringName - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- certificate
Secret stringName - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- certificate_
secret_ strname - The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
- certificate
Secret StringName - 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