@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.34 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Asset Endpoint Profile definition.
*
* Uses Azure REST API version 2024-11-01. In version 2.x of the Azure Native provider, it used API version 2023-11-01-preview.
*
* 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class AssetEndpointProfile extends pulumi.CustomResource {
/**
* Get an existing AssetEndpointProfile resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): AssetEndpointProfile;
/**
* Returns true if the given object is an instance of AssetEndpointProfile. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AssetEndpointProfile;
/**
* Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
*/
readonly additionalConfiguration: pulumi.Output<string | undefined>;
/**
* Defines the client authentication mechanism to the server.
*/
readonly authentication: pulumi.Output<outputs.deviceregistry.AuthenticationResponse | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<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.
*/
readonly discoveredAssetEndpointProfileRef: pulumi.Output<string | undefined>;
/**
* Defines the configuration for the connector type that is being used with the endpoint profile.
*/
readonly endpointProfileType: pulumi.Output<string>;
/**
* The extended location.
*/
readonly extendedLocation: pulumi.Output<outputs.deviceregistry.ExtendedLocationResponse>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Provisioning state of the resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
*/
readonly status: pulumi.Output<outputs.deviceregistry.AssetEndpointProfileStatusResponse>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.deviceregistry.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* 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.
*/
readonly targetAddress: pulumi.Output<string>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Globally unique, immutable, non-reusable id.
*/
readonly uuid: pulumi.Output<string>;
/**
* Create a AssetEndpointProfile resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: AssetEndpointProfileArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a AssetEndpointProfile resource.
*/
export interface AssetEndpointProfileArgs {
/**
* Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
*/
additionalConfiguration?: pulumi.Input<string>;
/**
* Asset Endpoint Profile name parameter.
*/
assetEndpointProfileName?: pulumi.Input<string>;
/**
* Defines the client authentication mechanism to the server.
*/
authentication?: pulumi.Input<inputs.deviceregistry.AuthenticationArgs>;
/**
* 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.
*/
discoveredAssetEndpointProfileRef?: pulumi.Input<string>;
/**
* Defines the configuration for the connector type that is being used with the endpoint profile.
*/
endpointProfileType: pulumi.Input<string>;
/**
* The extended location.
*/
extendedLocation: pulumi.Input<inputs.deviceregistry.ExtendedLocationArgs>;
/**
* The geo-location where the resource lives
*/
location?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<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.
*/
targetAddress: pulumi.Input<string>;
}